@zippendo/sdk 1.3.7 → 1.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/dist/apis/BrandsApi.d.ts +2 -2
  2. package/dist/apis/BrandsApi.js +2 -2
  3. package/dist/apis/CarriersApi.d.ts +2 -2
  4. package/dist/apis/CarriersApi.js +2 -2
  5. package/dist/apis/ShipmentsApi.d.ts +6 -6
  6. package/dist/apis/ShipmentsApi.js +6 -6
  7. package/dist/esm/apis/BrandsApi.d.ts +2 -2
  8. package/dist/esm/apis/BrandsApi.js +2 -2
  9. package/dist/esm/apis/CarriersApi.d.ts +2 -2
  10. package/dist/esm/apis/CarriersApi.js +2 -2
  11. package/dist/esm/apis/ShipmentsApi.d.ts +6 -6
  12. package/dist/esm/apis/ShipmentsApi.js +6 -6
  13. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -2
  14. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +2 -0
  15. package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
  16. package/dist/esm/models/BatchSendShipmentsRequest.d.ts +1 -1
  17. package/dist/esm/models/CreateOrder201Response.d.ts +1 -1
  18. package/dist/esm/models/CreateOrder201ResponseShippingAddress.d.ts +3 -3
  19. package/dist/esm/models/CreateOrderChannelRequest.d.ts +1 -1
  20. package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +1 -1
  21. package/dist/esm/models/CreateOrderRequestShippingAddress.d.ts +3 -3
  22. package/dist/esm/models/CreateOrgBrandRequest.d.ts +2 -2
  23. package/dist/esm/models/CreateShipment201Response.d.ts +1 -1
  24. package/dist/esm/models/CreateShipmentRequest.d.ts +1 -1
  25. package/dist/esm/models/CreateShippingRule201Response.d.ts +3 -3
  26. package/dist/esm/models/CreateShippingRuleRequest.d.ts +3 -3
  27. package/dist/esm/models/GetBillingUsage200ResponseZippyCredits.d.ts +1 -1
  28. package/dist/esm/models/GetOrder200Response.d.ts +1 -1
  29. package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +2 -2
  30. package/dist/esm/models/ListApiTokens401Response.d.ts +2 -0
  31. package/dist/esm/models/ListApiTokens401Response.js +2 -0
  32. package/dist/esm/models/ListCarrierProducts200ResponseInner.d.ts +4 -4
  33. package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +1 -1
  34. package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +1 -1
  35. package/dist/esm/models/ListOrders200ResponseDataInner.d.ts +1 -1
  36. package/dist/esm/models/ListOrgBrands200ResponseDataInner.d.ts +2 -2
  37. package/dist/esm/models/ListShippingRules200ResponseDataInner.d.ts +3 -3
  38. package/dist/esm/models/SendShipment422Response.d.ts +3 -1
  39. package/dist/esm/models/SendShipment422Response.js +2 -0
  40. package/dist/esm/models/UpdateOrderChannelRequest.d.ts +1 -1
  41. package/dist/esm/models/UpdateOrderRequest.d.ts +2 -2
  42. package/dist/esm/models/UpdateOrgBrandRequest.d.ts +2 -2
  43. package/dist/esm/models/UpdateShipmentRequest.d.ts +1 -1
  44. package/dist/esm/models/UpdateShipmentRequestDroppoint.d.ts +1 -1
  45. package/dist/esm/models/UpdateShippingRuleRequest.d.ts +3 -3
  46. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -2
  47. package/dist/models/BatchSendShipments200ResponseResultsInner.js +2 -0
  48. package/dist/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
  49. package/dist/models/BatchSendShipmentsRequest.d.ts +1 -1
  50. package/dist/models/CreateOrder201Response.d.ts +1 -1
  51. package/dist/models/CreateOrder201ResponseShippingAddress.d.ts +3 -3
  52. package/dist/models/CreateOrderChannelRequest.d.ts +1 -1
  53. package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +1 -1
  54. package/dist/models/CreateOrderRequestShippingAddress.d.ts +3 -3
  55. package/dist/models/CreateOrgBrandRequest.d.ts +2 -2
  56. package/dist/models/CreateShipment201Response.d.ts +1 -1
  57. package/dist/models/CreateShipmentRequest.d.ts +1 -1
  58. package/dist/models/CreateShippingRule201Response.d.ts +3 -3
  59. package/dist/models/CreateShippingRuleRequest.d.ts +3 -3
  60. package/dist/models/GetBillingUsage200ResponseZippyCredits.d.ts +1 -1
  61. package/dist/models/GetOrder200Response.d.ts +1 -1
  62. package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +2 -2
  63. package/dist/models/ListApiTokens401Response.d.ts +2 -0
  64. package/dist/models/ListApiTokens401Response.js +2 -0
  65. package/dist/models/ListCarrierProducts200ResponseInner.d.ts +4 -4
  66. package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +1 -1
  67. package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +1 -1
  68. package/dist/models/ListOrders200ResponseDataInner.d.ts +1 -1
  69. package/dist/models/ListOrgBrands200ResponseDataInner.d.ts +2 -2
  70. package/dist/models/ListShippingRules200ResponseDataInner.d.ts +3 -3
  71. package/dist/models/SendShipment422Response.d.ts +3 -1
  72. package/dist/models/SendShipment422Response.js +2 -0
  73. package/dist/models/UpdateOrderChannelRequest.d.ts +1 -1
  74. package/dist/models/UpdateOrderRequest.d.ts +2 -2
  75. package/dist/models/UpdateOrgBrandRequest.d.ts +2 -2
  76. package/dist/models/UpdateShipmentRequest.d.ts +1 -1
  77. package/dist/models/UpdateShipmentRequestDroppoint.d.ts +1 -1
  78. package/dist/models/UpdateShippingRuleRequest.d.ts +3 -3
  79. package/docs/BrandsApi.md +1 -1
  80. package/docs/CarriersApi.md +1 -1
  81. package/docs/GetBillingUsage200ResponseZippyCredits.md +1 -1
  82. package/docs/OrdersApi.md +2 -2
  83. package/docs/ShipmentsApi.md +3 -3
  84. package/docs/UpdateShipmentRequestDroppoint.md +1 -1
  85. package/package.json +1 -1
  86. package/src/apis/BrandsApi.ts +2 -2
  87. package/src/apis/CarriersApi.ts +2 -2
  88. package/src/apis/ShipmentsApi.ts +6 -6
  89. package/src/models/BatchSendShipments200ResponseResultsInner.ts +4 -2
  90. package/src/models/BatchSendShipments200ResponseSummary.ts +1 -1
  91. package/src/models/BatchSendShipmentsRequest.ts +1 -1
  92. package/src/models/CreateOrder201Response.ts +1 -1
  93. package/src/models/CreateOrder201ResponseShippingAddress.ts +3 -3
  94. package/src/models/CreateOrderChannelRequest.ts +1 -1
  95. package/src/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.ts +1 -1
  96. package/src/models/CreateOrderRequestShippingAddress.ts +3 -3
  97. package/src/models/CreateOrgBrandRequest.ts +2 -2
  98. package/src/models/CreateShipment201Response.ts +1 -1
  99. package/src/models/CreateShipmentRequest.ts +1 -1
  100. package/src/models/CreateShippingRule201Response.ts +3 -3
  101. package/src/models/CreateShippingRuleRequest.ts +3 -3
  102. package/src/models/GetBillingUsage200ResponseZippyCredits.ts +1 -1
  103. package/src/models/GetOrder200Response.ts +1 -1
  104. package/src/models/GetOrder200ResponseShipmentsInner.ts +2 -2
  105. package/src/models/ListApiTokens401Response.ts +2 -0
  106. package/src/models/ListCarrierProducts200ResponseInner.ts +4 -4
  107. package/src/models/ListOrderChannels200ResponseDataInner.ts +1 -1
  108. package/src/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.ts +1 -1
  109. package/src/models/ListOrders200ResponseDataInner.ts +1 -1
  110. package/src/models/ListOrgBrands200ResponseDataInner.ts +2 -2
  111. package/src/models/ListShippingRules200ResponseDataInner.ts +3 -3
  112. package/src/models/SendShipment422Response.ts +3 -1
  113. package/src/models/UpdateOrderChannelRequest.ts +1 -1
  114. package/src/models/UpdateOrderRequest.ts +2 -2
  115. package/src/models/UpdateOrgBrandRequest.ts +2 -2
  116. package/src/models/UpdateShipmentRequest.ts +1 -1
  117. package/src/models/UpdateShipmentRequestDroppoint.ts +1 -1
  118. package/src/models/UpdateShippingRuleRequest.ts +3 -3
