NodeBigcommerceSDK
The definition of types for BigCommerce SDK.
interface NodeBigcommerceSDK {
config: MiddlewareSDKSettingsConfig;
delete<RESPONSE_TYPE>(path: string): Promise<RESPONSE_TYPE>;
get<RESPONSE_TYPE>(path: string): Promise<RESPONSE_TYPE>;
post<RESPONSE_TYPE, PARAM_TYPE>(path: string, param: PARAM_TYPE): Promise<RESPONSE_TYPE>;
put<RESPONSE_TYPE, PARAM_TYPE>(path: string, param: PARAM_TYPE): Promise<RESPONSE_TYPE>;
request<RESPONSE_TYPE>(type: REQUEST_TYPE, path: string, data: any): Promise<RESPONSE_TYPE>;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
config | Required | MiddlewareSDKSettingsConfig | SDK Settings provided in the middleware.config.js file. |
delete
SDK client HTTP method for making DELETE requests.
Signature
delete<RESPONSE_TYPE>(
path: string
): Promise<RESPONSE_TYPE>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
path | Required | string |
get
SDK client HTTP method for making GET requests.
Signature
get<RESPONSE_TYPE>(
path: string
): Promise<RESPONSE_TYPE>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
path | Required | string |
post
SDK client HTTP method for making POST requests.
Signature
post<RESPONSE_TYPE,
PARAM_TYPE>(
path: string,
param: PARAM_TYPE
): Promise<RESPONSE_TYPE>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
path | Required | string | |
param | Required | PARAM_TYPE |
put
SDK client HTTP method for making PUT requests.
Signature
put<RESPONSE_TYPE,
PARAM_TYPE>(
path: string,
param: PARAM_TYPE
): Promise<RESPONSE_TYPE>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
path | Required | string | |
param | Required | PARAM_TYPE |
request
SDK client factory method for creating HTTP requests.
Signature
request<RESPONSE_TYPE>(
type: REQUEST_TYPE,
path: string,
data: any
): Promise<RESPONSE_TYPE>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
type | Required | REQUEST_TYPE | |
path | Required | string | |
data | Required | any |