@zippendo/sdk 1.3.6 → 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
@@ -32,7 +32,7 @@ export interface ListOrderChannels200ResponseDataInnerSettingsShippingMethodMapp
32
32
  */
33
33
  shippingRuleId: string;
34
34
  /**
35
- * 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.
35
+ * 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.
36
36
  * @type {ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
37
37
  * @memberof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
38
38
  */
@@ -52,7 +52,7 @@ export interface ListOrders200ResponseDataInner {
52
52
  */
53
53
  customerEmail?: string | null;
54
54
  /**
55
- * Order fulfilment status derived from its shipments.
55
+ * Order fulfillment status derived from its shipments.
56
56
  * @type {ListOrders200ResponseDataInnerStatusEnum}
57
57
  * @memberof ListOrders200ResponseDataInner
58
58
  */
@@ -68,13 +68,13 @@ export interface ListOrgBrands200ResponseDataInner {
68
68
  */
69
69
  country?: string | null;
70
70
  /**
71
- * Primary brand colour — document title and table headers
71
+ * Primary brand color — document title and table headers
72
72
  * @type {string}
73
73
  * @memberof ListOrgBrands200ResponseDataInner
74
74
  */
75
75
  primaryColor?: string | null;
76
76
  /**
77
- * Secondary brand colour — subtitle, section headings, totals accent
77
+ * Secondary brand color — subtitle, section headings, totals accent
78
78
  * @type {string}
79
79
  * @memberof ListOrgBrands200ResponseDataInner
80
80
  */
@@ -123,13 +123,13 @@ export interface ListShippingRules200ResponseDataInner {
123
123
  */
124
124
  receivingCountries: Array<string>;
125
125
  /**
126
- * Send email notification to recipient
126
+ * Send an email notification to the receiver
127
127
  * @type {boolean}
128
128
  * @memberof ListShippingRules200ResponseDataInner
129
129
  */
130
130
  emailNotification: boolean;
131
131
  /**
132
- * Send SMS notification to recipient
132
+ * Send an SMS notification to the receiver
133
133
  * @type {boolean}
134
134
  * @memberof ListShippingRules200ResponseDataInner
135
135
  */
@@ -177,7 +177,7 @@ export interface ListShippingRules200ResponseDataInner {
177
177
  */
178
178
  generateCommercialInvoice: boolean;
179
179
  /**
180
- * Generate packing slip with package and item details
180
+ * Generate a packing slip with parcel and item details
181
181
  * @type {boolean}
182
182
  * @memberof ListShippingRules200ResponseDataInner
183
183
  */
@@ -46,7 +46,7 @@ export interface SendShipment422Response {
46
46
  */
47
47
  message: string;
48
48
  /**
49
- * Detailed carrier errors that caused the booking to fail.
49
+ * Detailed carrier errors that made sending fail.
50
50
  * @type {Array<SendShipment422ResponseErrorsInner>}
51
51
  * @memberof SendShipment422Response
52
52
  */
@@ -90,6 +90,8 @@ export const SendShipment422ResponseCodeEnum = {
90
90
  OrgAccessDenied: 'ORG_ACCESS_DENIED',
91
91
  OrgDisabled: 'ORG_DISABLED',
92
92
  OrgSlugExists: 'ORG_SLUG_EXISTS',
93
+ SetupNotFound: 'SETUP_NOT_FOUND',
94
+ SetupExists: 'SETUP_EXISTS',
93
95
  BrandNotFound: 'BRAND_NOT_FOUND',
94
96
  BrandAccessDenied: 'BRAND_ACCESS_DENIED',
95
97
  BrandSlugExists: 'BRAND_SLUG_EXISTS',
@@ -46,7 +46,7 @@ export interface UpdateOrderChannelRequest {
46
46
  */
47
47
  enabled?: boolean;
48
48
  /**
49
- * 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.
49
+ * 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.
50
50
  * @type {UpdateOrderChannelRequestRoleEnum}
51
51
  * @memberof UpdateOrderChannelRequest
52
52
  */
@@ -89,7 +89,7 @@ export interface UpdateOrderRequest {
89
89
  */
90
90
  notes?: string | null;
91
91
  /**
92
- * Order fulfilment status derived from its shipments.
92
+ * Order fulfillment status derived from its shipments.
93
93
  * @type {UpdateOrderRequestStatusEnum}
94
94
  * @memberof UpdateOrderRequest
95
95
  */
@@ -101,7 +101,7 @@ export interface UpdateOrderRequest {
101
101
  */
102
102
  shippingRuleId?: string | null;
103
103
  /**
104
- * Service point (parcel shop) ID to apply to unsent outbound shipments.
104
+ * Service point ID to apply to unsent outbound shipments.
105
105
  * @type {string}
106
106
  * @memberof UpdateOrderRequest
107
107
  */
@@ -68,13 +68,13 @@ export interface UpdateOrgBrandRequest {
68
68
  */
69
69
  country?: string | null;
70
70
  /**
71
- * Primary brand colour — document title and table headers
71
+ * Primary brand color — document title and table headers
72
72
  * @type {string}
73
73
  * @memberof UpdateOrgBrandRequest
74
74
  */
75
75
  primaryColor?: string | null;
76
76
  /**
77
- * Secondary brand colour — subtitle, section headings, totals accent
77
+ * Secondary brand color — subtitle, section headings, totals accent
78
78
  * @type {string}
79
79
  * @memberof UpdateOrgBrandRequest
80
80
  */
@@ -68,7 +68,7 @@ export interface UpdateShipmentRequest {
68
68
  */
69
69
  addressId?: string | null;
70
70
  /**
71
- * Selected carrier service point identifier.
71
+ * Selected service point ID.
72
72
  * @type {string}
73
73
  * @memberof UpdateShipmentRequest
74
74
  */
@@ -22,7 +22,7 @@ import {
22
22
  } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
23
23
 
24
24
  /**
25
- * 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).
25
+ * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace it).
26
26
  * @export
27
27
  * @interface UpdateShipmentRequestDroppoint
28
28
  */
@@ -89,13 +89,13 @@ export interface UpdateShippingRuleRequest {
89
89
  */
90
90
  receivingCountries?: Array<string>;
91
91
  /**
92
- * Send email notification to recipient
92
+ * Send an email notification to the receiver
93
93
  * @type {boolean}
94
94
  * @memberof UpdateShippingRuleRequest
95
95
  */
96
96
  emailNotification?: boolean;
97
97
  /**
98
- * Send SMS notification to recipient
98
+ * Send an SMS notification to the receiver
99
99
  * @type {boolean}
100
100
  * @memberof UpdateShippingRuleRequest
101
101
  */
@@ -143,7 +143,7 @@ export interface UpdateShippingRuleRequest {
143
143
  */
144
144
  generateCommercialInvoice?: boolean;
145
145
  /**
146
- * Generate packing slip with package and item details
146
+ * Generate a packing slip with parcel and item details
147
147
  * @type {boolean}
148
148
  * @memberof UpdateShippingRuleRequest
149
149
  */