Class DataApiClient<SecurityDataType>

Type Parameters

SecurityDataType extends unknown

Hierarchy (View Summary)

HttpClient<SecurityDataType>
- DataApiClient

Index

Constructors

constructor

new DataApiClient<SecurityDataType extends unknown>(
apiConfig?: ApiConfig<SecurityDataType>,
): DataApiClient<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- apiConfig: ApiConfig<SecurityDataType> = {}
Returns DataApiClient<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in packages/data-api-client/src/dataapi.ts:403

Properties

baseParams

baseParams: {
    baseParams: (
        params?: RequestParams,
    ) => Promise<HttpResponse<BaseParamEndpointResponse, any>>;
} = ...

Type Declaration

baseParams: (
params?: RequestParams,
) => Promise<HttpResponse<BaseParamEndpointResponse, any>>
No description

Name
BaseParams

Request
GET:/BaseParams

baseUrl

baseUrl: string = ""

food

food: {
    foodItems: (
        params?: RequestParams,
    ) => Promise<HttpResponse<FoodEndpointResponse, any>>;
} = ...

Type Declaration

foodItems: (params?: RequestParams) => Promise<HttpResponse<FoodEndpointResponse, any>>
No description

Name
FoodItems

Request
GET:/Food

healthz

healthz: {
    healthCheck: (
        params?: RequestParams,
    ) => Promise<HttpResponse<string, any>>;
} = ...

Type Declaration

healthCheck: (params?: RequestParams) => Promise<HttpResponse<string, any>>
No description

Name
HealthCheck

Request
GET:/healthz

itemLevel

itemLevel: {
    itemLevels: (
        params?: RequestParams,
    ) => Promise<HttpResponse<ItemLevelEndpointResponse, any>>;
} = ...

Type Declaration

itemLevels: (
params?: RequestParams,
) => Promise<HttpResponse<ItemLevelEndpointResponse, any>>
No description

Name
ItemLevels

Request
GET:/ItemLevel

items

items: {
    items: (
        query: { job: string[] },
        params?: RequestParams,
    ) => Promise<HttpResponse<ItemsEndpointResponse, any>>;
} = ...

Type Declaration

items: (
query: { job: string[] },
params?: RequestParams,
) => Promise<HttpResponse<ItemsEndpointResponse, any>>
No description

Name
Items

Request
GET:/Items

jobs

jobs: {
    jobs: (
        params?: RequestParams,
    ) => Promise<HttpResponse<JobEndpointResponse, any>>;
} = ...

Type Declaration

jobs: (params?: RequestParams) => Promise<HttpResponse<JobEndpointResponse, any>>
No description

Name
Jobs

Request
GET:/Jobs

materia

materia: {
    materia: (
        params?: RequestParams,
    ) => Promise<HttpResponse<MateriaEndpointResponse, any>>;
} = ...

Type Declaration

materia: (params?: RequestParams) => Promise<HttpResponse<MateriaEndpointResponse, any>>
No description

Name
Materia

Request
GET:/Materia

readyz

readyz: {
    readyCheck: (
        params?: RequestParams,
    ) => Promise<HttpResponse<string, any>>;
} = ...

Type Declaration

readyCheck: (params?: RequestParams) => Promise<HttpResponse<string, any>>
No description

Name
ReadyCheck

Request
GET:/readyz

schemaVersion

schemaVersion: {
    versions: (
        params?: RequestParams,
    ) => Promise<HttpResponse<SchemaVersionEndpointResponse, any>>;
} = ...

Type Declaration

versions: (
params?: RequestParams,
) => Promise<HttpResponse<SchemaVersionEndpointResponse, any>>
No description

Name
Versions

Request
GET:/SchemaVersion

versions

versions: {
    versions1: (
        params?: RequestParams,
    ) => Promise<HttpResponse<VersionsEndpointResponse, any>>;
    versions2: (
        params?: RequestParams,
    ) => Promise<HttpResponse<VersionsFullEndpointResponse, any>>;
} = ...

Type Declaration

versions1: (params?: RequestParams) => Promise<HttpResponse<VersionsEndpointResponse, any>>
No description

Name
Versions1

Request
GET:/Versions
versions2: (
params?: RequestParams,
) => Promise<HttpResponse<VersionsFullEndpointResponse, any>>
No description

Name
Versions2

Request
GET:/Versions/Full

Methods

abortRequest

