@sp-api-sdk/orders-api-v0 5.1.0 → 5.1.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.
Files changed (97) hide show
  1. package/dist/cjs/api-model/api/orders-api.js +0 -16
  2. package/dist/cjs/api-model/base.js +0 -19
  3. package/dist/cjs/api-model/common.js +0 -37
  4. package/dist/cjs/api-model/configuration.js +0 -17
  5. package/dist/cjs/api-model/models/association-type.js +0 -2
  6. package/dist/cjs/api-model/models/constraint-type.js +0 -2
  7. package/dist/cjs/api-model/models/easy-ship-shipment-status.js +0 -2
  8. package/dist/cjs/api-model/models/electronic-invoice-status.js +0 -2
  9. package/dist/cjs/api-model/models/other-delivery-attributes.js +0 -2
  10. package/dist/cjs/api-model/models/shipment-status.js +0 -2
  11. package/dist/cjs/api-model/models/verification-status.js +0 -2
  12. package/dist/es/api-model/api/orders-api.js +0 -16
  13. package/dist/es/api-model/base.js +0 -19
  14. package/dist/es/api-model/common.js +0 -37
  15. package/dist/es/api-model/configuration.js +0 -17
  16. package/dist/es/api-model/models/association-type.js +0 -2
  17. package/dist/es/api-model/models/constraint-type.js +0 -2
  18. package/dist/es/api-model/models/easy-ship-shipment-status.js +0 -2
  19. package/dist/es/api-model/models/electronic-invoice-status.js +0 -2
  20. package/dist/es/api-model/models/other-delivery-attributes.js +0 -2
  21. package/dist/es/api-model/models/shipment-status.js +0 -2
  22. package/dist/es/api-model/models/verification-status.js +0 -2
  23. package/dist/types/api-model/api/orders-api.d.ts +0 -108
  24. package/dist/types/api-model/base.d.ts +0 -24
  25. package/dist/types/api-model/common.d.ts +0 -37
  26. package/dist/types/api-model/configuration.d.ts +0 -17
  27. package/dist/types/api-model/models/address-extended-fields.d.ts +0 -10
  28. package/dist/types/api-model/models/address.d.ts +0 -35
  29. package/dist/types/api-model/models/amazon-programs.d.ts +0 -4
  30. package/dist/types/api-model/models/associated-item.d.ts +0 -11
  31. package/dist/types/api-model/models/association-type.d.ts +0 -2
  32. package/dist/types/api-model/models/automated-shipping-settings.d.ts +0 -8
  33. package/dist/types/api-model/models/business-hours.d.ts +0 -6
  34. package/dist/types/api-model/models/buyer-customized-info-detail.d.ts +0 -4
  35. package/dist/types/api-model/models/buyer-info.d.ts +0 -15
  36. package/dist/types/api-model/models/buyer-requested-cancel.d.ts +0 -6
  37. package/dist/types/api-model/models/buyer-tax-info.d.ts +0 -8
  38. package/dist/types/api-model/models/buyer-tax-information.d.ts +0 -10
  39. package/dist/types/api-model/models/confirm-shipment-error-response.d.ts +0 -4
  40. package/dist/types/api-model/models/confirm-shipment-order-item.d.ts +0 -8
  41. package/dist/types/api-model/models/confirm-shipment-request.d.ts +0 -11
  42. package/dist/types/api-model/models/constraint-type.d.ts +0 -2
  43. package/dist/types/api-model/models/delivery-preferences.d.ts +0 -13
  44. package/dist/types/api-model/models/easy-ship-shipment-status.d.ts +0 -2
  45. package/dist/types/api-model/models/electronic-invoice-status.d.ts +0 -2
  46. package/dist/types/api-model/models/exception-dates.d.ts +0 -8
  47. package/dist/types/api-model/models/fulfillment-instruction.d.ts +0 -4
  48. package/dist/types/api-model/models/get-order-address-response.d.ts +0 -9
  49. package/dist/types/api-model/models/get-order-buyer-info-response.d.ts +0 -9
  50. package/dist/types/api-model/models/get-order-items-buyer-info-response.d.ts +0 -9
  51. package/dist/types/api-model/models/get-order-items-response.d.ts +0 -9
  52. package/dist/types/api-model/models/get-order-regulated-info-response.d.ts +0 -9
  53. package/dist/types/api-model/models/get-order-response.d.ts +0 -9
  54. package/dist/types/api-model/models/get-orders-response.d.ts +0 -9
  55. package/dist/types/api-model/models/item-buyer-info.d.ts +0 -21
  56. package/dist/types/api-model/models/marketplace-tax-info.d.ts +0 -4
  57. package/dist/types/api-model/models/measurement.d.ts +0 -6
  58. package/dist/types/api-model/models/model-error.d.ts +0 -8
  59. package/dist/types/api-model/models/money.d.ts +0 -6
  60. package/dist/types/api-model/models/open-interval.d.ts +0 -12
  61. package/dist/types/api-model/models/open-time-interval.d.ts +0 -6
  62. package/dist/types/api-model/models/order-address.d.ts +0 -16
  63. package/dist/types/api-model/models/order-buyer-info.d.ts +0 -17
  64. package/dist/types/api-model/models/order-item-buyer-info.d.ts +0 -23
  65. package/dist/types/api-model/models/order-item.d.ts +0 -139
  66. package/dist/types/api-model/models/order-items-buyer-info-list.d.ts +0 -8
  67. package/dist/types/api-model/models/order-items-inner.d.ts +0 -9
  68. package/dist/types/api-model/models/order-items-list.d.ts +0 -8
  69. package/dist/types/api-model/models/order-regulated-info.d.ts +0 -16
  70. package/dist/types/api-model/models/order.d.ts +0 -126
  71. package/dist/types/api-model/models/orders-list.d.ts +0 -10
  72. package/dist/types/api-model/models/other-delivery-attributes.d.ts +0 -2
  73. package/dist/types/api-model/models/package-detail.d.ts +0 -18
  74. package/dist/types/api-model/models/payment-execution-detail-item.d.ts +0 -9
  75. package/dist/types/api-model/models/points-granted-detail.d.ts +0 -9
  76. package/dist/types/api-model/models/preferred-delivery-time.d.ts +0 -6
  77. package/dist/types/api-model/models/prescription-detail.d.ts +0 -16
  78. package/dist/types/api-model/models/product-info-detail.d.ts +0 -4
  79. package/dist/types/api-model/models/regulated-information-field.d.ts +0 -10
  80. package/dist/types/api-model/models/regulated-information.d.ts +0 -4
  81. package/dist/types/api-model/models/regulated-order-verification-status.d.ts +0 -22
  82. package/dist/types/api-model/models/rejection-reason.d.ts +0 -6
  83. package/dist/types/api-model/models/shipment-status.d.ts +0 -2
  84. package/dist/types/api-model/models/shipping-constraints.d.ts +0 -22
  85. package/dist/types/api-model/models/substitution-option.d.ts +0 -15
  86. package/dist/types/api-model/models/substitution-preferences.d.ts +0 -6
  87. package/dist/types/api-model/models/tax-classification.d.ts +0 -6
  88. package/dist/types/api-model/models/tax-collection.d.ts +0 -6
  89. package/dist/types/api-model/models/update-shipment-status-error-response.d.ts +0 -4
  90. package/dist/types/api-model/models/update-shipment-status-request.d.ts +0 -11
  91. package/dist/types/api-model/models/update-verification-status-error-response.d.ts +0 -4
  92. package/dist/types/api-model/models/update-verification-status-request-body.d.ts +0 -16
  93. package/dist/types/api-model/models/update-verification-status-request.d.ts +0 -7
  94. package/dist/types/api-model/models/valid-verification-detail.d.ts +0 -6
  95. package/dist/types/api-model/models/verification-details.d.ts +0 -7
  96. package/dist/types/api-model/models/verification-status.d.ts +0 -2
  97. package/package.json +25 -4
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Details the importance of the constraint present on the item
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const ConstraintType = {
20
18
  Mandatory: 'MANDATORY'
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The status of the Amazon Easy Ship order. This property is only included for Amazon Easy Ship orders.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const EasyShipShipmentStatus = {
20
18
  PendingSchedule: 'PendingSchedule',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The status of the electronic invoice. Only available for Easy Ship orders and orders in the BR marketplace.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const ElectronicInvoiceStatus = {
20
18
  NotRequired: 'NotRequired',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * Miscellaneous delivery attributes associated with the shipping address.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const OtherDeliveryAttributes = {
20
18
  HasAccessPoint: 'HAS_ACCESS_POINT',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The shipment status to apply.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const ShipmentStatus = {
20
18
  ReadyForPickup: 'ReadyForPickup',
@@ -13,8 +13,6 @@
13
13
  */
14
14
  /**
15
15
  * The verification status of the order.
16
- * @export
17
- * @enum {string}
18
16
  */
19
17
  export const VerificationStatus = {
20
18
  Pending: 'Pending',
@@ -25,7 +25,6 @@ import type { UpdateShipmentStatusRequest } from '../models';
25
25
  import type { UpdateVerificationStatusRequest } from '../models';
26
26
  /**
27
27
  * OrdersApi - axios parameter creator
28
- * @export
29
28
  */
30
29
  export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
31
30
  /**
@@ -127,7 +126,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
127
126
  };
128
127
  /**
129
128
  * OrdersApi - functional programming interface
130
- * @export
131
129
  */
132
130
  export declare const OrdersApiFp: (configuration?: Configuration) => {
133
131
  /**
@@ -229,7 +227,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
229
227
  };
230
228
  /**
231
229
  * OrdersApi - factory interface
232
- * @export
233
230
  */
234
231
  export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
235
232
  /**
@@ -305,295 +302,200 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
305
302
  };
306
303
  /**
307
304
  * Request parameters for confirmShipment operation in OrdersApi.
308
- * @export
309
- * @interface OrdersApiConfirmShipmentRequest
310
305
  */
311
306
  export interface OrdersApiConfirmShipmentRequest {
312
307
  /**
313
308
  * An Amazon-defined order identifier, in 3-7-7 format.
314
- * @type {string}
315
- * @memberof OrdersApiConfirmShipment
316
309
  */
317
310
  readonly orderId: string;
318
311
  /**
319
312
  * Request body of `confirmShipment`.
320
- * @type {ConfirmShipmentRequest}
321
- * @memberof OrdersApiConfirmShipment
322
313
  */
323
314
  readonly payload: ConfirmShipmentRequest;
324
315
  }
325
316
  /**
326
317
  * Request parameters for getOrder operation in OrdersApi.
327
- * @export
328
- * @interface OrdersApiGetOrderRequest
329
318
  */
330
319
  export interface OrdersApiGetOrderRequest {
331
320
  /**
332
321
  * An Amazon-defined order identifier, in 3-7-7 format.
333
- * @type {string}
334
- * @memberof OrdersApiGetOrder
335
322
  */
336
323
  readonly orderId: string;
337
324
  }
338
325
  /**
339
326
  * Request parameters for getOrderAddress operation in OrdersApi.
340
- * @export
341
- * @interface OrdersApiGetOrderAddressRequest
342
327
  */
343
328
  export interface OrdersApiGetOrderAddressRequest {
344
329
  /**
345
330
  * The Amazon order identifier in 3-7-7 format.
346
- * @type {string}
347
- * @memberof OrdersApiGetOrderAddress
348
331
  */
349
332
  readonly orderId: string;
350
333
  }
351
334
  /**
352
335
  * Request parameters for getOrderBuyerInfo operation in OrdersApi.
353
- * @export
354
- * @interface OrdersApiGetOrderBuyerInfoRequest
355
336
  */
356
337
  export interface OrdersApiGetOrderBuyerInfoRequest {
357
338
  /**
358
339
  * The Amazon order identifier in 3-7-7 format.
359
- * @type {string}
360
- * @memberof OrdersApiGetOrderBuyerInfo
361
340
  */
362
341
  readonly orderId: string;
363
342
  }
364
343
  /**
365
344
  * Request parameters for getOrderItems operation in OrdersApi.
366
- * @export
367
- * @interface OrdersApiGetOrderItemsRequest
368
345
  */
369
346
  export interface OrdersApiGetOrderItemsRequest {
370
347
  /**
371
348
  * An Amazon-defined order identifier, in 3-7-7 format.
372
- * @type {string}
373
- * @memberof OrdersApiGetOrderItems
374
349
  */
375
350
  readonly orderId: string;
376
351
  /**
377
352
  * A string token returned in the response of your previous request.
378
- * @type {string}
379
- * @memberof OrdersApiGetOrderItems
380
353
  */
381
354
  readonly nextToken?: string;
382
355
  }
383
356
  /**
384
357
  * Request parameters for getOrderItemsBuyerInfo operation in OrdersApi.
385
- * @export
386
- * @interface OrdersApiGetOrderItemsBuyerInfoRequest
387
358
  */
388
359
  export interface OrdersApiGetOrderItemsBuyerInfoRequest {
389
360
  /**
390
361
  * An Amazon-defined order identifier, in 3-7-7 format.
391
- * @type {string}
392
- * @memberof OrdersApiGetOrderItemsBuyerInfo
393
362
  */
394
363
  readonly orderId: string;
395
364
  /**
396
365
  * A string token returned in the response of your previous request.
397
- * @type {string}
398
- * @memberof OrdersApiGetOrderItemsBuyerInfo
399
366
  */
400
367
  readonly nextToken?: string;
401
368
  }
402
369
  /**
403
370
  * Request parameters for getOrderRegulatedInfo operation in OrdersApi.
404
- * @export
405
- * @interface OrdersApiGetOrderRegulatedInfoRequest
406
371
  */
407
372
  export interface OrdersApiGetOrderRegulatedInfoRequest {
408
373
  /**
409
374
  * The Amazon order identifier in 3-7-7 format.
410
- * @type {string}
411
- * @memberof OrdersApiGetOrderRegulatedInfo
412
375
  */
413
376
  readonly orderId: string;
414
377
  }
415
378
  /**
416
379
  * Request parameters for getOrders operation in OrdersApi.
417
- * @export
418
- * @interface OrdersApiGetOrdersRequest
419
380
  */
420
381
  export interface OrdersApiGetOrdersRequest {
421
382
  /**
422
383
  * A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
423
- * @type {Array<string>}
424
- * @memberof OrdersApiGetOrders
425
384
  */
426
385
  readonly marketplaceIds: Array<string>;
427
386
  /**
428
387
  * Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the &#x60;CreatedAfter&#x60; parameter or the &#x60;LastUpdatedAfter&#x60; parameter is required. Both cannot be empty. &#x60;LastUpdatedAfter&#x60; and &#x60;LastUpdatedBefore&#x60; cannot be set when &#x60;CreatedAfter&#x60; is set.
429
- * @type {string}
430
- * @memberof OrdersApiGetOrders
431
388
  */
432
389
  readonly createdAfter?: string;
433
390
  /**
434
391
  * Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: &#x60;CreatedBefore&#x60; is optional when &#x60;CreatedAfter&#x60; is set. If specified, &#x60;CreatedBefore&#x60; must be equal to or after the &#x60;CreatedAfter&#x60; date and at least two minutes before current time.
435
- * @type {string}
436
- * @memberof OrdersApiGetOrders
437
392
  */
438
393
  readonly createdBefore?: string;
439
394
  /**
440
395
  * Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the &#x60;CreatedAfter&#x60; parameter or the &#x60;LastUpdatedAfter&#x60; parameter is required. Both cannot be empty. &#x60;CreatedAfter&#x60; or &#x60;CreatedBefore&#x60; cannot be set when &#x60;LastUpdatedAfter&#x60; is set.
441
- * @type {string}
442
- * @memberof OrdersApiGetOrders
443
396
  */
444
397
  readonly lastUpdatedAfter?: string;
445
398
  /**
446
399
  * Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: &#x60;LastUpdatedBefore&#x60; is optional when &#x60;LastUpdatedAfter&#x60; is set. But if specified, &#x60;LastUpdatedBefore&#x60; must be equal to or after the &#x60;LastUpdatedAfter&#x60; date and at least two minutes before current time.
447
- * @type {string}
448
- * @memberof OrdersApiGetOrders
449
400
  */
450
401
  readonly lastUpdatedBefore?: string;
451
402
  /**
452
403
  * A list of &#x60;OrderStatus&#x60; values used to filter the results. **Possible values:** - &#x60;PendingAvailability&#x60; (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - &#x60;Pending&#x60; (The order has been placed but payment has not been authorized.) - &#x60;Unshipped&#x60; (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - &#x60;PartiallyShipped&#x60; (One or more, but not all, items in the order have been shipped.) - &#x60;Shipped&#x60; (All items in the order have been shipped.) - &#x60;InvoiceUnconfirmed&#x60; (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - &#x60;Canceled&#x60; (The order has been canceled.) - &#x60;Unfulfillable&#x60; (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
453
- * @type {Array<string>}
454
- * @memberof OrdersApiGetOrders
455
404
  */
456
405
  readonly orderStatuses?: Array<string>;
457
406
  /**
458
407
  * A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: &#x60;AFN&#x60; (fulfilled by Amazon), &#x60;MFN&#x60; (fulfilled by seller).
459
- * @type {Array<string>}
460
- * @memberof OrdersApiGetOrders
461
408
  */
462
409
  readonly fulfillmentChannels?: Array<string>;
463
410
  /**
464
411
  * A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: &#x60;COD&#x60; (cash on delivery), &#x60;CVS&#x60; (convenience store), &#x60;Other&#x60; (Any payment method other than COD or CVS).
465
- * @type {Array<string>}
466
- * @memberof OrdersApiGetOrders
467
412
  */
468
413
  readonly paymentMethods?: Array<string>;
469
414
  /**
470
415
  * The email address of a buyer. Used to select orders that contain the specified email address.
471
- * @type {string}
472
- * @memberof OrdersApiGetOrders
473
416
  */
474
417
  readonly buyerEmail?: string;
475
418
  /**
476
419
  * An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If &#x60;SellerOrderId&#x60; is specified, then &#x60;FulfillmentChannels&#x60;, &#x60;OrderStatuses&#x60;, &#x60;PaymentMethod&#x60;, &#x60;LastUpdatedAfter&#x60;, LastUpdatedBefore, and &#x60;BuyerEmail&#x60; cannot be specified.
477
- * @type {string}
478
- * @memberof OrdersApiGetOrders
479
420
  */
480
421
  readonly sellerOrderId?: string;
481
422
  /**
482
423
  * A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
483
- * @type {number}
484
- * @memberof OrdersApiGetOrders
485
424
  */
486
425
  readonly maxResultsPerPage?: number;
487
426
  /**
488
427
  * A list of &#x60;EasyShipShipmentStatus&#x60; values. Used to select Easy Ship orders with statuses that match the specified values. If &#x60;EasyShipShipmentStatus&#x60; is specified, only Amazon Easy Ship orders are returned. **Possible values:** - &#x60;PendingSchedule&#x60; (The package is awaiting the schedule for pick-up.) - &#x60;PendingPickUp&#x60; (Amazon has not yet picked up the package from the seller.) - &#x60;PendingDropOff&#x60; (The seller will deliver the package to the carrier.) - &#x60;LabelCanceled&#x60; (The seller canceled the pickup.) - &#x60;PickedUp&#x60; (Amazon has picked up the package from the seller.) - &#x60;DroppedOff&#x60; (The package is delivered to the carrier by the seller.) - &#x60;AtOriginFC&#x60; (The packaged is at the origin fulfillment center.) - &#x60;AtDestinationFC&#x60; (The package is at the destination fulfillment center.) - &#x60;Delivered&#x60; (The package has been delivered.) - &#x60;RejectedByBuyer&#x60; (The package has been rejected by the buyer.) - &#x60;Undeliverable&#x60; (The package cannot be delivered.) - &#x60;ReturningToSeller&#x60; (The package was not delivered and is being returned to the seller.) - &#x60;ReturnedToSeller&#x60; (The package was not delivered and was returned to the seller.) - &#x60;Lost&#x60; (The package is lost.) - &#x60;OutForDelivery&#x60; (The package is out for delivery.) - &#x60;Damaged&#x60; (The package was damaged by the carrier.)
489
- * @type {Array<string>}
490
- * @memberof OrdersApiGetOrders
491
428
  */
492
429
  readonly easyShipShipmentStatuses?: Array<string>;
493
430
  /**
494
431
  * A list of &#x60;ElectronicInvoiceStatus&#x60; values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - &#x60;NotRequired&#x60; (Electronic invoice submission is not required for this order.) - &#x60;NotFound&#x60; (The electronic invoice was not submitted for this order.) - &#x60;Processing&#x60; (The electronic invoice is being processed for this order.) - &#x60;Errored&#x60; (The last submitted electronic invoice was rejected for this order.) - &#x60;Accepted&#x60; (The last submitted electronic invoice was submitted and accepted.)
495
- * @type {Array<string>}
496
- * @memberof OrdersApiGetOrders
497
432
  */
498
433
  readonly electronicInvoiceStatuses?: Array<string>;
499
434
  /**
500
435
  * A string token returned in the response of your previous request.
501
- * @type {string}
502
- * @memberof OrdersApiGetOrders
503
436
  */
504
437
  readonly nextToken?: string;
505
438
  /**
506
439
  * A list of &#x60;AmazonOrderId&#x60; values. An &#x60;AmazonOrderId&#x60; is an Amazon-defined order identifier, in 3-7-7 format.
507
- * @type {Array<string>}
508
- * @memberof OrdersApiGetOrders
509
440
  */
510
441
  readonly amazonOrderIds?: Array<string>;
511
442
  /**
512
443
  * The &#x60;sourceId&#x60; of the location from where you want the order fulfilled.
513
- * @type {string}
514
- * @memberof OrdersApiGetOrders
515
444
  */
516
445
  readonly actualFulfillmentSupplySourceId?: string;
517
446
  /**
518
447
  * When true, this order is marked to be picked up from a store rather than delivered.
519
- * @type {boolean}
520
- * @memberof OrdersApiGetOrders
521
448
  */
522
449
  readonly isISPU?: boolean;
523
450
  /**
524
451
  * The store chain store identifier. Linked to a specific store in a store chain.
525
- * @type {string}
526
- * @memberof OrdersApiGetOrders
527
452
  */
528
453
  readonly storeChainStoreId?: string;
529
454
  /**
530
455
  * Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
531
- * @type {string}
532
- * @memberof OrdersApiGetOrders
533
456
  */
534
457
  readonly earliestDeliveryDateBefore?: string;
535
458
  /**
536
459
  * Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
537
- * @type {string}
538
- * @memberof OrdersApiGetOrders
539
460
  */
540
461
  readonly earliestDeliveryDateAfter?: string;
541
462
  /**
542
463
  * Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
543
- * @type {string}
544
- * @memberof OrdersApiGetOrders
545
464
  */
546
465
  readonly latestDeliveryDateBefore?: string;
547
466
  /**
548
467
  * Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
549
- * @type {string}
550
- * @memberof OrdersApiGetOrders
551
468
  */
552
469
  readonly latestDeliveryDateAfter?: string;
553
470
  }
554
471
  /**
555
472
  * Request parameters for updateShipmentStatus operation in OrdersApi.
556
- * @export
557
- * @interface OrdersApiUpdateShipmentStatusRequest
558
473
  */
559
474
  export interface OrdersApiUpdateShipmentStatusRequest {
560
475
  /**
561
476
  * An Amazon-defined order identifier, in 3-7-7 format.
562
- * @type {string}
563
- * @memberof OrdersApiUpdateShipmentStatus
564
477
  */
565
478
  readonly orderId: string;
566
479
  /**
567
480
  * The request body for the &#x60;updateShipmentStatus&#x60; operation.
568
- * @type {UpdateShipmentStatusRequest}
569
- * @memberof OrdersApiUpdateShipmentStatus
570
481
  */
571
482
  readonly payload: UpdateShipmentStatusRequest;
572
483
  }
573
484
  /**
574
485
  * Request parameters for updateVerificationStatus operation in OrdersApi.
575
- * @export
576
- * @interface OrdersApiUpdateVerificationStatusRequest
577
486
  */
578
487
  export interface OrdersApiUpdateVerificationStatusRequest {
579
488
  /**
580
489
  * The Amazon order identifier in 3-7-7 format.
581
- * @type {string}
582
- * @memberof OrdersApiUpdateVerificationStatus
583
490
  */
584
491
  readonly orderId: string;
585
492
  /**
586
493
  * The request body for the &#x60;updateVerificationStatus&#x60; operation.
587
- * @type {UpdateVerificationStatusRequest}
588
- * @memberof OrdersApiUpdateVerificationStatus
589
494
  */
590
495
  readonly payload: UpdateVerificationStatusRequest;
591
496
  }
592
497
  /**
593
498
  * OrdersApi - object-oriented interface
594
- * @export
595
- * @class OrdersApi
596
- * @extends {BaseAPI}
597
499
  */
598
500
  export declare class OrdersApi extends BaseAPI {
599
501
  /**
@@ -601,7 +503,6 @@ export declare class OrdersApi extends BaseAPI {
601
503
  * @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
602
504
  * @param {*} [options] Override http request option.
603
505
  * @throws {RequiredError}
604
- * @memberof OrdersApi
605
506
  */
606
507
  confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
607
508
  /**
@@ -609,7 +510,6 @@ export declare class OrdersApi extends BaseAPI {
609
510
  * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
610
511
  * @param {*} [options] Override http request option.
611
512
  * @throws {RequiredError}
612
- * @memberof OrdersApi
613
513
  */
614
514
  getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any>>;
615
515
  /**
@@ -617,7 +517,6 @@ export declare class OrdersApi extends BaseAPI {
617
517
  * @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
618
518
  * @param {*} [options] Override http request option.
619
519
  * @throws {RequiredError}
620
- * @memberof OrdersApi
621
520
  */
622
521
  getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderAddressResponse, any>>;
623
522
  /**
@@ -625,7 +524,6 @@ export declare class OrdersApi extends BaseAPI {
625
524
  * @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
626
525
  * @param {*} [options] Override http request option.
627
526
  * @throws {RequiredError}
628
- * @memberof OrdersApi
629
527
  */
630
528
  getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderBuyerInfoResponse, any>>;
631
529
  /**
@@ -633,7 +531,6 @@ export declare class OrdersApi extends BaseAPI {
633
531
  * @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
634
532
  * @param {*} [options] Override http request option.
635
533
  * @throws {RequiredError}
636
- * @memberof OrdersApi
637
534
  */
638
535
  getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsResponse, any>>;
639
536
  /**
@@ -641,7 +538,6 @@ export declare class OrdersApi extends BaseAPI {
641
538
  * @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
642
539
  * @param {*} [options] Override http request option.
643
540
  * @throws {RequiredError}
644
- * @memberof OrdersApi
645
541
  */
646
542
  getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
647
543
  /**
@@ -649,7 +545,6 @@ export declare class OrdersApi extends BaseAPI {
649
545
  * @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
650
546
  * @param {*} [options] Override http request option.
651
547
  * @throws {RequiredError}
652
- * @memberof OrdersApi
653
548
  */
654
549
  getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
655
550
  /**
@@ -657,7 +552,6 @@ export declare class OrdersApi extends BaseAPI {
657
552
  * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
658
553
  * @param {*} [options] Override http request option.
659
554
  * @throws {RequiredError}
660
- * @memberof OrdersApi
661
555
  */
662
556
  getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any>>;
663
557
  /**
@@ -665,7 +559,6 @@ export declare class OrdersApi extends BaseAPI {
665
559
  * @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
666
560
  * @param {*} [options] Override http request option.
667
561
  * @throws {RequiredError}
668
- * @memberof OrdersApi
669
562
  */
670
563
  updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
671
564
  /**
@@ -673,7 +566,6 @@ export declare class OrdersApi extends BaseAPI {
673
566
  * @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
674
567
  * @param {*} [options] Override http request option.
675
568
  * @throws {RequiredError}
676
- * @memberof OrdersApi
677
569
  */
678
570
  updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
679
571
  }
@@ -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,32 +11,22 @@
11
11
  */
12
12
  /**
13
13
  * The container for address extended fields (such as `street name` and `street number`). Currently only available with Brazil shipping addresses.
14
- * @export
15
- * @interface AddressExtendedFields
16
14
  */
17
15
  export interface AddressExtendedFields {
18
16
  /**
19
17
  * The street name.
20
- * @type {string}
21
- * @memberof AddressExtendedFields
22
18
  */
23
19
  'StreetName'?: string;
24
20
  /**
25
21
  * The house, building, or property number associated with the location\'s street address.
26
- * @type {string}
27
- * @memberof AddressExtendedFields
28
22
  */
29
23
  'StreetNumber'?: string;
30
24
  /**
31
25
  * The floor number/unit number in the building/private house number.
32
- * @type {string}
33
- * @memberof AddressExtendedFields
34
26
  */
35
27
  'Complement'?: string;
36
28
  /**
37
29
  * The neighborhood. This value is only used in some countries (such as Brazil).
38
- * @type {string}
39
- * @memberof AddressExtendedFields
40
30
  */
41
31
  'Neighborhood'?: string;
42
32
  }