API

23 min

ODP Node SDKODP Node SDK

ODP Node SDKODP Node SDK / ODPODP / ApiV3ApiV3 / API

Class: API

Defined in: src/Api/lib/ApiV3.ts:95

Constructors

Constructor

new API(config): API

Defined in: src/Api/lib/ApiV3.ts:113

Parameters

config

null | Config | InternalConfig

Returns

API

Methods

errorForCode()

errorForCode(code): `HttpError`HttpError

Defined in: src/Api/lib/ApiV3.ts:119

Parameters

code

`ErrorCode`ErrorCode

Returns

`HttpError`HttpError

get()

get<T>(path): Promise<`HttpResponse`HttpResponse<T>>

Defined in: src/Api/lib/ApiV3.ts:121

Type Parameters

T

T extends `V3Response`V3Response

Parameters

path

string

Returns

Promise<`HttpResponse`HttpResponse<T>>

getContext()

getContext(): undefined | AppContext

Defined in: src/Api/lib/ApiV3.ts:225

Returns

undefined | AppContext

post()

post<T>(path, payload): Promise<`HttpResponse`HttpResponse<T>>

Defined in: src/Api/lib/ApiV3.ts:123

Type Parameters

T

T extends `V3Response`V3Response

Parameters

path

string

payload

`Payload`Payload

Returns

Promise<`HttpResponse`HttpResponse<T>>

request()

request<T>(method, path, payload, options): Promise<`HttpResponse`HttpResponse<T>>

Defined in: src/Api/lib/ApiV3.ts:125

Type Parameters

T

T extends `V3Response`V3Response

Parameters

method

`HttpMethod`HttpMethod

path

string

payload

undefined | `Payload`Payload

options

`RequestOptions`RequestOptions = ...

Returns

Promise<`HttpResponse`HttpResponse<T>>