API
ODP Node SDK / ODP / ApiV3 / 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
Defined in: src/Api/lib/ApiV3.ts:119
Parameters
code
Returns
get()
get<
T
>(path
):Promise
<HttpResponse
<T
>>
Defined in: src/Api/lib/ApiV3.ts:121
Type Parameters
T
T
extends V3Response
Parameters
path
string
Returns
Promise
<HttpResponse
<T
>>
getContext()
getContext():
undefined
|AppContext
Defined in: src/Api/lib/ApiV3.ts:225
Returns
undefined
| AppContext
post()
post<
T
>(path
,payload
):Promise
<HttpResponse
<T
>>
Defined in: src/Api/lib/ApiV3.ts:123
Type Parameters
T
T
extends V3Response
Parameters
path
string
payload
Returns
Promise
<HttpResponse
<T
>>
request()
request<
T
>(method
,path
,payload
,options
):Promise
<HttpResponse
<T
>>
Defined in: src/Api/lib/ApiV3.ts:125
Type Parameters
T
T
extends V3Response
Parameters
method
path
string
payload
undefined
| Payload
options
RequestOptions
= ...
Returns
Promise
<HttpResponse
<T
>>
Updated 4 days ago