@sp-api-sdk/easy-ship-api-2022-03-23 3.0.0

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 (111) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +107 -0
  3. package/dist/cjs/api-model/api/easy-ship-api.js +367 -0
  4. package/dist/cjs/api-model/api.js +30 -0
  5. package/dist/cjs/api-model/base.js +71 -0
  6. package/dist/cjs/api-model/common.js +145 -0
  7. package/dist/cjs/api-model/configuration.js +99 -0
  8. package/dist/cjs/api-model/index.js +32 -0
  9. package/dist/cjs/api-model/models/code.js +34 -0
  10. package/dist/cjs/api-model/models/create-scheduled-package-request.js +15 -0
  11. package/dist/cjs/api-model/models/create-scheduled-packages-request.js +15 -0
  12. package/dist/cjs/api-model/models/create-scheduled-packages-response.js +15 -0
  13. package/dist/cjs/api-model/models/dimensions.js +15 -0
  14. package/dist/cjs/api-model/models/error-list.js +15 -0
  15. package/dist/cjs/api-model/models/handover-method.js +25 -0
  16. package/dist/cjs/api-model/models/index.js +43 -0
  17. package/dist/cjs/api-model/models/invoice-data.js +15 -0
  18. package/dist/cjs/api-model/models/item.js +15 -0
  19. package/dist/cjs/api-model/models/label-format.js +25 -0
  20. package/dist/cjs/api-model/models/list-handover-slots-request.js +15 -0
  21. package/dist/cjs/api-model/models/list-handover-slots-response.js +15 -0
  22. package/dist/cjs/api-model/models/model-error.js +15 -0
  23. package/dist/cjs/api-model/models/order-schedule-details.js +15 -0
  24. package/dist/cjs/api-model/models/package-details.js +15 -0
  25. package/dist/cjs/api-model/models/package-status.js +35 -0
  26. package/dist/cjs/api-model/models/package.js +15 -0
  27. package/dist/cjs/api-model/models/packages.js +15 -0
  28. package/dist/cjs/api-model/models/rejected-order.js +15 -0
  29. package/dist/cjs/api-model/models/scheduled-package-id.js +15 -0
  30. package/dist/cjs/api-model/models/time-slot.js +15 -0
  31. package/dist/cjs/api-model/models/tracking-details.js +15 -0
  32. package/dist/cjs/api-model/models/unit-of-length.js +24 -0
  33. package/dist/cjs/api-model/models/unit-of-weight.js +25 -0
  34. package/dist/cjs/api-model/models/update-package-details.js +15 -0
  35. package/dist/cjs/api-model/models/update-scheduled-packages-request.js +15 -0
  36. package/dist/cjs/api-model/models/weight.js +15 -0
  37. package/dist/cjs/client.js +49 -0
  38. package/dist/cjs/index.js +19 -0
  39. package/dist/es/api-model/api/easy-ship-api.js +357 -0
  40. package/dist/es/api-model/api.js +14 -0
  41. package/dist/es/api-model/base.js +63 -0
  42. package/dist/es/api-model/common.js +133 -0
  43. package/dist/es/api-model/configuration.js +95 -0
  44. package/dist/es/api-model/index.js +16 -0
  45. package/dist/es/api-model/models/code.js +31 -0
  46. package/dist/es/api-model/models/create-scheduled-package-request.js +14 -0
  47. package/dist/es/api-model/models/create-scheduled-packages-request.js +14 -0
  48. package/dist/es/api-model/models/create-scheduled-packages-response.js +14 -0
  49. package/dist/es/api-model/models/dimensions.js +14 -0
  50. package/dist/es/api-model/models/error-list.js +14 -0
  51. package/dist/es/api-model/models/handover-method.js +22 -0
  52. package/dist/es/api-model/models/index.js +27 -0
  53. package/dist/es/api-model/models/invoice-data.js +14 -0
  54. package/dist/es/api-model/models/item.js +14 -0
  55. package/dist/es/api-model/models/label-format.js +22 -0
  56. package/dist/es/api-model/models/list-handover-slots-request.js +14 -0
  57. package/dist/es/api-model/models/list-handover-slots-response.js +14 -0
  58. package/dist/es/api-model/models/model-error.js +14 -0
  59. package/dist/es/api-model/models/order-schedule-details.js +14 -0
  60. package/dist/es/api-model/models/package-details.js +14 -0
  61. package/dist/es/api-model/models/package-status.js +32 -0
  62. package/dist/es/api-model/models/package.js +14 -0
  63. package/dist/es/api-model/models/packages.js +14 -0
  64. package/dist/es/api-model/models/rejected-order.js +14 -0
  65. package/dist/es/api-model/models/scheduled-package-id.js +14 -0
  66. package/dist/es/api-model/models/time-slot.js +14 -0
  67. package/dist/es/api-model/models/tracking-details.js +14 -0
  68. package/dist/es/api-model/models/unit-of-length.js +21 -0
  69. package/dist/es/api-model/models/unit-of-weight.js +22 -0
  70. package/dist/es/api-model/models/update-package-details.js +14 -0
  71. package/dist/es/api-model/models/update-scheduled-packages-request.js +14 -0
  72. package/dist/es/api-model/models/weight.js +14 -0
  73. package/dist/es/client.js +45 -0
  74. package/dist/es/index.js +3 -0
  75. package/dist/types/api-model/api/easy-ship-api.d.ts +267 -0
  76. package/dist/types/api-model/api.d.ts +12 -0
  77. package/dist/types/api-model/base.d.ts +66 -0
  78. package/dist/types/api-model/common.d.ts +65 -0
  79. package/dist/types/api-model/configuration.d.ts +91 -0
  80. package/dist/types/api-model/index.d.ts +14 -0
  81. package/dist/types/api-model/models/code.d.ts +30 -0
  82. package/dist/types/api-model/models/create-scheduled-package-request.d.ts +37 -0
  83. package/dist/types/api-model/models/create-scheduled-packages-request.d.ts +38 -0
  84. package/dist/types/api-model/models/create-scheduled-packages-response.d.ts +38 -0
  85. package/dist/types/api-model/models/dimensions.d.ts +49 -0
  86. package/dist/types/api-model/models/error-list.d.ts +24 -0
  87. package/dist/types/api-model/models/handover-method.d.ts +21 -0
  88. package/dist/types/api-model/models/index.d.ts +27 -0
  89. package/dist/types/api-model/models/invoice-data.d.ts +30 -0
  90. package/dist/types/api-model/models/item.d.ts +30 -0
  91. package/dist/types/api-model/models/label-format.d.ts +21 -0
  92. package/dist/types/api-model/models/list-handover-slots-request.d.ts +44 -0
  93. package/dist/types/api-model/models/list-handover-slots-response.d.ts +31 -0
  94. package/dist/types/api-model/models/model-error.d.ts +36 -0
  95. package/dist/types/api-model/models/order-schedule-details.d.ts +31 -0
  96. package/dist/types/api-model/models/package-details.d.ts +38 -0
  97. package/dist/types/api-model/models/package-status.d.ts +31 -0
  98. package/dist/types/api-model/models/package.d.ts +80 -0
  99. package/dist/types/api-model/models/packages.d.ts +25 -0
  100. package/dist/types/api-model/models/rejected-order.d.ts +30 -0
  101. package/dist/types/api-model/models/scheduled-package-id.d.ts +30 -0
  102. package/dist/types/api-model/models/time-slot.d.ts +43 -0
  103. package/dist/types/api-model/models/tracking-details.d.ts +24 -0
  104. package/dist/types/api-model/models/unit-of-length.d.ts +20 -0
  105. package/dist/types/api-model/models/unit-of-weight.d.ts +21 -0
  106. package/dist/types/api-model/models/update-package-details.d.ts +32 -0
  107. package/dist/types/api-model/models/update-scheduled-packages-request.d.ts +31 -0
  108. package/dist/types/api-model/models/weight.d.ts +31 -0
  109. package/dist/types/client.d.ts +6 -0
  110. package/dist/types/index.d.ts +3 -0
  111. package/package.json +44 -0
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A order which we couldn\'t schedule on your behalf. It contains its id, and information on the error.
14
+ * @export
15
+ * @interface RejectedOrder
16
+ */
17
+ export interface RejectedOrder {
18
+ /**
19
+ * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
20
+ * @type {string}
21
+ * @memberof RejectedOrder
22
+ */
23
+ 'amazonOrderId': string;
24
+ /**
25
+ *
26
+ * @type {Error}
27
+ * @memberof RejectedOrder
28
+ */
29
+ 'error'?: Error;
30
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Identifies the scheduled package to be updated.
14
+ * @export
15
+ * @interface ScheduledPackageId
16
+ */
17
+ export interface ScheduledPackageId {
18
+ /**
19
+ * An Amazon-defined order identifier. Identifies the order that the seller wants to deliver using Amazon Easy Ship.
20
+ * @type {string}
21
+ * @memberof ScheduledPackageId
22
+ */
23
+ 'amazonOrderId': string;
24
+ /**
25
+ * An Amazon-defined identifier for the scheduled package.
26
+ * @type {string}
27
+ * @memberof ScheduledPackageId
28
+ */
29
+ 'packageId'?: string;
30
+ }
@@ -0,0 +1,43 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { HandoverMethod } from './handover-method';
13
+ /**
14
+ * A time window to hand over an Easy Ship package to Amazon Logistics.
15
+ * @export
16
+ * @interface TimeSlot
17
+ */
18
+ export interface TimeSlot {
19
+ /**
20
+ * A string of up to 255 characters.
21
+ * @type {string}
22
+ * @memberof TimeSlot
23
+ */
24
+ 'slotId': string;
25
+ /**
26
+ * A datetime value in ISO 8601 format.
27
+ * @type {string}
28
+ * @memberof TimeSlot
29
+ */
30
+ 'startTime'?: string;
31
+ /**
32
+ * A datetime value in ISO 8601 format.
33
+ * @type {string}
34
+ * @memberof TimeSlot
35
+ */
36
+ 'endTime'?: string;
37
+ /**
38
+ *
39
+ * @type {HandoverMethod}
40
+ * @memberof TimeSlot
41
+ */
42
+ 'handoverMethod'?: HandoverMethod;
43
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Representation of tracking metadata.
14
+ * @export
15
+ * @interface TrackingDetails
16
+ */
17
+ export interface TrackingDetails {
18
+ /**
19
+ * A string of up to 255 characters.
20
+ * @type {string}
21
+ * @memberof TrackingDetails
22
+ */
23
+ 'trackingId'?: string;
24
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The unit of measurement used to measure the length.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const UnitOfLength: {
18
+ readonly Cm: "Cm";
19
+ };
20
+ export type UnitOfLength = typeof UnitOfLength[keyof typeof UnitOfLength];
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The unit of measurement used to measure the weight.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const UnitOfWeight: {
18
+ readonly Grams: "Grams";
19
+ readonly G: "G";
20
+ };
21
+ export type UnitOfWeight = typeof UnitOfWeight[keyof typeof UnitOfWeight];
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ScheduledPackageId } from './scheduled-package-id';
13
+ import type { TimeSlot } from './time-slot';
14
+ /**
15
+ * Request to update the time slot of a package.
16
+ * @export
17
+ * @interface UpdatePackageDetails
18
+ */
19
+ export interface UpdatePackageDetails {
20
+ /**
21
+ *
22
+ * @type {ScheduledPackageId}
23
+ * @memberof UpdatePackageDetails
24
+ */
25
+ 'scheduledPackageId': ScheduledPackageId;
26
+ /**
27
+ *
28
+ * @type {TimeSlot}
29
+ * @memberof UpdatePackageDetails
30
+ */
31
+ 'packageTimeSlot': TimeSlot;
32
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { UpdatePackageDetails } from './update-package-details';
13
+ /**
14
+ * The request schema for the `updateScheduledPackages` operation.
15
+ * @export
16
+ * @interface UpdateScheduledPackagesRequest
17
+ */
18
+ export interface UpdateScheduledPackagesRequest {
19
+ /**
20
+ * A string of up to 255 characters.
21
+ * @type {string}
22
+ * @memberof UpdateScheduledPackagesRequest
23
+ */
24
+ 'marketplaceId': string;
25
+ /**
26
+ * A list of package update details.
27
+ * @type {Array<UpdatePackageDetails>}
28
+ * @memberof UpdateScheduledPackagesRequest
29
+ */
30
+ 'updatePackageDetailsList': Array<UpdatePackageDetails>;
31
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Easy Ship
3
+ * The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: * Get available time slots for packages to be scheduled for delivery. * Schedule, reschedule, and cancel Easy Ship orders. * Print labels, invoices, and warranties. See the [Marketplace Support Table](https://developer-docs.amazon.com/sp-api/docs/easyship-api-v2022-03-23-use-case-guide#marketplace-support-table) for the differences in Easy Ship operations by marketplace.
4
+ *
5
+ * The version of the OpenAPI document: 2022-03-23
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { UnitOfWeight } from './unit-of-weight';
13
+ /**
14
+ * The weight of the scheduled package
15
+ * @export
16
+ * @interface Weight
17
+ */
18
+ export interface Weight {
19
+ /**
20
+ * The weight of the package.
21
+ * @type {number}
22
+ * @memberof Weight
23
+ */
24
+ 'value'?: number;
25
+ /**
26
+ *
27
+ * @type {UnitOfWeight}
28
+ * @memberof Weight
29
+ */
30
+ 'unit'?: UnitOfWeight;
31
+ }
@@ -0,0 +1,6 @@
1
+ import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
2
+ import { EasyShipApi } from './api-model';
3
+ export declare const clientRateLimits: RateLimit[];
4
+ export declare class EasyShipApiClient extends EasyShipApi {
5
+ constructor(configuration: ClientConfiguration);
6
+ }
@@ -0,0 +1,3 @@
1
+ export * from './client';
2
+ export * from './api-model/api';
3
+ export * from './api-model/models';
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "@sp-api-sdk/easy-ship-api-2022-03-23",
3
+ "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
+ "description": "The Selling Partner API for Easy Ship helps you build applications that help sellers manage and ship Amazon Easy Ship orders. Your Easy Ship applications can: Get available time slots for packages to be scheduled for delivery. Schedule, reschedule, and cancel Easy Ship orders. Print labels, invoices, and warranties. See the Marketplace Support Table for the differences in Easy Ship operations by marketplace.",
5
+ "version": "3.0.0",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/es/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "license": "MIT",
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "directories": {
14
+ "lib": "dist"
15
+ },
16
+ "files": [
17
+ "dist/**/*.js",
18
+ "dist/**/*.d.ts"
19
+ ],
20
+ "dependencies": {
21
+ "@sp-api-sdk/common": "2.1.7",
22
+ "axios": "^1.7.9"
23
+ },
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "https://github.com/bizon/selling-partner-api-sdk.git",
27
+ "directory": "clients/easy-ship-api-2022-03-23"
28
+ },
29
+ "bugs": {
30
+ "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
31
+ },
32
+ "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/easy-ship-api-2022-03-23",
33
+ "keywords": [
34
+ "amazon",
35
+ "bizon",
36
+ "marketplace web services",
37
+ "mws",
38
+ "selling partner api",
39
+ "sp api",
40
+ "sp sdk",
41
+ "easy ship api"
42
+ ],
43
+ "gitHead": "14dc1de3723e34f66b078e05f9c7044b22a46c43"
44
+ }