@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 4.0.0 → 4.0.2
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-direct-fulfillment-shipping-api.js +0 -24
- 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-direct-fulfillment-shipping-api.js +0 -24
- 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-direct-fulfillment-shipping-api.d.ts +0 -90
- 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/address.d.ts +0 -24
- package/dist/types/api-model/models/container.d.ts +0 -32
- package/dist/types/api-model/models/customer-invoice-list.d.ts +0 -9
- package/dist/types/api-model/models/customer-invoice.d.ts +0 -6
- package/dist/types/api-model/models/dimensions.d.ts +0 -10
- package/dist/types/api-model/models/get-customer-invoice-response.d.ts +0 -9
- package/dist/types/api-model/models/get-customer-invoices-response.d.ts +0 -9
- package/dist/types/api-model/models/get-packing-slip-list-response.d.ts +0 -9
- package/dist/types/api-model/models/get-packing-slip-response.d.ts +0 -9
- package/dist/types/api-model/models/get-shipping-label-list-response.d.ts +0 -9
- package/dist/types/api-model/models/get-shipping-label-response.d.ts +0 -9
- package/dist/types/api-model/models/item-quantity.d.ts +0 -6
- package/dist/types/api-model/models/item.d.ts +0 -13
- package/dist/types/api-model/models/label-data.d.ts +0 -12
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/packed-item.d.ts +0 -13
- package/dist/types/api-model/models/packing-slip-list.d.ts +0 -9
- package/dist/types/api-model/models/packing-slip.d.ts +0 -8
- package/dist/types/api-model/models/pagination.d.ts +0 -4
- package/dist/types/api-model/models/party-identification.d.ts +0 -11
- package/dist/types/api-model/models/shipment-confirmation.d.ts +0 -23
- package/dist/types/api-model/models/shipment-details.d.ts +0 -12
- package/dist/types/api-model/models/shipment-status-update.d.ts +0 -19
- package/dist/types/api-model/models/shipping-label-list.d.ts +0 -9
- package/dist/types/api-model/models/shipping-label-request.d.ts +0 -16
- package/dist/types/api-model/models/shipping-label.d.ts +0 -18
- package/dist/types/api-model/models/status-update-details-shipment-schedule.d.ts +0 -8
- package/dist/types/api-model/models/status-update-details.d.ts +0 -20
- package/dist/types/api-model/models/submit-shipment-confirmations-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-shipment-confirmations-response.d.ts +0 -9
- package/dist/types/api-model/models/submit-shipment-status-updates-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-shipment-status-updates-response.d.ts +0 -9
- package/dist/types/api-model/models/submit-shipping-labels-request.d.ts +0 -4
- package/dist/types/api-model/models/submit-shipping-labels-response.d.ts +0 -9
- package/dist/types/api-model/models/tax-registration-details.d.ts +0 -13
- package/dist/types/api-model/models/transaction-reference.d.ts +0 -4
- package/dist/types/api-model/models/weight.d.ts +0 -6
- package/package.json +25 -4
|
@@ -27,7 +27,6 @@ import type { SubmitShippingLabelsRequest } from '../models';
|
|
|
27
27
|
import type { SubmitShippingLabelsResponse } from '../models';
|
|
28
28
|
/**
|
|
29
29
|
* VendorDirectFulfillmentShippingApi - axios parameter creator
|
|
30
|
-
* @export
|
|
31
30
|
*/
|
|
32
31
|
export declare const VendorDirectFulfillmentShippingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33
32
|
/**
|
|
@@ -111,7 +110,6 @@ export declare const VendorDirectFulfillmentShippingApiAxiosParamCreator: (confi
|
|
|
111
110
|
};
|
|
112
111
|
/**
|
|
113
112
|
* VendorDirectFulfillmentShippingApi - functional programming interface
|
|
114
|
-
* @export
|
|
115
113
|
*/
|
|
116
114
|
export declare const VendorDirectFulfillmentShippingApiFp: (configuration?: Configuration) => {
|
|
117
115
|
/**
|
|
@@ -195,7 +193,6 @@ export declare const VendorDirectFulfillmentShippingApiFp: (configuration?: Conf
|
|
|
195
193
|
};
|
|
196
194
|
/**
|
|
197
195
|
* VendorDirectFulfillmentShippingApi - factory interface
|
|
198
|
-
* @export
|
|
199
196
|
*/
|
|
200
197
|
export declare const VendorDirectFulfillmentShippingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
201
198
|
/**
|
|
@@ -264,216 +261,147 @@ export declare const VendorDirectFulfillmentShippingApiFactory: (configuration?:
|
|
|
264
261
|
};
|
|
265
262
|
/**
|
|
266
263
|
* Request parameters for getCustomerInvoice operation in VendorDirectFulfillmentShippingApi.
|
|
267
|
-
* @export
|
|
268
|
-
* @interface VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest
|
|
269
264
|
*/
|
|
270
265
|
export interface VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest {
|
|
271
266
|
/**
|
|
272
267
|
* Purchase order number of the shipment for which to return the invoice.
|
|
273
|
-
* @type {string}
|
|
274
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoice
|
|
275
268
|
*/
|
|
276
269
|
readonly purchaseOrderNumber: string;
|
|
277
270
|
}
|
|
278
271
|
/**
|
|
279
272
|
* Request parameters for getCustomerInvoices operation in VendorDirectFulfillmentShippingApi.
|
|
280
|
-
* @export
|
|
281
|
-
* @interface VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest
|
|
282
273
|
*/
|
|
283
274
|
export interface VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest {
|
|
284
275
|
/**
|
|
285
276
|
* Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
286
|
-
* @type {string}
|
|
287
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
288
277
|
*/
|
|
289
278
|
readonly createdAfter: string;
|
|
290
279
|
/**
|
|
291
280
|
* Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
292
|
-
* @type {string}
|
|
293
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
294
281
|
*/
|
|
295
282
|
readonly createdBefore: string;
|
|
296
283
|
/**
|
|
297
284
|
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
298
|
-
* @type {string}
|
|
299
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
300
285
|
*/
|
|
301
286
|
readonly shipFromPartyId?: string;
|
|
302
287
|
/**
|
|
303
288
|
* The limit to the number of records returned
|
|
304
|
-
* @type {number}
|
|
305
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
306
289
|
*/
|
|
307
290
|
readonly limit?: number;
|
|
308
291
|
/**
|
|
309
292
|
* Sort ASC or DESC by order creation date.
|
|
310
|
-
* @type {'ASC' | 'DESC'}
|
|
311
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
312
293
|
*/
|
|
313
294
|
readonly sortOrder?: GetCustomerInvoicesSortOrderEnum;
|
|
314
295
|
/**
|
|
315
296
|
* Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
|
|
316
|
-
* @type {string}
|
|
317
|
-
* @memberof VendorDirectFulfillmentShippingApiGetCustomerInvoices
|
|
318
297
|
*/
|
|
319
298
|
readonly nextToken?: string;
|
|
320
299
|
}
|
|
321
300
|
/**
|
|
322
301
|
* Request parameters for getPackingSlip operation in VendorDirectFulfillmentShippingApi.
|
|
323
|
-
* @export
|
|
324
|
-
* @interface VendorDirectFulfillmentShippingApiGetPackingSlipRequest
|
|
325
302
|
*/
|
|
326
303
|
export interface VendorDirectFulfillmentShippingApiGetPackingSlipRequest {
|
|
327
304
|
/**
|
|
328
305
|
* The purchaseOrderNumber for the packing slip you want.
|
|
329
|
-
* @type {string}
|
|
330
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlip
|
|
331
306
|
*/
|
|
332
307
|
readonly purchaseOrderNumber: string;
|
|
333
308
|
}
|
|
334
309
|
/**
|
|
335
310
|
* Request parameters for getPackingSlips operation in VendorDirectFulfillmentShippingApi.
|
|
336
|
-
* @export
|
|
337
|
-
* @interface VendorDirectFulfillmentShippingApiGetPackingSlipsRequest
|
|
338
311
|
*/
|
|
339
312
|
export interface VendorDirectFulfillmentShippingApiGetPackingSlipsRequest {
|
|
340
313
|
/**
|
|
341
314
|
* Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
342
|
-
* @type {string}
|
|
343
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
344
315
|
*/
|
|
345
316
|
readonly createdAfter: string;
|
|
346
317
|
/**
|
|
347
318
|
* Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
348
|
-
* @type {string}
|
|
349
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
350
319
|
*/
|
|
351
320
|
readonly createdBefore: string;
|
|
352
321
|
/**
|
|
353
322
|
* The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
354
|
-
* @type {string}
|
|
355
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
356
323
|
*/
|
|
357
324
|
readonly shipFromPartyId?: string;
|
|
358
325
|
/**
|
|
359
326
|
* The limit to the number of records returned
|
|
360
|
-
* @type {number}
|
|
361
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
362
327
|
*/
|
|
363
328
|
readonly limit?: number;
|
|
364
329
|
/**
|
|
365
330
|
* Sort ASC or DESC by packing slip creation date.
|
|
366
|
-
* @type {'ASC' | 'DESC'}
|
|
367
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
368
331
|
*/
|
|
369
332
|
readonly sortOrder?: GetPackingSlipsSortOrderEnum;
|
|
370
333
|
/**
|
|
371
334
|
* Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
372
|
-
* @type {string}
|
|
373
|
-
* @memberof VendorDirectFulfillmentShippingApiGetPackingSlips
|
|
374
335
|
*/
|
|
375
336
|
readonly nextToken?: string;
|
|
376
337
|
}
|
|
377
338
|
/**
|
|
378
339
|
* Request parameters for getShippingLabel operation in VendorDirectFulfillmentShippingApi.
|
|
379
|
-
* @export
|
|
380
|
-
* @interface VendorDirectFulfillmentShippingApiGetShippingLabelRequest
|
|
381
340
|
*/
|
|
382
341
|
export interface VendorDirectFulfillmentShippingApiGetShippingLabelRequest {
|
|
383
342
|
/**
|
|
384
343
|
* The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
385
|
-
* @type {string}
|
|
386
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabel
|
|
387
344
|
*/
|
|
388
345
|
readonly purchaseOrderNumber: string;
|
|
389
346
|
}
|
|
390
347
|
/**
|
|
391
348
|
* Request parameters for getShippingLabels operation in VendorDirectFulfillmentShippingApi.
|
|
392
|
-
* @export
|
|
393
|
-
* @interface VendorDirectFulfillmentShippingApiGetShippingLabelsRequest
|
|
394
349
|
*/
|
|
395
350
|
export interface VendorDirectFulfillmentShippingApiGetShippingLabelsRequest {
|
|
396
351
|
/**
|
|
397
352
|
* Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
398
|
-
* @type {string}
|
|
399
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
400
353
|
*/
|
|
401
354
|
readonly createdAfter: string;
|
|
402
355
|
/**
|
|
403
356
|
* Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
404
|
-
* @type {string}
|
|
405
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
406
357
|
*/
|
|
407
358
|
readonly createdBefore: string;
|
|
408
359
|
/**
|
|
409
360
|
* The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
410
|
-
* @type {string}
|
|
411
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
412
361
|
*/
|
|
413
362
|
readonly shipFromPartyId?: string;
|
|
414
363
|
/**
|
|
415
364
|
* The limit to the number of records returned.
|
|
416
|
-
* @type {number}
|
|
417
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
418
365
|
*/
|
|
419
366
|
readonly limit?: number;
|
|
420
367
|
/**
|
|
421
368
|
* Sort ASC or DESC by order creation date.
|
|
422
|
-
* @type {'ASC' | 'DESC'}
|
|
423
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
424
369
|
*/
|
|
425
370
|
readonly sortOrder?: GetShippingLabelsSortOrderEnum;
|
|
426
371
|
/**
|
|
427
372
|
* Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
428
|
-
* @type {string}
|
|
429
|
-
* @memberof VendorDirectFulfillmentShippingApiGetShippingLabels
|
|
430
373
|
*/
|
|
431
374
|
readonly nextToken?: string;
|
|
432
375
|
}
|
|
433
376
|
/**
|
|
434
377
|
* Request parameters for submitShipmentConfirmations operation in VendorDirectFulfillmentShippingApi.
|
|
435
|
-
* @export
|
|
436
|
-
* @interface VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest
|
|
437
378
|
*/
|
|
438
379
|
export interface VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest {
|
|
439
380
|
/**
|
|
440
381
|
* Request body containing the shipment confirmations data.
|
|
441
|
-
* @type {SubmitShipmentConfirmationsRequest}
|
|
442
|
-
* @memberof VendorDirectFulfillmentShippingApiSubmitShipmentConfirmations
|
|
443
382
|
*/
|
|
444
383
|
readonly body: SubmitShipmentConfirmationsRequest;
|
|
445
384
|
}
|
|
446
385
|
/**
|
|
447
386
|
* Request parameters for submitShipmentStatusUpdates operation in VendorDirectFulfillmentShippingApi.
|
|
448
|
-
* @export
|
|
449
|
-
* @interface VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest
|
|
450
387
|
*/
|
|
451
388
|
export interface VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest {
|
|
452
389
|
/**
|
|
453
390
|
* Request body containing the shipment status update data.
|
|
454
|
-
* @type {SubmitShipmentStatusUpdatesRequest}
|
|
455
|
-
* @memberof VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdates
|
|
456
391
|
*/
|
|
457
392
|
readonly body: SubmitShipmentStatusUpdatesRequest;
|
|
458
393
|
}
|
|
459
394
|
/**
|
|
460
395
|
* Request parameters for submitShippingLabelRequest operation in VendorDirectFulfillmentShippingApi.
|
|
461
|
-
* @export
|
|
462
|
-
* @interface VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest
|
|
463
396
|
*/
|
|
464
397
|
export interface VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest {
|
|
465
398
|
/**
|
|
466
399
|
* Request body containing one or more shipping labels data.
|
|
467
|
-
* @type {SubmitShippingLabelsRequest}
|
|
468
|
-
* @memberof VendorDirectFulfillmentShippingApiSubmitShippingLabelRequest
|
|
469
400
|
*/
|
|
470
401
|
readonly body: SubmitShippingLabelsRequest;
|
|
471
402
|
}
|
|
472
403
|
/**
|
|
473
404
|
* VendorDirectFulfillmentShippingApi - object-oriented interface
|
|
474
|
-
* @export
|
|
475
|
-
* @class VendorDirectFulfillmentShippingApi
|
|
476
|
-
* @extends {BaseAPI}
|
|
477
405
|
*/
|
|
478
406
|
export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
479
407
|
/**
|
|
@@ -481,7 +409,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
481
409
|
* @param {VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
482
410
|
* @param {*} [options] Override http request option.
|
|
483
411
|
* @throws {RequiredError}
|
|
484
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
485
412
|
*/
|
|
486
413
|
getCustomerInvoice(requestParameters: VendorDirectFulfillmentShippingApiGetCustomerInvoiceRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoiceResponse, any>>;
|
|
487
414
|
/**
|
|
@@ -489,7 +416,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
489
416
|
* @param {VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
490
417
|
* @param {*} [options] Override http request option.
|
|
491
418
|
* @throws {RequiredError}
|
|
492
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
493
419
|
*/
|
|
494
420
|
getCustomerInvoices(requestParameters: VendorDirectFulfillmentShippingApiGetCustomerInvoicesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetCustomerInvoicesResponse, any>>;
|
|
495
421
|
/**
|
|
@@ -497,7 +423,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
497
423
|
* @param {VendorDirectFulfillmentShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
498
424
|
* @param {*} [options] Override http request option.
|
|
499
425
|
* @throws {RequiredError}
|
|
500
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
501
426
|
*/
|
|
502
427
|
getPackingSlip(requestParameters: VendorDirectFulfillmentShippingApiGetPackingSlipRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipResponse, any>>;
|
|
503
428
|
/**
|
|
@@ -505,7 +430,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
505
430
|
* @param {VendorDirectFulfillmentShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
506
431
|
* @param {*} [options] Override http request option.
|
|
507
432
|
* @throws {RequiredError}
|
|
508
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
509
433
|
*/
|
|
510
434
|
getPackingSlips(requestParameters: VendorDirectFulfillmentShippingApiGetPackingSlipsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPackingSlipListResponse, any>>;
|
|
511
435
|
/**
|
|
@@ -513,7 +437,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
513
437
|
* @param {VendorDirectFulfillmentShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
514
438
|
* @param {*} [options] Override http request option.
|
|
515
439
|
* @throws {RequiredError}
|
|
516
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
517
440
|
*/
|
|
518
441
|
getShippingLabel(requestParameters: VendorDirectFulfillmentShippingApiGetShippingLabelRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelResponse, any>>;
|
|
519
442
|
/**
|
|
@@ -521,7 +444,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
521
444
|
* @param {VendorDirectFulfillmentShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
522
445
|
* @param {*} [options] Override http request option.
|
|
523
446
|
* @throws {RequiredError}
|
|
524
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
525
447
|
*/
|
|
526
448
|
getShippingLabels(requestParameters: VendorDirectFulfillmentShippingApiGetShippingLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShippingLabelListResponse, any>>;
|
|
527
449
|
/**
|
|
@@ -529,7 +451,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
529
451
|
* @param {VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
530
452
|
* @param {*} [options] Override http request option.
|
|
531
453
|
* @throws {RequiredError}
|
|
532
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
533
454
|
*/
|
|
534
455
|
submitShipmentConfirmations(requestParameters: VendorDirectFulfillmentShippingApiSubmitShipmentConfirmationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentConfirmationsResponse, any>>;
|
|
535
456
|
/**
|
|
@@ -537,7 +458,6 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
537
458
|
* @param {VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
538
459
|
* @param {*} [options] Override http request option.
|
|
539
460
|
* @throws {RequiredError}
|
|
540
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
541
461
|
*/
|
|
542
462
|
submitShipmentStatusUpdates(requestParameters: VendorDirectFulfillmentShippingApiSubmitShipmentStatusUpdatesRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShipmentStatusUpdatesResponse, any>>;
|
|
543
463
|
/**
|
|
@@ -545,29 +465,19 @@ export declare class VendorDirectFulfillmentShippingApi extends BaseAPI {
|
|
|
545
465
|
* @param {VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
546
466
|
* @param {*} [options] Override http request option.
|
|
547
467
|
* @throws {RequiredError}
|
|
548
|
-
* @memberof VendorDirectFulfillmentShippingApi
|
|
549
468
|
*/
|
|
550
469
|
submitShippingLabelRequest(requestParameters: VendorDirectFulfillmentShippingApiSubmitShippingLabelRequestRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitShippingLabelsResponse, any>>;
|
|
551
470
|
}
|
|
552
|
-
/**
|
|
553
|
-
* @export
|
|
554
|
-
*/
|
|
555
471
|
export declare const GetCustomerInvoicesSortOrderEnum: {
|
|
556
472
|
readonly Asc: "ASC";
|
|
557
473
|
readonly Desc: "DESC";
|
|
558
474
|
};
|
|
559
475
|
export type GetCustomerInvoicesSortOrderEnum = typeof GetCustomerInvoicesSortOrderEnum[keyof typeof GetCustomerInvoicesSortOrderEnum];
|
|
560
|
-
/**
|
|
561
|
-
* @export
|
|
562
|
-
*/
|
|
563
476
|
export declare const GetPackingSlipsSortOrderEnum: {
|
|
564
477
|
readonly Asc: "ASC";
|
|
565
478
|
readonly Desc: "DESC";
|
|
566
479
|
};
|
|
567
480
|
export type GetPackingSlipsSortOrderEnum = typeof GetPackingSlipsSortOrderEnum[keyof typeof GetPackingSlipsSortOrderEnum];
|
|
568
|
-
/**
|
|
569
|
-
* @export
|
|
570
|
-
*/
|
|
571
481
|
export declare const GetShippingLabelsSortOrderEnum: {
|
|
572
482
|
readonly Asc: "ASC";
|
|
573
483
|
readonly Desc: "DESC";
|
|
@@ -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
|
/**
|
|
@@ -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 street address information, if required.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Address
|
|
34
26
|
*/
|
|
35
27
|
'addressLine2'?: string;
|
|
36
28
|
/**
|
|
37
29
|
* Additional street 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 contains 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
|
}
|
|
@@ -14,80 +14,48 @@ import type { PackedItem } from './packed-item';
|
|
|
14
14
|
import type { Weight } from './weight';
|
|
15
15
|
/**
|
|
16
16
|
* A container used for shipping and packing items.
|
|
17
|
-
* @export
|
|
18
|
-
* @interface Container
|
|
19
17
|
*/
|
|
20
18
|
export interface Container {
|
|
21
19
|
/**
|
|
22
20
|
* The type of container.
|
|
23
|
-
* @type {string}
|
|
24
|
-
* @memberof Container
|
|
25
21
|
*/
|
|
26
22
|
'containerType': ContainerContainerTypeEnum;
|
|
27
23
|
/**
|
|
28
24
|
* The container identifier.
|
|
29
|
-
* @type {string}
|
|
30
|
-
* @memberof Container
|
|
31
25
|
*/
|
|
32
26
|
'containerIdentifier': string;
|
|
33
27
|
/**
|
|
34
28
|
* The tracking number.
|
|
35
|
-
* @type {string}
|
|
36
|
-
* @memberof Container
|
|
37
29
|
*/
|
|
38
30
|
'trackingNumber'?: string;
|
|
39
31
|
/**
|
|
40
32
|
* The manifest identifier.
|
|
41
|
-
* @type {string}
|
|
42
|
-
* @memberof Container
|
|
43
33
|
*/
|
|
44
34
|
'manifestId'?: string;
|
|
45
35
|
/**
|
|
46
36
|
* The date of the manifest.
|
|
47
|
-
* @type {string}
|
|
48
|
-
* @memberof Container
|
|
49
37
|
*/
|
|
50
38
|
'manifestDate'?: string;
|
|
51
39
|
/**
|
|
52
40
|
* The shipment method.
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof Container
|
|
55
41
|
*/
|
|
56
42
|
'shipMethod'?: string;
|
|
57
43
|
/**
|
|
58
44
|
* SCAC code required for NA VOC vendors only.
|
|
59
|
-
* @type {string}
|
|
60
|
-
* @memberof Container
|
|
61
45
|
*/
|
|
62
46
|
'scacCode'?: string;
|
|
63
47
|
/**
|
|
64
48
|
* Carrier required for EU VOC vendors only.
|
|
65
|
-
* @type {string}
|
|
66
|
-
* @memberof Container
|
|
67
49
|
*/
|
|
68
50
|
'carrier'?: string;
|
|
69
51
|
/**
|
|
70
52
|
* An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.
|
|
71
|
-
* @type {number}
|
|
72
|
-
* @memberof Container
|
|
73
53
|
*/
|
|
74
54
|
'containerSequenceNumber'?: number;
|
|
75
|
-
/**
|
|
76
|
-
*
|
|
77
|
-
* @type {Dimensions}
|
|
78
|
-
* @memberof Container
|
|
79
|
-
*/
|
|
80
55
|
'dimensions'?: Dimensions;
|
|
81
|
-
/**
|
|
82
|
-
*
|
|
83
|
-
* @type {Weight}
|
|
84
|
-
* @memberof Container
|
|
85
|
-
*/
|
|
86
56
|
'weight': Weight;
|
|
87
57
|
/**
|
|
88
58
|
* A list of packed items.
|
|
89
|
-
* @type {Array<PackedItem>}
|
|
90
|
-
* @memberof Container
|
|
91
59
|
*/
|
|
92
60
|
'packedItems': Array<PackedItem>;
|
|
93
61
|
}
|
|
@@ -13,20 +13,11 @@ import type { CustomerInvoice } from './customer-invoice';
|
|
|
13
13
|
import type { Pagination } from './pagination';
|
|
14
14
|
/**
|
|
15
15
|
* Represents a list of customer invoices, potentially paginated.
|
|
16
|
-
* @export
|
|
17
|
-
* @interface CustomerInvoiceList
|
|
18
16
|
*/
|
|
19
17
|
export interface CustomerInvoiceList {
|
|
20
|
-
/**
|
|
21
|
-
*
|
|
22
|
-
* @type {Pagination}
|
|
23
|
-
* @memberof CustomerInvoiceList
|
|
24
|
-
*/
|
|
25
18
|
'pagination'?: Pagination;
|
|
26
19
|
/**
|
|
27
20
|
* Represents a customer invoice within the CustomerInvoiceList.
|
|
28
|
-
* @type {Array<CustomerInvoice>}
|
|
29
|
-
* @memberof CustomerInvoiceList
|
|
30
21
|
*/
|
|
31
22
|
'customerInvoices'?: Array<CustomerInvoice>;
|
|
32
23
|
}
|
|
@@ -11,20 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* Represents a customer invoice associated with a purchase order.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface CustomerInvoice
|
|
16
14
|
*/
|
|
17
15
|
export interface CustomerInvoice {
|
|
18
16
|
/**
|
|
19
17
|
* The purchase order number for this order.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof CustomerInvoice
|
|
22
18
|
*/
|
|
23
19
|
'purchaseOrderNumber': string;
|
|
24
20
|
/**
|
|
25
21
|
* The Base64encoded customer invoice.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof CustomerInvoice
|
|
28
22
|
*/
|
|
29
23
|
'content': string;
|
|
30
24
|
}
|