Class: ApiClient
Methods
delete
▸ delete<ResponseBodyType, RequestBodyType>(integrationId, endpointId, body?, options?): Promise<HttpResponse<ResponseBodyType>>
Type parameters
| Name | Type |
|---|---|
ResponseBodyType | unknown |
RequestBodyType | unknown |
Parameters
| Name | Type |
|---|---|
integrationId | string |
endpointId | string |
body? | RequestBodyType |
options? | ApiOptions |
Returns
Promise<HttpResponse<ResponseBodyType>>
get
▸ get<ResponseBodyType>(integrationId, endpointId, options?): Promise<HttpResponse<ResponseBodyType>>
Type parameters
| Name | Type |
|---|---|
ResponseBodyType | unknown |
Parameters
| Name | Type |
|---|---|
integrationId | string |
endpointId | string |
options? | ApiOptions |
Returns
Promise<HttpResponse<ResponseBodyType>>
patch
▸ patch<ResponseBodyType, RequestBodyType>(integrationId, endpointId, body?, options?): Promise<HttpResponse<ResponseBodyType>>
Type parameters
| Name | Type |
|---|---|
ResponseBodyType | unknown |
RequestBodyType | unknown |
Parameters
| Name | Type |
|---|---|
integrationId | string |
endpointId | string |
body? | RequestBodyType |
options? | ApiOptions |
Returns
Promise<HttpResponse<ResponseBodyType>>
post
▸ post<ResponseBodyType, RequestBodyType>(integrationId, endpointId, body?, options?): Promise<HttpResponse<ResponseBodyType>>
Type parameters
| Name | Type |
|---|---|
ResponseBodyType | unknown |
RequestBodyType | unknown |
Parameters
| Name | Type |
|---|---|
integrationId | string |
endpointId | string |
body? | RequestBodyType |
options? | ApiOptions |
Returns
Promise<HttpResponse<ResponseBodyType>>
put
▸ put<ResponseBodyType, RequestBodyType>(integrationId, endpointId, body?, options?): Promise<HttpResponse<ResponseBodyType>>
Type parameters
| Name | Type |
|---|---|
ResponseBodyType | unknown |
RequestBodyType | unknown |
Parameters
| Name | Type |
|---|---|
integrationId | string |
endpointId | string |
body? | RequestBodyType |
options? | ApiOptions |
Returns
Promise<HttpResponse<ResponseBodyType>>
request
▸ request<ResponseBodyType, RequestBodyType>(integrationId, endpointId, body?, options?, method?): Promise<HttpResponse<ResponseBodyType>>
Performs an HTTP API request to the given integration ID and endpoint ID. The provided options will be merged with the default options. In case of error (status code >= 400 or other error), the promise will be rejected with an RpcError.
Type parameters
| Name | Type |
|---|---|
ResponseBodyType | unknown |
RequestBodyType | unknown |
Parameters
| Name | Type |
|---|---|
integrationId | string |
endpointId | string |
body? | RequestBodyType |
options? | ApiOptions |
method? | HttpMethod |
Returns
Promise<HttpResponse<ResponseBodyType>>