@sp-api-sdk/vendor-orders-api-v1 1.9.5 → 1.9.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.
|
@@ -21,7 +21,7 @@ import { SubmitAcknowledgementResponse } from '../models';
|
|
|
21
21
|
* VendorOrdersApi - axios parameter creator
|
|
22
22
|
* @export
|
|
23
23
|
*/
|
|
24
|
-
export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration
|
|
24
|
+
export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
25
|
/**
|
|
26
26
|
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
27
27
|
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
@@ -46,7 +46,7 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
46
46
|
* @param {*} [options] Override http request option.
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
getPurchaseOrders: (limit?: number
|
|
49
|
+
getPurchaseOrders: (limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: 'ASC' | 'DESC', nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: 'Cancelled', isPOChanged?: boolean, purchaseOrderState?: 'New' | 'Acknowledged' | 'Closed', orderingVendorCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
51
|
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
52
52
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
@@ -65,7 +65,7 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
68
|
-
getPurchaseOrdersStatus: (limit?: number
|
|
68
|
+
getPurchaseOrdersStatus: (limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: 'OPEN' | 'CLOSED', itemConfirmationStatus?: 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED', itemReceiveStatus?: 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED', orderingVendorCode?: string, shipToPartyId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
69
|
/**
|
|
70
70
|
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
71
71
|
* @param {SubmitAcknowledgementRequest} body
|
|
@@ -78,14 +78,14 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
78
78
|
* VendorOrdersApi - functional programming interface
|
|
79
79
|
* @export
|
|
80
80
|
*/
|
|
81
|
-
export declare const VendorOrdersApiFp: (configuration?: Configuration
|
|
81
|
+
export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
82
82
|
/**
|
|
83
83
|
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
84
84
|
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
85
85
|
* @param {*} [options] Override http request option.
|
|
86
86
|
* @throws {RequiredError}
|
|
87
87
|
*/
|
|
88
|
-
getPurchaseOrder(purchaseOrderNumber: string, options?: AxiosRequestConfig
|
|
88
|
+
getPurchaseOrder(purchaseOrderNumber: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrderResponse>>;
|
|
89
89
|
/**
|
|
90
90
|
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
91
91
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
@@ -103,7 +103,7 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration | undefin
|
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
104
104
|
* @throws {RequiredError}
|
|
105
105
|
*/
|
|
106
|
-
getPurchaseOrders(limit?: number
|
|
106
|
+
getPurchaseOrders(limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: 'ASC' | 'DESC', nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: 'Cancelled', isPOChanged?: boolean, purchaseOrderState?: 'New' | 'Acknowledged' | 'Closed', orderingVendorCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrdersResponse>>;
|
|
107
107
|
/**
|
|
108
108
|
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
109
109
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
@@ -122,20 +122,20 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration | undefin
|
|
|
122
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
125
|
-
getPurchaseOrdersStatus(limit?: number
|
|
125
|
+
getPurchaseOrdersStatus(limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: 'OPEN' | 'CLOSED', itemConfirmationStatus?: 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED', itemReceiveStatus?: 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED', orderingVendorCode?: string, shipToPartyId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrdersStatusResponse>>;
|
|
126
126
|
/**
|
|
127
127
|
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
128
128
|
* @param {SubmitAcknowledgementRequest} body
|
|
129
129
|
* @param {*} [options] Override http request option.
|
|
130
130
|
* @throws {RequiredError}
|
|
131
131
|
*/
|
|
132
|
-
submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: AxiosRequestConfig
|
|
132
|
+
submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitAcknowledgementResponse>>;
|
|
133
133
|
};
|
|
134
134
|
/**
|
|
135
135
|
* VendorOrdersApi - factory interface
|
|
136
136
|
* @export
|
|
137
137
|
*/
|
|
138
|
-
export declare const VendorOrdersApiFactory: (configuration?: Configuration
|
|
138
|
+
export declare const VendorOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
139
139
|
/**
|
|
140
140
|
* Returns a purchase order based on the purchaseOrderNumber value that you specify. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
141
141
|
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
@@ -160,7 +160,7 @@ export declare const VendorOrdersApiFactory: (configuration?: Configuration | un
|
|
|
160
160
|
* @param {*} [options] Override http request option.
|
|
161
161
|
* @throws {RequiredError}
|
|
162
162
|
*/
|
|
163
|
-
getPurchaseOrders(limit?: number
|
|
163
|
+
getPurchaseOrders(limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: 'ASC' | 'DESC', nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: 'Cancelled', isPOChanged?: boolean, purchaseOrderState?: 'New' | 'Acknowledged' | 'Closed', orderingVendorCode?: string, options?: any): AxiosPromise<GetPurchaseOrdersResponse>;
|
|
164
164
|
/**
|
|
165
165
|
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
166
166
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
@@ -179,7 +179,7 @@ export declare const VendorOrdersApiFactory: (configuration?: Configuration | un
|
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
180
180
|
* @throws {RequiredError}
|
|
181
181
|
*/
|
|
182
|
-
getPurchaseOrdersStatus(limit?: number
|
|
182
|
+
getPurchaseOrdersStatus(limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: 'OPEN' | 'CLOSED', itemConfirmationStatus?: 'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED', itemReceiveStatus?: 'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED', orderingVendorCode?: string, shipToPartyId?: string, options?: any): AxiosPromise<GetPurchaseOrdersStatusResponse>;
|
|
183
183
|
/**
|
|
184
184
|
* Submits acknowledgements for one or more purchase orders. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
185
185
|
* @param {SubmitAcknowledgementRequest} body
|
|
@@ -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/vendor-orders-api-v1",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Retail Procurement Orders provides programmatic access to vendor orders data.",
|
|
5
|
-
"version": "1.9.
|
|
5
|
+
"version": "1.9.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
|
"vendor orders api"
|
|
52
51
|
],
|
|
53
|
-
"
|
|
52
|
+
"typedoc": {
|
|
53
|
+
"entryPoint": "./index.ts"
|
|
54
|
+
},
|
|
55
|
+
"gitHead": "c28c9ce8bfa10271bba79c0067c5c9f63a5f6dc0"
|
|
54
56
|
}
|