Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SeatersApiContext

Hierarchy

Index

Constructors

constructor

Properties

requestDriver

requestDriver: RequestDriver

Methods

createEndpoint

createRequestOptions

Private createServerError

Private dataFromLegacyResponse

delete

  • delete(abstractEndpoint: string, endpointParams?: StringMap, queryParams?: ArrayMap): Promise<any>
  • Parameters

    • abstractEndpoint: string
    • Optional endpointParams: StringMap
    • Optional queryParams: ArrayMap

    Returns Promise<any>

doRequest

doSeatersRequest

  • Returns a promise that either resolves with the requested resource or rejects on error with a SeatersApiException.

    see

    SeatersApiException

    Parameters

    Returns Promise<string>

doTypedSeatersRequest

  • Type parameters

    • T

    Parameters

    Returns Promise<T>

get

  • get(abstractEndpoint: string, endpointParams?: StringMap, queryParams?: ArrayMap): Promise<any>
  • Parameters

    • abstractEndpoint: string
    • Optional endpointParams: StringMap
    • Optional queryParams: ArrayMap

    Returns Promise<any>

Private handle2XXResponse

  • Parameters

    Returns Promise<string>

Private handle400Response

  • (legacy) old endpoints return 400 with only a message string This type of error is mapped to a proper SeatersApiException

    Parameters

    Returns Promise<any>

Private handle401Response

  • Parameters

    Returns Promise<any>

Private handle404Response

  • Parameters

    Returns Promise<any>

Private handle422Response

  • Parameters

    Returns Promise<any>

Private handleClientError

  • handleClientError<T>(error: any): Promise<string>
  • Type parameters

    • T

    Parameters

    • error: any

    Returns Promise<string>

Private handleServerResponse

  • Parameters

    Returns Promise<string>

Private handleUnexpectedResponse

  • Parameters

    Returns Promise<any>

Private parseResult

  • parseResult(body: string): any
  • Parameters

    • body: string

    Returns any

post

  • post(abstractEndpoint: string, body?: any, endpointParams?: StringMap, queryParams?: ArrayMap): Promise<any>
  • Parameters

    • abstractEndpoint: string
    • Optional body: any
    • Optional endpointParams: StringMap
    • Optional queryParams: ArrayMap

    Returns Promise<any>

put

  • put(abstractEndpoint: string, body?: any, endpointParams?: StringMap, queryParams?: ArrayMap): Promise<any>
  • Parameters

    • abstractEndpoint: string
    • Optional body: any
    • Optional endpointParams: StringMap
    • Optional queryParams: ArrayMap

    Returns Promise<any>

setHeader

  • setHeader(header: string, value: string): void
  • Parameters

    • header: string
    • value: string

    Returns void

unsetHeader

  • unsetHeader(header: string): void
  • Parameters

    • header: string

    Returns void

uploadOneTimeFile

  • uploadOneTimeFile(oneTimeFileUrl: string, data: any): Promise<any>
  • For browser, we expect HTMLInputElement containing a file

    Parameters

    • oneTimeFileUrl: string

      url of a OneTimeFile returned by requestOneTimeFileUpload

    • data: any

      for browsers: HTMLInputElement, for node: not supported

    Returns Promise<any>

Static buildPagingQueryParams

  • Parameters

    Returns object

    • [key: string]: any

Static buildPagingSortingQueryParams

  • buildPagingSortingQueryParams(pagingOptions: PagingOptions): object
  • Parameters

    Returns object

    • [key: string]: any

Static convertPagedResultToArray

  • convertPagedResultToArray(promise: Promise<PagedResult<any>>): Promise<any[]>
  • Parameters

    Returns Promise<any[]>

Generated using TypeDoc