@sp-api-sdk/shipping-api-v1 1.8.5 → 1.8.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -30,7 +30,7 @@ import { RetrieveShippingLabelResponse } from '../models';
|
|
|
30
30
|
* ShippingApi - axios parameter creator
|
|
31
31
|
* @export
|
|
32
32
|
*/
|
|
33
|
-
export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration
|
|
33
|
+
export declare const ShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34
34
|
/**
|
|
35
35
|
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
36
36
|
* @param {string} shipmentId
|
|
@@ -101,48 +101,48 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
101
101
|
* ShippingApi - functional programming interface
|
|
102
102
|
* @export
|
|
103
103
|
*/
|
|
104
|
-
export declare const ShippingApiFp: (configuration?: Configuration
|
|
104
|
+
export declare const ShippingApiFp: (configuration?: Configuration) => {
|
|
105
105
|
/**
|
|
106
106
|
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
107
107
|
* @param {string} shipmentId
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
109
109
|
* @throws {RequiredError}
|
|
110
110
|
*/
|
|
111
|
-
cancelShipment(shipmentId: string, options?: AxiosRequestConfig
|
|
111
|
+
cancelShipment(shipmentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CancelShipmentResponse>>;
|
|
112
112
|
/**
|
|
113
113
|
* Create a new shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
114
114
|
* @param {CreateShipmentRequest} body
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
116
116
|
* @throws {RequiredError}
|
|
117
117
|
*/
|
|
118
|
-
createShipment(body: CreateShipmentRequest, options?: AxiosRequestConfig
|
|
118
|
+
createShipment(body: CreateShipmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateShipmentResponse>>;
|
|
119
119
|
/**
|
|
120
120
|
* Verify if the current account is valid. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
123
|
*/
|
|
124
|
-
getAccount(options?: AxiosRequestConfig
|
|
124
|
+
getAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponse>>;
|
|
125
125
|
/**
|
|
126
126
|
* Get service rates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
127
127
|
* @param {GetRatesRequest} body
|
|
128
128
|
* @param {*} [options] Override http request option.
|
|
129
129
|
* @throws {RequiredError}
|
|
130
130
|
*/
|
|
131
|
-
getRates(body: GetRatesRequest, options?: AxiosRequestConfig
|
|
131
|
+
getRates(body: GetRatesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRatesResponse>>;
|
|
132
132
|
/**
|
|
133
133
|
* Return the entire shipment object for the shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
134
134
|
* @param {string} shipmentId
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
|
-
getShipment(shipmentId: string, options?: AxiosRequestConfig
|
|
138
|
+
getShipment(shipmentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentResponse>>;
|
|
139
139
|
/**
|
|
140
140
|
* Return the tracking information of a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
141
141
|
* @param {string} trackingId
|
|
142
142
|
* @param {*} [options] Override http request option.
|
|
143
143
|
* @throws {RequiredError}
|
|
144
144
|
*/
|
|
145
|
-
getTrackingInformation(trackingId: string, options?: AxiosRequestConfig
|
|
145
|
+
getTrackingInformation(trackingId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTrackingInformationResponse>>;
|
|
146
146
|
/**
|
|
147
147
|
* Purchase shipping labels based on a given rate. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
148
148
|
* @param {string} shipmentId
|
|
@@ -150,14 +150,14 @@ export declare const ShippingApiFp: (configuration?: Configuration | undefined)
|
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
151
151
|
* @throws {RequiredError}
|
|
152
152
|
*/
|
|
153
|
-
purchaseLabels(shipmentId: string, body: PurchaseLabelsRequest, options?: AxiosRequestConfig
|
|
153
|
+
purchaseLabels(shipmentId: string, body: PurchaseLabelsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchaseLabelsResponse>>;
|
|
154
154
|
/**
|
|
155
155
|
* Purchase shipping labels. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
156
156
|
* @param {PurchaseShipmentRequest} body
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
159
159
|
*/
|
|
160
|
-
purchaseShipment(body: PurchaseShipmentRequest, options?: AxiosRequestConfig
|
|
160
|
+
purchaseShipment(body: PurchaseShipmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchaseShipmentResponse>>;
|
|
161
161
|
/**
|
|
162
162
|
* Retrieve shipping label based on the shipment id and tracking id. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
163
163
|
* @param {string} shipmentId
|
|
@@ -166,13 +166,13 @@ export declare const ShippingApiFp: (configuration?: Configuration | undefined)
|
|
|
166
166
|
* @param {*} [options] Override http request option.
|
|
167
167
|
* @throws {RequiredError}
|
|
168
168
|
*/
|
|
169
|
-
retrieveShippingLabel(shipmentId: string, trackingId: string, body: RetrieveShippingLabelRequest, options?: AxiosRequestConfig
|
|
169
|
+
retrieveShippingLabel(shipmentId: string, trackingId: string, body: RetrieveShippingLabelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveShippingLabelResponse>>;
|
|
170
170
|
};
|
|
171
171
|
/**
|
|
172
172
|
* ShippingApi - factory interface
|
|
173
173
|
* @export
|
|
174
174
|
*/
|
|
175
|
-
export declare const ShippingApiFactory: (configuration?: Configuration
|
|
175
|
+
export declare const ShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
176
176
|
/**
|
|
177
177
|
* Cancel a shipment by the given shipmentId. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
178
178
|
* @param {string} shipmentId
|
|
@@ -27,22 +27,22 @@ export declare const assertParamExists: (functionName: string, paramName: string
|
|
|
27
27
|
*
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
|
-
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
41
|
/**
|
|
42
42
|
*
|
|
43
43
|
* @export
|
|
44
44
|
*/
|
|
45
|
-
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
46
|
/**
|
|
47
47
|
*
|
|
48
48
|
* @export
|
|
@@ -52,7 +52,7 @@ export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
|
52
52
|
*
|
|
53
53
|
* @export
|
|
54
54
|
*/
|
|
55
|
-
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
56
|
/**
|
|
57
57
|
*
|
|
58
58
|
* @export
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/package.json
CHANGED
|
@@ -2,11 +2,10 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/shipping-api-v1",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "Provides programmatic access to Amazon Shipping APIs.",
|
|
5
|
-
"version": "1.8.
|
|
5
|
+
"version": "1.8.8",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
9
|
-
"typedocMain": "./index.ts",
|
|
10
9
|
"license": "MIT",
|
|
11
10
|
"publishConfig": {
|
|
12
11
|
"access": "public"
|
|
@@ -27,8 +26,8 @@
|
|
|
27
26
|
"test": "jest"
|
|
28
27
|
},
|
|
29
28
|
"dependencies": {
|
|
30
|
-
"@sp-api-sdk/auth": "^1.9.
|
|
31
|
-
"@sp-api-sdk/common": "^1.9.
|
|
29
|
+
"@sp-api-sdk/auth": "^1.9.20",
|
|
30
|
+
"@sp-api-sdk/common": "^1.9.6",
|
|
32
31
|
"axios": "^0.27.2"
|
|
33
32
|
},
|
|
34
33
|
"repository": {
|
|
@@ -50,5 +49,8 @@
|
|
|
50
49
|
"sp sdk",
|
|
51
50
|
"shipping api"
|
|
52
51
|
],
|
|
53
|
-
"
|
|
52
|
+
"typedoc": {
|
|
53
|
+
"entryPoint": "./index.ts"
|
|
54
|
+
},
|
|
55
|
+
"gitHead": "c28c9ce8bfa10271bba79c0067c5c9f63a5f6dc0"
|
|
54
56
|
}
|