@sp-api-sdk/vendor-orders-api-v1 3.0.6 → 3.0.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.
- package/dist/cjs/api-model/api/vendor-orders-api.js +0 -31
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/es/api-model/api/vendor-orders-api.js +0 -31
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/types/api-model/api/vendor-orders-api.d.ts +0 -93
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/acknowledgement-status-details.d.ts +0 -14
- package/dist/types/api-model/models/address.d.ts +0 -24
- package/dist/types/api-model/models/get-purchase-order-response.d.ts +0 -9
- package/dist/types/api-model/models/get-purchase-orders-response.d.ts +0 -9
- package/dist/types/api-model/models/get-purchase-orders-status-response.d.ts +0 -9
- package/dist/types/api-model/models/import-details.d.ts +0 -12
- package/dist/types/api-model/models/item-quantity.d.ts +0 -8
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/money.d.ts +0 -8
- package/dist/types/api-model/models/order-acknowledgement-item.d.ts +0 -27
- package/dist/types/api-model/models/order-acknowledgement.d.ts +0 -13
- package/dist/types/api-model/models/order-details.d.ts +0 -45
- package/dist/types/api-model/models/order-item-acknowledgement.d.ts +0 -15
- package/dist/types/api-model/models/order-item-status-acknowledgement-status.d.ts +0 -16
- package/dist/types/api-model/models/order-item-status-ordered-quantity.d.ts +0 -9
- package/dist/types/api-model/models/order-item-status-receiving-status.d.ts +0 -11
- package/dist/types/api-model/models/order-item-status.d.ts +0 -33
- package/dist/types/api-model/models/order-item.d.ts +0 -25
- package/dist/types/api-model/models/order-list-status.d.ts +0 -9
- package/dist/types/api-model/models/order-list.d.ts +0 -9
- package/dist/types/api-model/models/order-status.d.ts +0 -22
- package/dist/types/api-model/models/order.d.ts +0 -11
- package/dist/types/api-model/models/ordered-quantity-details.d.ts +0 -14
- package/dist/types/api-model/models/pagination.d.ts +0 -4
- package/dist/types/api-model/models/party-identification.d.ts +0 -14
- package/dist/types/api-model/models/submit-acknowledgement-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-acknowledgement-response.d.ts +0 -9
- package/dist/types/api-model/models/tax-registration-details.d.ts +0 -6
- package/dist/types/api-model/models/transaction-id.d.ts +0 -4
- package/package.json +25 -4
|
@@ -20,7 +20,6 @@ import type { SubmitAcknowledgementRequest } from '../models';
|
|
|
20
20
|
import type { SubmitAcknowledgementResponse } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* VendorOrdersApi - axios parameter creator
|
|
23
|
-
* @export
|
|
24
23
|
*/
|
|
25
24
|
export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
25
|
/**
|
|
@@ -77,7 +76,6 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
77
76
|
};
|
|
78
77
|
/**
|
|
79
78
|
* VendorOrdersApi - functional programming interface
|
|
80
|
-
* @export
|
|
81
79
|
*/
|
|
82
80
|
export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
83
81
|
/**
|
|
@@ -134,7 +132,6 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
|
134
132
|
};
|
|
135
133
|
/**
|
|
136
134
|
* VendorOrdersApi - factory interface
|
|
137
|
-
* @export
|
|
138
135
|
*/
|
|
139
136
|
export declare const VendorOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
137
|
/**
|
|
@@ -168,199 +165,134 @@ export declare const VendorOrdersApiFactory: (configuration?: Configuration, bas
|
|
|
168
165
|
};
|
|
169
166
|
/**
|
|
170
167
|
* Request parameters for getPurchaseOrder operation in VendorOrdersApi.
|
|
171
|
-
* @export
|
|
172
|
-
* @interface VendorOrdersApiGetPurchaseOrderRequest
|
|
173
168
|
*/
|
|
174
169
|
export interface VendorOrdersApiGetPurchaseOrderRequest {
|
|
175
170
|
/**
|
|
176
171
|
* The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
177
|
-
* @type {string}
|
|
178
|
-
* @memberof VendorOrdersApiGetPurchaseOrder
|
|
179
172
|
*/
|
|
180
173
|
readonly purchaseOrderNumber: string;
|
|
181
174
|
}
|
|
182
175
|
/**
|
|
183
176
|
* Request parameters for getPurchaseOrders operation in VendorOrdersApi.
|
|
184
|
-
* @export
|
|
185
|
-
* @interface VendorOrdersApiGetPurchaseOrdersRequest
|
|
186
177
|
*/
|
|
187
178
|
export interface VendorOrdersApiGetPurchaseOrdersRequest {
|
|
188
179
|
/**
|
|
189
180
|
* The limit to the number of records returned. Default value is 100 records.
|
|
190
|
-
* @type {number}
|
|
191
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
192
181
|
*/
|
|
193
182
|
readonly limit?: number;
|
|
194
183
|
/**
|
|
195
184
|
* Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
196
|
-
* @type {string}
|
|
197
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
198
185
|
*/
|
|
199
186
|
readonly createdAfter?: string;
|
|
200
187
|
/**
|
|
201
188
|
* Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
202
|
-
* @type {string}
|
|
203
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
204
189
|
*/
|
|
205
190
|
readonly createdBefore?: string;
|
|
206
191
|
/**
|
|
207
192
|
* Sort in ascending or descending order by purchase order creation date.
|
|
208
|
-
* @type {'ASC' | 'DESC'}
|
|
209
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
210
193
|
*/
|
|
211
194
|
readonly sortOrder?: GetPurchaseOrdersSortOrderEnum;
|
|
212
195
|
/**
|
|
213
196
|
* Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call
|
|
214
|
-
* @type {string}
|
|
215
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
216
197
|
*/
|
|
217
198
|
readonly nextToken?: string;
|
|
218
199
|
/**
|
|
219
200
|
* When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
220
|
-
* @type {boolean}
|
|
221
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
222
201
|
*/
|
|
223
202
|
readonly includeDetails?: boolean;
|
|
224
203
|
/**
|
|
225
204
|
* Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
226
|
-
* @type {string}
|
|
227
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
228
205
|
*/
|
|
229
206
|
readonly changedAfter?: string;
|
|
230
207
|
/**
|
|
231
208
|
* Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
232
|
-
* @type {string}
|
|
233
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
234
209
|
*/
|
|
235
210
|
readonly changedBefore?: string;
|
|
236
211
|
/**
|
|
237
212
|
* Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
|
|
238
|
-
* @type {'Cancelled'}
|
|
239
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
240
213
|
*/
|
|
241
214
|
readonly poItemState?: GetPurchaseOrdersPoItemStateEnum;
|
|
242
215
|
/**
|
|
243
216
|
* When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
|
|
244
|
-
* @type {boolean}
|
|
245
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
246
217
|
*/
|
|
247
218
|
readonly isPOChanged?: boolean;
|
|
248
219
|
/**
|
|
249
220
|
* Filters purchase orders based on the purchase order state.
|
|
250
|
-
* @type {'New' | 'Acknowledged' | 'Closed'}
|
|
251
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
252
221
|
*/
|
|
253
222
|
readonly purchaseOrderState?: GetPurchaseOrdersPurchaseOrderStateEnum;
|
|
254
223
|
/**
|
|
255
224
|
* Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
|
|
256
|
-
* @type {string}
|
|
257
|
-
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
258
225
|
*/
|
|
259
226
|
readonly orderingVendorCode?: string;
|
|
260
227
|
}
|
|
261
228
|
/**
|
|
262
229
|
* Request parameters for getPurchaseOrdersStatus operation in VendorOrdersApi.
|
|
263
|
-
* @export
|
|
264
|
-
* @interface VendorOrdersApiGetPurchaseOrdersStatusRequest
|
|
265
230
|
*/
|
|
266
231
|
export interface VendorOrdersApiGetPurchaseOrdersStatusRequest {
|
|
267
232
|
/**
|
|
268
233
|
* The limit to the number of records returned. Default value is 100 records.
|
|
269
|
-
* @type {number}
|
|
270
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
271
234
|
*/
|
|
272
235
|
readonly limit?: number;
|
|
273
236
|
/**
|
|
274
237
|
* Sort in ascending or descending order by purchase order creation date.
|
|
275
|
-
* @type {'ASC' | 'DESC'}
|
|
276
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
277
238
|
*/
|
|
278
239
|
readonly sortOrder?: GetPurchaseOrdersStatusSortOrderEnum;
|
|
279
240
|
/**
|
|
280
241
|
* Used for pagination when there are more purchase orders than the specified result size limit.
|
|
281
|
-
* @type {string}
|
|
282
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
283
242
|
*/
|
|
284
243
|
readonly nextToken?: string;
|
|
285
244
|
/**
|
|
286
245
|
* Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
287
|
-
* @type {string}
|
|
288
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
289
246
|
*/
|
|
290
247
|
readonly createdAfter?: string;
|
|
291
248
|
/**
|
|
292
249
|
* Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
293
|
-
* @type {string}
|
|
294
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
295
250
|
*/
|
|
296
251
|
readonly createdBefore?: string;
|
|
297
252
|
/**
|
|
298
253
|
* Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
299
|
-
* @type {string}
|
|
300
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
301
254
|
*/
|
|
302
255
|
readonly updatedAfter?: string;
|
|
303
256
|
/**
|
|
304
257
|
* Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
305
|
-
* @type {string}
|
|
306
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
307
258
|
*/
|
|
308
259
|
readonly updatedBefore?: string;
|
|
309
260
|
/**
|
|
310
261
|
* Provides purchase order status for the specified purchase order number.
|
|
311
|
-
* @type {string}
|
|
312
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
313
262
|
*/
|
|
314
263
|
readonly purchaseOrderNumber?: string;
|
|
315
264
|
/**
|
|
316
265
|
* Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
|
|
317
|
-
* @type {'OPEN' | 'CLOSED'}
|
|
318
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
319
266
|
*/
|
|
320
267
|
readonly purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum;
|
|
321
268
|
/**
|
|
322
269
|
* Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.
|
|
323
|
-
* @type {'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'REJECTED' | 'UNCONFIRMED'}
|
|
324
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
325
270
|
*/
|
|
326
271
|
readonly itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum;
|
|
327
272
|
/**
|
|
328
273
|
* Filters purchase orders based on the purchase order\'s item receive status. If the item receive status is not included in the filter, purchase orders for all receive statuses are included.
|
|
329
|
-
* @type {'NOT_RECEIVED' | 'PARTIALLY_RECEIVED' | 'RECEIVED'}
|
|
330
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
331
274
|
*/
|
|
332
275
|
readonly itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum;
|
|
333
276
|
/**
|
|
334
277
|
* Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in filter, all purchase orders for all the vendor codes that exist in the vendor group used to authorize API client application are returned.
|
|
335
|
-
* @type {string}
|
|
336
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
337
278
|
*/
|
|
338
279
|
readonly orderingVendorCode?: string;
|
|
339
280
|
/**
|
|
340
281
|
* Filters purchase orders for a specific buyer\'s Fulfillment Center/warehouse by providing ship to location id here. This value should be same as \'shipToParty.partyId\' in the purchase order. If not included in filter, this will return purchase orders for all the buyer\'s warehouses used for vendor group purchase orders.
|
|
341
|
-
* @type {string}
|
|
342
|
-
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
343
282
|
*/
|
|
344
283
|
readonly shipToPartyId?: string;
|
|
345
284
|
}
|
|
346
285
|
/**
|
|
347
286
|
* Request parameters for submitAcknowledgement operation in VendorOrdersApi.
|
|
348
|
-
* @export
|
|
349
|
-
* @interface VendorOrdersApiSubmitAcknowledgementRequest
|
|
350
287
|
*/
|
|
351
288
|
export interface VendorOrdersApiSubmitAcknowledgementRequest {
|
|
352
289
|
/**
|
|
353
290
|
* Submits acknowledgements for one or more purchase orders from a vendor.
|
|
354
|
-
* @type {SubmitAcknowledgementRequest}
|
|
355
|
-
* @memberof VendorOrdersApiSubmitAcknowledgement
|
|
356
291
|
*/
|
|
357
292
|
readonly body: SubmitAcknowledgementRequest;
|
|
358
293
|
}
|
|
359
294
|
/**
|
|
360
295
|
* VendorOrdersApi - object-oriented interface
|
|
361
|
-
* @export
|
|
362
|
-
* @class VendorOrdersApi
|
|
363
|
-
* @extends {BaseAPI}
|
|
364
296
|
*/
|
|
365
297
|
export declare class VendorOrdersApi extends BaseAPI {
|
|
366
298
|
/**
|
|
@@ -368,7 +300,6 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
368
300
|
* @param {VendorOrdersApiGetPurchaseOrderRequest} requestParameters Request parameters.
|
|
369
301
|
* @param {*} [options] Override http request option.
|
|
370
302
|
* @throws {RequiredError}
|
|
371
|
-
* @memberof VendorOrdersApi
|
|
372
303
|
*/
|
|
373
304
|
getPurchaseOrder(requestParameters: VendorOrdersApiGetPurchaseOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPurchaseOrderResponse, any>>;
|
|
374
305
|
/**
|
|
@@ -376,7 +307,6 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
376
307
|
* @param {VendorOrdersApiGetPurchaseOrdersRequest} requestParameters Request parameters.
|
|
377
308
|
* @param {*} [options] Override http request option.
|
|
378
309
|
* @throws {RequiredError}
|
|
379
|
-
* @memberof VendorOrdersApi
|
|
380
310
|
*/
|
|
381
311
|
getPurchaseOrders(requestParameters?: VendorOrdersApiGetPurchaseOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPurchaseOrdersResponse, any>>;
|
|
382
312
|
/**
|
|
@@ -384,7 +314,6 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
384
314
|
* @param {VendorOrdersApiGetPurchaseOrdersStatusRequest} requestParameters Request parameters.
|
|
385
315
|
* @param {*} [options] Override http request option.
|
|
386
316
|
* @throws {RequiredError}
|
|
387
|
-
* @memberof VendorOrdersApi
|
|
388
317
|
*/
|
|
389
318
|
getPurchaseOrdersStatus(requestParameters?: VendorOrdersApiGetPurchaseOrdersStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPurchaseOrdersStatusResponse, any>>;
|
|
390
319
|
/**
|
|
@@ -392,53 +321,34 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
392
321
|
* @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
|
|
393
322
|
* @param {*} [options] Override http request option.
|
|
394
323
|
* @throws {RequiredError}
|
|
395
|
-
* @memberof VendorOrdersApi
|
|
396
324
|
*/
|
|
397
325
|
submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitAcknowledgementResponse, any>>;
|
|
398
326
|
}
|
|
399
|
-
/**
|
|
400
|
-
* @export
|
|
401
|
-
*/
|
|
402
327
|
export declare const GetPurchaseOrdersSortOrderEnum: {
|
|
403
328
|
readonly Asc: "ASC";
|
|
404
329
|
readonly Desc: "DESC";
|
|
405
330
|
};
|
|
406
331
|
export type GetPurchaseOrdersSortOrderEnum = typeof GetPurchaseOrdersSortOrderEnum[keyof typeof GetPurchaseOrdersSortOrderEnum];
|
|
407
|
-
/**
|
|
408
|
-
* @export
|
|
409
|
-
*/
|
|
410
332
|
export declare const GetPurchaseOrdersPoItemStateEnum: {
|
|
411
333
|
readonly Cancelled: "Cancelled";
|
|
412
334
|
};
|
|
413
335
|
export type GetPurchaseOrdersPoItemStateEnum = typeof GetPurchaseOrdersPoItemStateEnum[keyof typeof GetPurchaseOrdersPoItemStateEnum];
|
|
414
|
-
/**
|
|
415
|
-
* @export
|
|
416
|
-
*/
|
|
417
336
|
export declare const GetPurchaseOrdersPurchaseOrderStateEnum: {
|
|
418
337
|
readonly New: "New";
|
|
419
338
|
readonly Acknowledged: "Acknowledged";
|
|
420
339
|
readonly Closed: "Closed";
|
|
421
340
|
};
|
|
422
341
|
export type GetPurchaseOrdersPurchaseOrderStateEnum = typeof GetPurchaseOrdersPurchaseOrderStateEnum[keyof typeof GetPurchaseOrdersPurchaseOrderStateEnum];
|
|
423
|
-
/**
|
|
424
|
-
* @export
|
|
425
|
-
*/
|
|
426
342
|
export declare const GetPurchaseOrdersStatusSortOrderEnum: {
|
|
427
343
|
readonly Asc: "ASC";
|
|
428
344
|
readonly Desc: "DESC";
|
|
429
345
|
};
|
|
430
346
|
export type GetPurchaseOrdersStatusSortOrderEnum = typeof GetPurchaseOrdersStatusSortOrderEnum[keyof typeof GetPurchaseOrdersStatusSortOrderEnum];
|
|
431
|
-
/**
|
|
432
|
-
* @export
|
|
433
|
-
*/
|
|
434
347
|
export declare const GetPurchaseOrdersStatusPurchaseOrderStatusEnum: {
|
|
435
348
|
readonly Open: "OPEN";
|
|
436
349
|
readonly Closed: "CLOSED";
|
|
437
350
|
};
|
|
438
351
|
export type GetPurchaseOrdersStatusPurchaseOrderStatusEnum = typeof GetPurchaseOrdersStatusPurchaseOrderStatusEnum[keyof typeof GetPurchaseOrdersStatusPurchaseOrderStatusEnum];
|
|
439
|
-
/**
|
|
440
|
-
* @export
|
|
441
|
-
*/
|
|
442
352
|
export declare const GetPurchaseOrdersStatusItemConfirmationStatusEnum: {
|
|
443
353
|
readonly Accepted: "ACCEPTED";
|
|
444
354
|
readonly PartiallyAccepted: "PARTIALLY_ACCEPTED";
|
|
@@ -446,9 +356,6 @@ export declare const GetPurchaseOrdersStatusItemConfirmationStatusEnum: {
|
|
|
446
356
|
readonly Unconfirmed: "UNCONFIRMED";
|
|
447
357
|
};
|
|
448
358
|
export type GetPurchaseOrdersStatusItemConfirmationStatusEnum = typeof GetPurchaseOrdersStatusItemConfirmationStatusEnum[keyof typeof GetPurchaseOrdersStatusItemConfirmationStatusEnum];
|
|
449
|
-
/**
|
|
450
|
-
* @export
|
|
451
|
-
*/
|
|
452
359
|
export declare const GetPurchaseOrdersStatusItemReceiveStatusEnum: {
|
|
453
360
|
readonly NotReceived: "NOT_RECEIVED";
|
|
454
361
|
readonly PartiallyReceived: "PARTIALLY_RECEIVED";
|
|
@@ -12,42 +12,22 @@
|
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const COLLECTION_FORMATS: {
|
|
20
16
|
csv: string;
|
|
21
17
|
ssv: string;
|
|
22
18
|
tsv: string;
|
|
23
19
|
pipes: string;
|
|
24
20
|
};
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @export
|
|
28
|
-
* @interface RequestArgs
|
|
29
|
-
*/
|
|
30
21
|
export interface RequestArgs {
|
|
31
22
|
url: string;
|
|
32
23
|
options: RawAxiosRequestConfig;
|
|
33
24
|
}
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @export
|
|
37
|
-
* @class BaseAPI
|
|
38
|
-
*/
|
|
39
25
|
export declare class BaseAPI {
|
|
40
26
|
protected basePath: string;
|
|
41
27
|
protected axios: AxiosInstance;
|
|
42
28
|
protected configuration: Configuration | undefined;
|
|
43
29
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
30
|
}
|
|
45
|
-
/**
|
|
46
|
-
*
|
|
47
|
-
* @export
|
|
48
|
-
* @class RequiredError
|
|
49
|
-
* @extends {Error}
|
|
50
|
-
*/
|
|
51
31
|
export declare class RequiredError extends Error {
|
|
52
32
|
field: string;
|
|
53
33
|
constructor(field: string, msg?: string);
|
|
@@ -58,9 +38,5 @@ interface ServerMap {
|
|
|
58
38
|
description: string;
|
|
59
39
|
}[];
|
|
60
40
|
}
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
41
|
export declare const operationServerMap: ServerMap;
|
|
66
42
|
export {};
|
|
@@ -12,54 +12,17 @@
|
|
|
12
12
|
import type { Configuration } from "./configuration";
|
|
13
13
|
import type { RequestArgs } from "./base";
|
|
14
14
|
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
16
|
/**
|
|
21
17
|
*
|
|
22
18
|
* @throws {RequiredError}
|
|
23
|
-
* @export
|
|
24
19
|
*/
|
|
25
20
|
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
*/
|
|
30
21
|
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
*/
|
|
35
22
|
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @export
|
|
39
|
-
*/
|
|
40
23
|
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @export
|
|
44
|
-
*/
|
|
45
24
|
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
*
|
|
48
|
-
* @export
|
|
49
|
-
*/
|
|
50
25
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
-
/**
|
|
52
|
-
*
|
|
53
|
-
* @export
|
|
54
|
-
*/
|
|
55
26
|
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
-
/**
|
|
57
|
-
*
|
|
58
|
-
* @export
|
|
59
|
-
*/
|
|
60
27
|
export declare const toPathString: (url: URL) => string;
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
28
|
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -23,49 +23,32 @@ export declare class Configuration {
|
|
|
23
23
|
/**
|
|
24
24
|
* parameter for apiKey security
|
|
25
25
|
* @param name security name
|
|
26
|
-
* @memberof Configuration
|
|
27
26
|
*/
|
|
28
27
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
28
|
/**
|
|
30
29
|
* parameter for basic security
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Configuration
|
|
34
30
|
*/
|
|
35
31
|
username?: string;
|
|
36
32
|
/**
|
|
37
33
|
* parameter for basic security
|
|
38
|
-
*
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof Configuration
|
|
41
34
|
*/
|
|
42
35
|
password?: string;
|
|
43
36
|
/**
|
|
44
37
|
* parameter for oauth2 security
|
|
45
38
|
* @param name security name
|
|
46
39
|
* @param scopes oauth2 scope
|
|
47
|
-
* @memberof Configuration
|
|
48
40
|
*/
|
|
49
41
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
42
|
/**
|
|
51
43
|
* override base path
|
|
52
|
-
*
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof Configuration
|
|
55
44
|
*/
|
|
56
45
|
basePath?: string;
|
|
57
46
|
/**
|
|
58
47
|
* override server index
|
|
59
|
-
*
|
|
60
|
-
* @type {number}
|
|
61
|
-
* @memberof Configuration
|
|
62
48
|
*/
|
|
63
49
|
serverIndex?: number;
|
|
64
50
|
/**
|
|
65
51
|
* base options for axios calls
|
|
66
|
-
*
|
|
67
|
-
* @type {any}
|
|
68
|
-
* @memberof Configuration
|
|
69
52
|
*/
|
|
70
53
|
baseOptions?: any;
|
|
71
54
|
/**
|
|
@@ -12,26 +12,12 @@
|
|
|
12
12
|
import type { ItemQuantity } from './item-quantity';
|
|
13
13
|
/**
|
|
14
14
|
* Details of item quantity ordered
|
|
15
|
-
* @export
|
|
16
|
-
* @interface AcknowledgementStatusDetails
|
|
17
15
|
*/
|
|
18
16
|
export interface AcknowledgementStatusDetails {
|
|
19
17
|
/**
|
|
20
18
|
* The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof AcknowledgementStatusDetails
|
|
23
19
|
*/
|
|
24
20
|
'acknowledgementDate'?: string;
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @type {ItemQuantity}
|
|
28
|
-
* @memberof AcknowledgementStatusDetails
|
|
29
|
-
*/
|
|
30
21
|
'acceptedQuantity'?: ItemQuantity;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {ItemQuantity}
|
|
34
|
-
* @memberof AcknowledgementStatusDetails
|
|
35
|
-
*/
|
|
36
22
|
'rejectedQuantity'?: ItemQuantity;
|
|
37
23
|
}
|
|
@@ -11,74 +11,50 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* Address of the party.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface Address
|
|
16
14
|
*/
|
|
17
15
|
export interface Address {
|
|
18
16
|
/**
|
|
19
17
|
* The name of the person, business or institution at that address.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof Address
|
|
22
18
|
*/
|
|
23
19
|
'name': string;
|
|
24
20
|
/**
|
|
25
21
|
* First line of the address.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof Address
|
|
28
22
|
*/
|
|
29
23
|
'addressLine1': string;
|
|
30
24
|
/**
|
|
31
25
|
* Additional address information, if required.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Address
|
|
34
26
|
*/
|
|
35
27
|
'addressLine2'?: string;
|
|
36
28
|
/**
|
|
37
29
|
* Additional address information, if required.
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof Address
|
|
40
30
|
*/
|
|
41
31
|
'addressLine3'?: string;
|
|
42
32
|
/**
|
|
43
33
|
* The city where the person, business or institution is located.
|
|
44
|
-
* @type {string}
|
|
45
|
-
* @memberof Address
|
|
46
34
|
*/
|
|
47
35
|
'city'?: string;
|
|
48
36
|
/**
|
|
49
37
|
* The county where person, business or institution is located.
|
|
50
|
-
* @type {string}
|
|
51
|
-
* @memberof Address
|
|
52
38
|
*/
|
|
53
39
|
'county'?: string;
|
|
54
40
|
/**
|
|
55
41
|
* The district where person, business or institution is located.
|
|
56
|
-
* @type {string}
|
|
57
|
-
* @memberof Address
|
|
58
42
|
*/
|
|
59
43
|
'district'?: string;
|
|
60
44
|
/**
|
|
61
45
|
* The state or region where person, business or institution is located.
|
|
62
|
-
* @type {string}
|
|
63
|
-
* @memberof Address
|
|
64
46
|
*/
|
|
65
47
|
'stateOrRegion'?: string;
|
|
66
48
|
/**
|
|
67
49
|
* The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
|
|
68
|
-
* @type {string}
|
|
69
|
-
* @memberof Address
|
|
70
50
|
*/
|
|
71
51
|
'postalCode'?: string;
|
|
72
52
|
/**
|
|
73
53
|
* The two digit country code. In ISO 3166-1 alpha-2 format.
|
|
74
|
-
* @type {string}
|
|
75
|
-
* @memberof Address
|
|
76
54
|
*/
|
|
77
55
|
'countryCode': string;
|
|
78
56
|
/**
|
|
79
57
|
* The phone number of the person, business or institution located at that address.
|
|
80
|
-
* @type {string}
|
|
81
|
-
* @memberof Address
|
|
82
58
|
*/
|
|
83
59
|
'phone'?: string;
|
|
84
60
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { Order } from './order';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the getPurchaseOrder operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface GetPurchaseOrderResponse
|
|
17
15
|
*/
|
|
18
16
|
export interface GetPurchaseOrderResponse {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {Order}
|
|
22
|
-
* @memberof GetPurchaseOrderResponse
|
|
23
|
-
*/
|
|
24
17
|
'payload'?: Order;
|
|
25
18
|
/**
|
|
26
19
|
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
-
* @type {Array<Error>}
|
|
28
|
-
* @memberof GetPurchaseOrderResponse
|
|
29
20
|
*/
|
|
30
21
|
'errors'?: Array<Error>;
|
|
31
22
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { OrderList } from './order-list';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the getPurchaseOrders operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface GetPurchaseOrdersResponse
|
|
17
15
|
*/
|
|
18
16
|
export interface GetPurchaseOrdersResponse {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {OrderList}
|
|
22
|
-
* @memberof GetPurchaseOrdersResponse
|
|
23
|
-
*/
|
|
24
17
|
'payload'?: OrderList;
|
|
25
18
|
/**
|
|
26
19
|
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
-
* @type {Array<Error>}
|
|
28
|
-
* @memberof GetPurchaseOrdersResponse
|
|
29
20
|
*/
|
|
30
21
|
'errors'?: Array<Error>;
|
|
31
22
|
}
|
|
@@ -12,20 +12,11 @@
|
|
|
12
12
|
import type { OrderListStatus } from './order-list-status';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the getPurchaseOrdersStatus operation.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface GetPurchaseOrdersStatusResponse
|
|
17
15
|
*/
|
|
18
16
|
export interface GetPurchaseOrdersStatusResponse {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {OrderListStatus}
|
|
22
|
-
* @memberof GetPurchaseOrdersStatusResponse
|
|
23
|
-
*/
|
|
24
17
|
'payload'?: OrderListStatus;
|
|
25
18
|
/**
|
|
26
19
|
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
-
* @type {Array<Error>}
|
|
28
|
-
* @memberof GetPurchaseOrdersStatusResponse
|
|
29
20
|
*/
|
|
30
21
|
'errors'?: Array<Error>;
|
|
31
22
|
}
|
|
@@ -11,38 +11,26 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* Import details for an import order.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface ImportDetails
|
|
16
14
|
*/
|
|
17
15
|
export interface ImportDetails {
|
|
18
16
|
/**
|
|
19
17
|
* If the recipient requests, contains the shipment method of payment. This is for import PO\'s only.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof ImportDetails
|
|
22
18
|
*/
|
|
23
19
|
'methodOfPayment'?: ImportDetailsMethodOfPaymentEnum;
|
|
24
20
|
/**
|
|
25
21
|
* Incoterms (International Commercial Terms) are used to divide transaction costs and responsibilities between buyer and seller and reflect state-of-the-art transportation practices. This is for import purchase orders only.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof ImportDetails
|
|
28
22
|
*/
|
|
29
23
|
'internationalCommercialTerms'?: ImportDetailsInternationalCommercialTermsEnum;
|
|
30
24
|
/**
|
|
31
25
|
* The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof ImportDetails
|
|
34
26
|
*/
|
|
35
27
|
'portOfDelivery'?: string;
|
|
36
28
|
/**
|
|
37
29
|
* Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40\'(40-foot container), 40\'HC (40-foot high-capacity container), 45\', 45\'HC, 30\', 30\'HC, 20\', 20\'HC.
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof ImportDetails
|
|
40
30
|
*/
|
|
41
31
|
'importContainers'?: string;
|
|
42
32
|
/**
|
|
43
33
|
* Special instructions regarding the shipment. This field is for import purchase orders.
|
|
44
|
-
* @type {string}
|
|
45
|
-
* @memberof ImportDetails
|
|
46
34
|
*/
|
|
47
35
|
'shippingInstructions'?: string;
|
|
48
36
|
}
|