@@ -47,6 +47,8 @@ export const ListApiTokens401ResponseCodeEnum = {
47
47
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
48
48
  OrgDisabled: 'ORG_DISABLED',
49
49
  OrgSlugExists: 'ORG_SLUG_EXISTS',
50
+ SetupNotFound: 'SETUP_NOT_FOUND',
51
+ SetupExists: 'SETUP_EXISTS',
50
52
  BrandNotFound: 'BRAND_NOT_FOUND',
51
53
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
52
54
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -19,7 +19,7 @@ import type { ListCarrierProducts200ResponseInnerServicesInner } from './ListCar
19
19
  */
20
20
  export interface ListCarrierProducts200ResponseInner {
21
21
  /**
22
- * Display name of the shipping product
22
+ * Display name of the carrier product
23
23
  * @type {string}
24
24
  * @memberof ListCarrierProducts200ResponseInner
25
25
  */
@@ -37,13 +37,13 @@ export interface ListCarrierProducts200ResponseInner {
37
37
  */
38
38
  type: ListCarrierProducts200ResponseInnerTypeEnum;
39
39
  /**
40
- * Description of the shipping product
40
+ * Description of the carrier product
41
41
  * @type {string}
42
42
  * @memberof ListCarrierProducts200ResponseInner
43
43
  */
44
44
  description?: string;
45
45
  /**
46
- * Recipient countries supported by this product
46
+ * Receiver countries this product delivers to
47
47
  * @type {Array<string>}
48
48
  * @memberof ListCarrierProducts200ResponseInner
49
49
  */
@@ -55,7 +55,7 @@ export interface ListCarrierProducts200ResponseInner {
55
55
  */
56
56
  availableSenderCountries: Array<string>;
57
57
  /**
58
- * Whether delivery is to a service point/pickup location
58
+ * Whether this product delivers to a service point
59
59
  * @type {boolean}
60
60
  * @memberof ListCarrierProducts200ResponseInner
61
61
  */
@@ -41,7 +41,7 @@ export interface ListOrderChannels200ResponseDataInner {
41
41
  */
42
42
  enabled: boolean;
43
43
  /**
44
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
44
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
45
45
  * @type {ListOrderChannels200ResponseDataInnerRoleEnum}
46
46
  * @memberof ListOrderChannels200ResponseDataInner
47
47
  */
@@ -28,7 +28,7 @@ export interface ListOrderChannels200ResponseDataInnerSettingsShippingMethodMapp
28
28
  */
29
29
  shippingRuleId: string;
30
30
  /**
31
- * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection.
31
+ * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the receiver's address; 'manual' keeps the shipment in draft for manual selection.
32
32
  * @type {ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
33
33
  * @memberof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
34
34
  */
@@ -41,7 +41,7 @@ export interface ListOrders200ResponseDataInner {
41
41
  */
42
42
  customerEmail?: string | null;
43
43
  /**
44
- * Order fulfilment status derived from its shipments.
44
+ * Order fulfillment status derived from its shipments.
45
45
  * @type {ListOrders200ResponseDataInnerStatusEnum}
46
46
  * @memberof ListOrders200ResponseDataInner
47
47
  */
@@ -66,13 +66,13 @@ export interface ListOrgBrands200ResponseDataInner {
66
66
  */
67
67
  country?: string | null;
68
68
  /**
69
- * Primary brand colour — document title and table headers
69
+ * Primary brand color — document title and table headers
70
70
  * @type {string}
71
71
  * @memberof ListOrgBrands200ResponseDataInner
72
72
  */
73
73
  primaryColor?: string | null;
74
74
  /**
75
- * Secondary brand colour — subtitle, section headings, totals accent
75
+ * Secondary brand color — subtitle, section headings, totals accent
76
76
  * @type {string}
77
77
  * @memberof ListOrgBrands200ResponseDataInner
78
78
  */
@@ -84,13 +84,13 @@ export interface ListShippingRules200ResponseDataInner {
84
84
  */
85
85
  receivingCountries: Array<string>;
86
86
  /**
87
- * Send email notification to recipient
87
+ * Send an email notification to the receiver
88
88
  * @type {boolean}
89
89
  * @memberof ListShippingRules200ResponseDataInner
90
90
  */
91
91
  emailNotification: boolean;
92
92
  /**
93
- * Send SMS notification to recipient
93
+ * Send an SMS notification to the receiver
94
94
  * @type {boolean}
95
95
  * @memberof ListShippingRules200ResponseDataInner
96
96
  */
@@ -138,7 +138,7 @@ export interface ListShippingRules200ResponseDataInner {
138
138
  */
139
139
  generateCommercialInvoice: boolean;
140
140
  /**
141
- * Generate packing slip with package and item details
141
+ * Generate a packing slip with parcel and item details
142
142
  * @type {boolean}
143
143
  * @memberof ListShippingRules200ResponseDataInner
144
144
  */
@@ -35,7 +35,7 @@ export interface SendShipment422Response {
35
35
  */
36
36
  message: string;
37
37
  /**
38
- * Detailed carrier errors that caused the booking to fail.
38
+ * Detailed carrier errors that made sending fail.
39
39
  * @type {Array<SendShipment422ResponseErrorsInner>}
40
40
  * @memberof SendShipment422Response
41
41
  */
@@ -77,6 +77,8 @@ export declare const SendShipment422ResponseCodeEnum: {
77
77
  readonly OrgAccessDenied: "ORG_ACCESS_DENIED";
78
78
  readonly OrgDisabled: "ORG_DISABLED";
79
79
  readonly OrgSlugExists: "ORG_SLUG_EXISTS";
80
+ readonly SetupNotFound: "SETUP_NOT_FOUND";
81
+ readonly SetupExists: "SETUP_EXISTS";
80
82
  readonly BrandNotFound: "BRAND_NOT_FOUND";
81
83
  readonly BrandAccessDenied: "BRAND_ACCESS_DENIED";
82
84
  readonly BrandSlugExists: "BRAND_SLUG_EXISTS";
@@ -48,6 +48,8 @@ export const SendShipment422ResponseCodeEnum = {
48
48
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
49
49
  OrgDisabled: 'ORG_DISABLED',
50
50
  OrgSlugExists: 'ORG_SLUG_EXISTS',
51
+ SetupNotFound: 'SETUP_NOT_FOUND',
52
+ SetupExists: 'SETUP_EXISTS',
51
53
  BrandNotFound: 'BRAND_NOT_FOUND',
52
54
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
53
55
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -35,7 +35,7 @@ export interface UpdateOrderChannelRequest {
35
35
  */
36
36
  enabled?: boolean;
37
37
  /**
38
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
38
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
39
39
  * @type {UpdateOrderChannelRequestRoleEnum}
40
40
  * @memberof UpdateOrderChannelRequest
41
41
  */
@@ -72,7 +72,7 @@ export interface UpdateOrderRequest {
72
72
  */
73
73
  notes?: string | null;
74
74
  /**
75
- * Order fulfilment status derived from its shipments.
75
+ * Order fulfillment status derived from its shipments.
76
76
  * @type {UpdateOrderRequestStatusEnum}
77
77
  * @memberof UpdateOrderRequest
78
78
  */
@@ -84,7 +84,7 @@ export interface UpdateOrderRequest {
84
84
  */
85
85
  shippingRuleId?: string | null;
86
86
  /**
87
- * Service point (parcel shop) ID to apply to unsent outbound shipments.
87
+ * Service point ID to apply to unsent outbound shipments.
88
88
  * @type {string}
89
89
  * @memberof UpdateOrderRequest
90
90
  */
@@ -66,13 +66,13 @@ export interface UpdateOrgBrandRequest {
66
66
  */
67
67
  country?: string | null;
68
68
  /**
69
- * Primary brand colour — document title and table headers
69
+ * Primary brand color — document title and table headers
70
70
  * @type {string}
71
71
  * @memberof UpdateOrgBrandRequest
72
72
  */
73
73
  primaryColor?: string | null;
74
74
  /**
75
- * Secondary brand colour — subtitle, section headings, totals accent
75
+ * Secondary brand color — subtitle, section headings, totals accent
76
76
  * @type {string}
77
77
  * @memberof UpdateOrgBrandRequest
78
78
  */
@@ -33,7 +33,7 @@ export interface UpdateShipmentRequest {
33
33
  */
34
34
  addressId?: string | null;
35
35
  /**
36
- * Selected carrier service point identifier.
36
+ * Selected service point ID.
37
37
  * @type {string}
38
38
  * @memberof UpdateShipmentRequest
39
39
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
13
13
  /**
14
- * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace the stored droppoint).
14
+ * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace it).
15
15
  * @export
16
16
  * @interface UpdateShipmentRequestDroppoint
17
17
  */
@@ -74,13 +74,13 @@ export interface UpdateShippingRuleRequest {
74
74
  */
75
75
  receivingCountries?: Array<string>;
76
76
  /**
77
- * Send email notification to recipient
77
+ * Send an email notification to the receiver
78
78
  * @type {boolean}
79
79
  * @memberof UpdateShippingRuleRequest
80
80
  */
81
81
  emailNotification?: boolean;
82
82
  /**
83
- * Send SMS notification to recipient
83
+ * Send an SMS notification to the receiver
84
84
  * @type {boolean}
85
85
  * @memberof UpdateShippingRuleRequest
86
86
  */
@@ -128,7 +128,7 @@ export interface UpdateShippingRuleRequest {
128
128
  */
129
129
  generateCommercialInvoice?: boolean;
130
130
  /**
131
- * Generate packing slip with package and item details
131
+ * Generate a packing slip with parcel and item details
132
132
  * @type {boolean}
133
133
  * @memberof UpdateShippingRuleRequest
134
134
  */
@@ -23,7 +23,7 @@ export interface BatchSendShipments200ResponseResultsInner {
23
23
  */
24
24
  shipmentId: string;
25
25
  /**
26
- * `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
26
+ * `sent` when the carrier accepted it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
27
27
  * @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
28
28
  * @memberof BatchSendShipments200ResponseResultsInner
29
29
  */
@@ -41,7 +41,7 @@ export interface BatchSendShipments200ResponseResultsInner {
41
41
  */
42
42
  message?: string;
43
43
  /**
44
- * Carrier-specific errors, present when the carrier rejected the booking.
44
+ * Carrier-specific errors, present when the carrier rejected the shipment.
45
45
  * @type {Array<SendShipment422ResponseErrorsInner>}
46
46
  * @memberof BatchSendShipments200ResponseResultsInner
47
47
  */
@@ -92,6 +92,8 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
92
92
  readonly OrgAccessDenied: "ORG_ACCESS_DENIED";
93
93
  readonly OrgDisabled: "ORG_DISABLED";
94
94
  readonly OrgSlugExists: "ORG_SLUG_EXISTS";
95
+ readonly SetupNotFound: "SETUP_NOT_FOUND";
96
+ readonly SetupExists: "SETUP_EXISTS";
95
97
  readonly BrandNotFound: "BRAND_NOT_FOUND";
96
98
  readonly BrandAccessDenied: "BRAND_ACCESS_DENIED";
97
99
  readonly BrandSlugExists: "BRAND_SLUG_EXISTS";
@@ -64,6 +64,8 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
64
64
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
65
65
  OrgDisabled: 'ORG_DISABLED',
66
66
  OrgSlugExists: 'ORG_SLUG_EXISTS',
67
+ SetupNotFound: 'SETUP_NOT_FOUND',
68
+ SetupExists: 'SETUP_EXISTS',
67
69
  BrandNotFound: 'BRAND_NOT_FOUND',
68
70
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
69
71
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -22,7 +22,7 @@ export interface BatchSendShipments200ResponseSummary {
22
22
  */
23
23
  total: number;
24
24
  /**
25
- * How many were successfully booked.
25
+ * How many were sent successfully.
26
26
  * @type {number}
27
27
  * @memberof BatchSendShipments200ResponseSummary
28
28
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface BatchSendShipmentsRequest {
18
18
  /**
19
- * IDs of the shipments to book. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request.
19
+ * IDs of the shipments to send. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request.
20
20
  * @type {Array<string>}
21
21
  * @memberof BatchSendShipmentsRequest
22
22
  */
@@ -78,7 +78,7 @@ export interface CreateOrder201Response {
78
78
  */
79
79
  currency?: string | null;
80
80
  /**
81
- * Order fulfilment status derived from its shipments.
81
+ * Order fulfillment status derived from its shipments.
82
82
  * @type {CreateOrder201ResponseStatusEnum}
83
83
  * @memberof CreateOrder201Response
84
84
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CreateOrder201ResponseShippingAddress {
18
18
  /**
19
- * Recipient full name.
19
+ * Receiver full name.
20
20
  * @type {string}
21
21
  * @memberof CreateOrder201ResponseShippingAddress
22
22
  */
@@ -82,13 +82,13 @@ export interface CreateOrder201ResponseShippingAddress {
82
82
  */
83
83
  countryCode: string;
84
84
  /**
85
- * Recipient phone number.
85
+ * Receiver phone number.
86
86
  * @type {string}
87
87
  * @memberof CreateOrder201ResponseShippingAddress
88
88
  */
89
89
  phone?: string | null;
90
90
  /**
91
- * Recipient email address.
91
+ * Receiver email address.
92
92
  * @type {string}
93
93
  * @memberof CreateOrder201ResponseShippingAddress
94
94
  */
@@ -41,7 +41,7 @@ export interface CreateOrderChannelRequest {
41
41
  */
42
42
  enabled?: boolean;
43
43
  /**
44
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
44
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
45
45
  * @type {CreateOrderChannelRequestRoleEnum}
46
46
  * @memberof CreateOrderChannelRequest
47
47
  */
@@ -28,7 +28,7 @@ export interface CreateOrderChannelRequestSettingsShippingMethodMappingsInner {
28
28
  */
29
29
  shippingRuleId: string;
30
30
  /**
31
- * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection.
31
+ * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the receiver's address; 'manual' keeps the shipment in draft for manual selection.
32
32
  * @type {CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
33
33
  * @memberof CreateOrderChannelRequestSettingsShippingMethodMappingsInner
34
34
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CreateOrderRequestShippingAddress {
18
18
  /**
19
- * Recipient full name.
19
+ * Receiver full name.
20
20
  * @type {string}
21
21
  * @memberof CreateOrderRequestShippingAddress
22
22
  */
@@ -82,13 +82,13 @@ export interface CreateOrderRequestShippingAddress {
82
82
  */
83
83
  countryCode: string;
84
84
  /**
85
- * Recipient phone number.
85
+ * Receiver phone number.
86
86
  * @type {string}
87
87
  * @memberof CreateOrderRequestShippingAddress
88
88
  */
89
89
  phone?: string | null;
90
90
  /**
91
- * Recipient email address.
91
+ * Receiver email address.
92
92
  * @type {string}
93
93
  * @memberof CreateOrderRequestShippingAddress
94
94
  */
@@ -66,13 +66,13 @@ export interface CreateOrgBrandRequest {
66
66
  */
67
67
  country?: string | null;
68
68
  /**
69
- * Primary brand colour — document title and table headers
69
+ * Primary brand color — document title and table headers
70
70
  * @type {string}
71
71
  * @memberof CreateOrgBrandRequest
72
72
  */
73
73
  primaryColor?: string | null;
74
74
  /**
75
- * Secondary brand colour — subtitle, section headings, totals accent
75
+ * Secondary brand color — subtitle, section headings, totals accent
76
76
  * @type {string}
77
77
  * @memberof CreateOrgBrandRequest
78
78
  */
@@ -44,7 +44,7 @@ export interface CreateShipment201Response {
44
44
  */
45
45
  addressId?: string | null;
46
46
  /**
47
- * Selected carrier service point identifier.
47
+ * Selected service point ID.
48
48
  * @type {string}
49
49
  * @memberof CreateShipment201Response
50
50
  */
@@ -33,7 +33,7 @@ export interface CreateShipmentRequest {
33
33
  */
34
34
  addressId?: string | null;
35
35
  /**
36
- * Selected carrier service point identifier.
36
+ * Selected service point ID.
37
37
  * @type {string}
38
38
  * @memberof CreateShipmentRequest
39
39
  */
@@ -80,13 +80,13 @@ export interface CreateShippingRule201Response {
80
80
  */
81
81
  receivingCountries: Array<string>;
82
82
  /**
83
- * Send email notification to recipient
83
+ * Send an email notification to the receiver
84
84
  * @type {boolean}
85
85
  * @memberof CreateShippingRule201Response
86
86
  */
87
87
  emailNotification: boolean;
88
88
  /**
89
- * Send SMS notification to recipient
89
+ * Send an SMS notification to the receiver
90
90
  * @type {boolean}
91
91
  * @memberof CreateShippingRule201Response
92
92
  */
@@ -134,7 +134,7 @@ export interface CreateShippingRule201Response {
134
134
  */
135
135
  generateCommercialInvoice: boolean;
136
136
  /**
137
- * Generate packing slip with package and item details
137
+ * Generate a packing slip with parcel and item details
138
138
  * @type {boolean}
139
139
  * @memberof CreateShippingRule201Response
140
140
  */
@@ -74,13 +74,13 @@ export interface CreateShippingRuleRequest {
74
74
  */
75
75
  receivingCountries: Array<string>;
76
76
  /**
77
- * Send email notification to recipient
77
+ * Send an email notification to the receiver
78
78
  * @type {boolean}
79
79
  * @memberof CreateShippingRuleRequest
80
80
  */
81
81
  emailNotification?: boolean;
82
82
  /**
83
- * Send SMS notification to recipient
83
+ * Send an SMS notification to the receiver
84
84
  * @type {boolean}
85
85
  * @memberof CreateShippingRuleRequest
86
86
  */
@@ -128,7 +128,7 @@ export interface CreateShippingRuleRequest {
128
128
  */
129
129
  generateCommercialInvoice?: boolean;
130
130
  /**
131
- * Generate packing slip with package and item details
131
+ * Generate a packing slip with parcel and item details
132
132
  * @type {boolean}
133
133
  * @memberof CreateShippingRuleRequest
134
134
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Zippy AI credit usage this period (present when the Zippy add-on is enabled)
13
+ * Zippy credit usage this period (present when the Zippy add-on is enabled)
14
14
  * @export
15
15
  * @interface GetBillingUsage200ResponseZippyCredits
16
16
  */
@@ -81,7 +81,7 @@ export interface GetOrder200Response {
81
81
  */
82
82
  currency?: string | null;
83
83
  /**
84
- * Order fulfilment status derived from its shipments.
84
+ * Order fulfillment status derived from its shipments.
85
85
  * @type {GetOrder200ResponseStatusEnum}
86
86
  * @memberof GetOrder200Response
87
87
  */
@@ -56,7 +56,7 @@ export interface GetOrder200ResponseShipmentsInner {
56
56
  */
57
57
  carrierSettings: ListShipments200ResponseDataInnerCarrierSettings;
58
58
  /**
59
- * Selected carrier service point identifier.
59
+ * Selected service point ID.
60
60
  * @type {string}
61
61
  * @memberof GetOrder200ResponseShipmentsInner
62
62
  */
@@ -86,7 +86,7 @@ export interface GetOrder200ResponseShipmentsInner {
86
86
  */
87
87
  documents?: Array<CreateShipment201ResponseDocumentsInner>;
88
88
  /**
89
- * Compact parcels for the order fulfillment workspace (no QR/label payloads).
89
+ * Compact parcels for the order's fulfillment view (no QR/label payloads).
90
90
  * @type {Array<GetOrder200ResponseShipmentsInnerParcelsInner>}
91
91
  * @memberof GetOrder200ResponseShipmentsInner
92
92
  */
@@ -70,6 +70,8 @@ export declare const ListApiTokens401ResponseCodeEnum: {
70
70
  readonly OrgAccessDenied: "ORG_ACCESS_DENIED";
71
71
  readonly OrgDisabled: "ORG_DISABLED";
72
72
  readonly OrgSlugExists: "ORG_SLUG_EXISTS";
73
+ readonly SetupNotFound: "SETUP_NOT_FOUND";
74
+ readonly SetupExists: "SETUP_EXISTS";
73
75
  readonly BrandNotFound: "BRAND_NOT_FOUND";
74
76
  readonly BrandAccessDenied: "BRAND_ACCESS_DENIED";
75
77
  readonly BrandSlugExists: "BRAND_SLUG_EXISTS";
@@ -55,6 +55,8 @@ exports.ListApiTokens401ResponseCodeEnum = {
55
55
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
56
56
  OrgDisabled: 'ORG_DISABLED',
57
57
  OrgSlugExists: 'ORG_SLUG_EXISTS',
58
+ SetupNotFound: 'SETUP_NOT_FOUND',
59
+ SetupExists: 'SETUP_EXISTS',
58
60
  BrandNotFound: 'BRAND_NOT_FOUND',
59
61
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
60
62
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -19,7 +19,7 @@ import type { ListCarrierProducts200ResponseInnerServicesInner } from './ListCar
19
19
  */
20
20
  export interface ListCarrierProducts200ResponseInner {
21
21
  /**
22
- * Display name of the shipping product
22
+ * Display name of the carrier product
23
23
  * @type {string}
24
24
  * @memberof ListCarrierProducts200ResponseInner
25
25
  */
@@ -37,13 +37,13 @@ export interface ListCarrierProducts200ResponseInner {
37
37
  */
38
38
  type: ListCarrierProducts200ResponseInnerTypeEnum;
39
39
  /**
40
- * Description of the shipping product
40
+ * Description of the carrier product
41
41
  * @type {string}
42
42
  * @memberof ListCarrierProducts200ResponseInner
43
43
  */
44
44
  description?: string;
45
45
  /**
46
- * Recipient countries supported by this product
46
+ * Receiver countries this product delivers to
47
47
  * @type {Array<string>}
48
48
  * @memberof ListCarrierProducts200ResponseInner
49
49
  */
@@ -55,7 +55,7 @@ export interface ListCarrierProducts200ResponseInner {
55
55
  */
56
56
  availableSenderCountries: Array<string>;
57
57
  /**
58
- * Whether delivery is to a service point/pickup location
58
+ * Whether this product delivers to a service point
59
59
  * @type {boolean}
60
60
  * @memberof ListCarrierProducts200ResponseInner
61
61
  */
@@ -41,7 +41,7 @@ export interface ListOrderChannels200ResponseDataInner {
41
41
  */
42
42
  enabled: boolean;
43
43
  /**
44
- * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfilment or tracking is pushed back to the platform.
44
+ * What Zippendo is used for on this channel. `orders_and_rates` (default) imports orders and serves checkout rates. `rates_only` serves checkout rates and service-point selection ONLY — orders are owned by an external system such as a WMS, nothing is imported, and no fulfillment or tracking is pushed back to the platform.
45
45
  * @type {ListOrderChannels200ResponseDataInnerRoleEnum}
46
46
  * @memberof ListOrderChannels200ResponseDataInner
47
47
  */
@@ -28,7 +28,7 @@ export interface ListOrderChannels200ResponseDataInnerSettingsShippingMethodMapp
28
28
  */
29
29
  shippingRuleId: string;
30
30
  /**
31
- * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection.
31
+ * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the receiver's address; 'manual' keeps the shipment in draft for manual selection.
32
32
  * @type {ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
33
33
  * @memberof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
34
34
  */
@@ -41,7 +41,7 @@ export interface ListOrders200ResponseDataInner {
41
41
  */
42
42
  customerEmail?: string | null;
43
43
  /**
44
- * Order fulfilment status derived from its shipments.
44
+ * Order fulfillment status derived from its shipments.
45
45
  * @type {ListOrders200ResponseDataInnerStatusEnum}
46
46
  * @memberof ListOrders200ResponseDataInner
47
47
  */
@@ -66,13 +66,13 @@ export interface ListOrgBrands200ResponseDataInner {
66
66
  */
67
67
  country?: string | null;
68
68
  /**
69
- * Primary brand colour — document title and table headers
69
+ * Primary brand color — document title and table headers
70
70
  * @type {string}
71
71
  * @memberof ListOrgBrands200ResponseDataInner
72
72
  */
73
73
  primaryColor?: string | null;
74
74
  /**
75
- * Secondary brand colour — subtitle, section headings, totals accent
75
+ * Secondary brand color — subtitle, section headings, totals accent
76
76
  * @type {string}
77
77
  * @memberof ListOrgBrands200ResponseDataInner
78
78
  */
@@ -84,13 +84,13 @@ export interface ListShippingRules200ResponseDataInner {
84
84
  */
85
85
  receivingCountries: Array<string>;
86
86
  /**
87
- * Send email notification to recipient
87
+ * Send an email notification to the receiver
88
88
  * @type {boolean}
89
89
  * @memberof ListShippingRules200ResponseDataInner
90
90
  */
91
91
  emailNotification: boolean;
92
92
  /**
93
- * Send SMS notification to recipient
93
+ * Send an SMS notification to the receiver
94
94
  * @type {boolean}
95
95
  * @memberof ListShippingRules200ResponseDataInner
96
96
  */
@@ -138,7 +138,7 @@ export interface ListShippingRules200ResponseDataInner {
138
138
  */
139
139
  generateCommercialInvoice: boolean;
140
140
  /**
141
- * Generate packing slip with package and item details
141
+ * Generate a packing slip with parcel and item details
142
142
  * @type {boolean}
143
143
  * @memberof ListShippingRules200ResponseDataInner
144
144
  */