Class SeatersApiContext

Hierarchy

ApiContext
- SeatersApiContext

Index

Constructors

constructor

Properties

requestDriver

Constructors

constructor

new SeatersApiContext(prefix: string, requestDriver: RequestDriver): SeatersApiContext

Overrides ApiContext.constructor
- Defined in seaters-api/seaters-api-context.ts:60
Parameters
- prefix: string
- requestDriver: RequestDriver
Returns SeatersApiContext

Properties

requestDriver

requestDriver: RequestDriver

Methods

createEndpoint

createEndpoint(requestDefinition: ApiRequestDefinition): ApiEndpoint

Inherited from ApiContext.createEndpoint
- Defined in api/api-context.ts:32
Parameters
- requestDefinition: ApiRequestDefinition
Returns ApiEndpoint

createRequestOptions

createRequestOptions(requestDefinition: ApiRequestDefinition, endpoint: ApiEndpoint): RequestOptions

Inherited from ApiContext.createRequestOptions
- Defined in api/api-context.ts:41
Parameters
- requestDefinition: ApiRequestDefinition
- endpoint: ApiEndpoint
Returns RequestOptions

Private createServerError

createServerError(response: ServerResponse, message: string): ServerError

- Defined in seaters-api/seaters-api-context.ts:208
Parameters
- response: ServerResponse
- message: string
Returns ServerError

Private dataFromLegacyResponse

dataFromLegacyResponse(response: ServerResponse): Promise<SeatersExceptionV1>

- Defined in seaters-api/seaters-api-context.ts:159
Parameters
- response: ServerResponse
Returns Promise<SeatersExceptionV1>

delete

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

- Defined in seaters-api/seaters-api-context.ts:113
Parameters
- abstractEndpoint: string
- Optional endpointParams: StringMap
- Optional queryParams: ArrayMap
Returns Promise<any>

doRequest

doRequest(requestDefinition: ApiRequestDefinition): Promise<ServerResponse>

Inherited from ApiContext.doRequest
- Defined in api/api-context.ts:61
Parameters
- requestDefinition: ApiRequestDefinition
Returns Promise<ServerResponse>

doSeatersRequest

doSeatersRequest(requestDefinition: ApiRequestDefinition): Promise<string>

- Defined in seaters-api/seaters-api-context.ts:74
Returns a promise that either resolves with the requested resource or rejects on error with a SeatersApiException.

see

SeatersApiException

Parameters
- requestDefinition: ApiRequestDefinition
  
  Definition of which resource is requested
Returns Promise<string>

doTypedSeatersRequest

doTypedSeatersRequest<T>(requestDefinition: ApiRequestDefinition): Promise<T>

- Defined in seaters-api/seaters-api-context.ts:81
Type parameters
- T
Parameters
- requestDefinition: ApiRequestDefinition
Returns Promise<T>

get

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

- Defined in seaters-api/seaters-api-context.ts:85
Parameters
- abstractEndpoint: string
- Optional endpointParams: StringMap
- Optional queryParams: ArrayMap
Returns Promise<any>

Private handle2XXResponse

handle2XXResponse(response: ServerResponse): Promise<string>

- Defined in seaters-api/seaters-api-context.ts:155
Parameters
- response: ServerResponse
Returns Promise<string>

Private handle400Response

handle400Response(response: ServerResponse): Promise<any>

- Defined in seaters-api/seaters-api-context.ts:191
(legacy) old endpoints return 400 with only a message string This type of error is mapped to a proper SeatersApiException

Parameters
- response: ServerResponse
Returns Promise<any>

Private handle401Response

handle401Response(response: ServerResponse): Promise<any>

- Defined in seaters-api/seaters-api-context.ts:217
Parameters
- response: ServerResponse
Returns Promise<any>

Private handle404Response

handle404Response(response: ServerResponse): Promise<any>

- Defined in seaters-api/seaters-api-context.ts:228
Parameters
- response: ServerResponse
Returns Promise<any>

Private handle422Response

handle422Response(response: ServerResponse): Promise<any>

- Defined in seaters-api/seaters-api-context.ts:239
Parameters
- response: ServerResponse
Returns Promise<any>

Private handleClientError

handleClientError<T>(error: any): Promise<string>

- Defined in seaters-api/seaters-api-context.ts:254
Type parameters
- T
Parameters
- error: any
Returns Promise<string>

Private handleServerResponse

handleServerResponse(response: ServerResponse): Promise<string>

- Defined in seaters-api/seaters-api-context.ts:135
Parameters
- response: ServerResponse
Returns Promise<string>

Private handleUnexpectedResponse

handleUnexpectedResponse(response: ServerResponse): Promise<any>

- Defined in seaters-api/seaters-api-context.ts:245
Parameters
- response: ServerResponse
Returns Promise<any>

Private parseResult

parseResult(body: string): any

- Defined in seaters-api/seaters-api-context.ts:263
Parameters
- body: string
Returns any

post

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

- Defined in seaters-api/seaters-api-context.ts:103
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>

- Defined in seaters-api/seaters-api-context.ts:93
Parameters
- abstractEndpoint: string
- Optional body: any
- Optional endpointParams: StringMap
- Optional queryParams: ArrayMap
Returns Promise<any>

setHeader

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

Inherited from ApiContext.setHeader
- Defined in api/api-context.ts:24
Parameters
- header: string
- value: string
Returns void

unsetHeader

unsetHeader(header: string): void

Inherited from ApiContext.unsetHeader
- Defined in api/api-context.ts:28
Parameters
- header: string
Returns void

uploadOneTimeFile

uploadOneTimeFile(oneTimeFileUrl: string, data: any): Promise<any>

- Defined in seaters-api/seaters-api-context.ts:127
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

buildPagingQueryParams(pagingOptions: PagingOptions): object

- Defined in seaters-api/seaters-api-context.ts:11
Parameters
- pagingOptions: PagingOptions
Returns object
- [key: string]: any

Static buildPagingSortingQueryParams

buildPagingSortingQueryParams(pagingOptions: PagingOptions): object

- Defined in seaters-api/seaters-api-context.ts:30
Parameters
- pagingOptions: PagingOptions
Returns object
- [key: string]: any

Static convertPagedResultToArray

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

- Defined in seaters-api/seaters-api-context.ts:49
Parameters
- promise: Promise<PagedResult<any>>
Returns Promise<any[]>

Generated using TypeDoc