abortRequest(cancelToken: CancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
Inherited from HttpClient.abortRequest
- Defined in packages/data-api-client/src/dataapi.ts:510

`Protected`addArrayQueryParam

addArrayQueryParam(query: QueryParamsType, key: string): any
Parameters
- query: QueryParamsType
- key: string
Returns any
Inherited from HttpClient.addArrayQueryParam
- Defined in packages/data-api-client/src/dataapi.ts:420

`Protected`addQueryParam

addQueryParam(query: QueryParamsType, key: string): string
Parameters
- query: QueryParamsType
- key: string
Returns string
Inherited from HttpClient.addQueryParam
- Defined in packages/data-api-client/src/dataapi.ts:416

`Protected`addQueryParams

addQueryParams(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.addQueryParams
- Defined in packages/data-api-client/src/dataapi.ts:439

`Protected`createAbortSignal

createAbortSignal(cancelToken: CancelToken): AbortSignal | undefined
Parameters
- cancelToken: CancelToken
Returns AbortSignal | undefined
Inherited from HttpClient.createAbortSignal
- Defined in packages/data-api-client/src/dataapi.ts:494

`Protected`encodeQueryParam

encodeQueryParam(key: string, value: any): string
Parameters
- key: string
- value: any
Returns string
Inherited from HttpClient.encodeQueryParam
- Defined in packages/data-api-client/src/dataapi.ts:411

`Protected`mergeRequestParams

mergeRequestParams(
params1: RequestParams,
params2?: RequestParams,
): RequestParams
Parameters
- params1: RequestParams
- Optionalparams2: RequestParams
Returns RequestParams
Inherited from HttpClient.mergeRequestParams
- Defined in packages/data-api-client/src/dataapi.ts:478

request

request<T = any, E = any>(
__namedParameters: FullRequestParams,
): Promise<HttpResponse<T, E>>
Type Parameters
- T = any
- E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<HttpResponse<T, E>>
Inherited from HttpClient.request
- Defined in packages/data-api-client/src/dataapi.ts:519

setSecurityData

setSecurityData(data: SecurityDataType | null): void
Parameters
- data: SecurityDataType | null
Returns void
Inherited from HttpClient.setSecurityData
- Defined in packages/data-api-client/src/dataapi.ts:407

`Protected`toQueryString

toQueryString(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.toQueryString
- Defined in packages/data-api-client/src/dataapi.ts:425

Class DataApiClient<SecurityDataType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DataApiClient<SecurityDataType>

Properties

baseParams

Type Declaration

baseParams: ( params?: RequestParams,) => Promise<HttpResponse<BaseParamEndpointResponse, any>>

Name

Request

baseUrl

food

Type Declaration

foodItems: (params?: RequestParams) => Promise<HttpResponse<FoodEndpointResponse, any>>

Name

Request

healthz

Type Declaration

healthCheck: (params?: RequestParams) => Promise<HttpResponse<string, any>>

Name

Request

itemLevel

Type Declaration

itemLevels: ( params?: RequestParams,) => Promise<HttpResponse<ItemLevelEndpointResponse, any>>

Name

Request

items

Type Declaration

items: ( query: { job: string[] }, params?: RequestParams,) => Promise<HttpResponse<ItemsEndpointResponse, any>>

Name

Request

jobs

Type Declaration

jobs: (params?: RequestParams) => Promise<HttpResponse<JobEndpointResponse, any>>

Name

Request

materia

Type Declaration

materia: (params?: RequestParams) => Promise<HttpResponse<MateriaEndpointResponse, any>>

Name

Request

readyz

Type Declaration

readyCheck: (params?: RequestParams) => Promise<HttpResponse<string, any>>

Name

Request

schemaVersion

Type Declaration

versions: ( params?: RequestParams,) => Promise<HttpResponse<SchemaVersionEndpointResponse, any>>

Name

Request

versions

Type Declaration

versions1: (params?: RequestParams) => Promise<HttpResponse<VersionsEndpointResponse, any>>

Name

Request

versions2: ( params?: RequestParams,) => Promise<HttpResponse<VersionsFullEndpointResponse, any>>

Name

Request

Methods

abortRequest

Parameters

Returns void

ProtectedaddArrayQueryParam

Parameters

Returns any

ProtectedaddQueryParam

Parameters

Returns string

ProtectedaddQueryParams

Parameters

Returns string

baseParams: (
params?: RequestParams,
) => Promise<HttpResponse<BaseParamEndpointResponse, any>>

itemLevels: (
params?: RequestParams,
) => Promise<HttpResponse<ItemLevelEndpointResponse, any>>

items: (
query: { job: string[] },
params?: RequestParams,
) => Promise<HttpResponse<ItemsEndpointResponse, any>>

versions: (
params?: RequestParams,
) => Promise<HttpResponse<SchemaVersionEndpointResponse, any>>

versions2: (
params?: RequestParams,
) => Promise<HttpResponse<VersionsFullEndpointResponse, any>>

`Protected`addArrayQueryParam

`Protected`addQueryParam

`Protected`addQueryParams

`Protected`createAbortSignal

`Protected`encodeQueryParam

`Protected`mergeRequestParams

`Protected`toQueryString