@zippendo/sdk 1.3.0 → 1.3.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 (46) hide show
  1. package/dist/apis/OrdersApi.d.ts +3 -2
  2. package/dist/apis/OrdersApi.js +5 -2
  3. package/dist/apis/ShipmentsApi.d.ts +3 -2
  4. package/dist/apis/ShipmentsApi.js +5 -2
  5. package/dist/esm/apis/OrdersApi.d.ts +3 -2
  6. package/dist/esm/apis/OrdersApi.js +5 -2
  7. package/dist/esm/apis/ShipmentsApi.d.ts +3 -2
  8. package/dist/esm/apis/ShipmentsApi.js +5 -2
  9. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +14 -0
  10. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +14 -0
  11. package/dist/esm/models/CreateOrderChannelRequest.d.ts +14 -0
  12. package/dist/esm/models/CreateOrderChannelRequest.js +9 -0
  13. package/dist/esm/models/ListApiTokens401Response.d.ts +14 -0
  14. package/dist/esm/models/ListApiTokens401Response.js +14 -0
  15. package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +14 -0
  16. package/dist/esm/models/ListOrderChannels200ResponseDataInner.js +11 -0
  17. package/dist/esm/models/SendShipment422Response.d.ts +14 -0
  18. package/dist/esm/models/SendShipment422Response.js +14 -0
  19. package/dist/esm/models/UpdateOrderChannelRequest.d.ts +14 -0
  20. package/dist/esm/models/UpdateOrderChannelRequest.js +9 -0
  21. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +14 -0
  22. package/dist/models/BatchSendShipments200ResponseResultsInner.js +14 -0
  23. package/dist/models/CreateOrderChannelRequest.d.ts +14 -0
  24. package/dist/models/CreateOrderChannelRequest.js +10 -1
  25. package/dist/models/ListApiTokens401Response.d.ts +14 -0
  26. package/dist/models/ListApiTokens401Response.js +14 -0
  27. package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +14 -0
  28. package/dist/models/ListOrderChannels200ResponseDataInner.js +12 -1
  29. package/dist/models/SendShipment422Response.d.ts +14 -0
  30. package/dist/models/SendShipment422Response.js +14 -0
  31. package/dist/models/UpdateOrderChannelRequest.d.ts +14 -0
  32. package/dist/models/UpdateOrderChannelRequest.js +10 -0
  33. package/docs/CreateOrderChannelRequest.md +2 -0
  34. package/docs/ListOrderChannels200ResponseDataInner.md +2 -0
  35. package/docs/OrdersApi.md +5 -2
  36. package/docs/ShipmentsApi.md +5 -2
  37. package/docs/UpdateOrderChannelRequest.md +2 -0
  38. package/package.json +1 -1
  39. package/src/apis/OrdersApi.ts +7 -2
  40. package/src/apis/ShipmentsApi.ts +7 -2
  41. package/src/models/BatchSendShipments200ResponseResultsInner.ts +14 -0
  42. package/src/models/CreateOrderChannelRequest.ts +17 -0
  43. package/src/models/ListApiTokens401Response.ts +14 -0
  44. package/src/models/ListOrderChannels200ResponseDataInner.ts +18 -0
  45. package/src/models/SendShipment422Response.ts +14 -0
  46. package/src/models/UpdateOrderChannelRequest.ts +19 -0
@@ -134,6 +134,7 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
134
134
  OrderExists: 'ORDER_EXISTS',
135
135
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
136
136
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
137
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
137
138
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
138
139
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
139
140
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -156,6 +157,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
156
157
  AutomationInvalid: 'AUTOMATION_INVALID',
157
158
  ZippyDisabled: 'ZIPPY_DISABLED',
158
159
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
160
+ FilterInvalid: 'FILTER_INVALID',
161
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
162
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
159
163
  AdminForbidden: 'ADMIN_FORBIDDEN',
160
164
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
161
165
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -171,6 +175,16 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
171
175
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
172
176
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
173
177
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
178
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
179
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
180
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
181
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
182
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
183
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
184
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
185
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
186
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
187
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
174
188
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
175
189
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
176
190
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',
@@ -40,6 +40,12 @@ export interface CreateOrderChannelRequest {
40
40
  * @memberof CreateOrderChannelRequest
41
41
  */
42
42
  enabled?: boolean;
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.
45
+ * @type {CreateOrderChannelRequestRoleEnum}
46
+ * @memberof CreateOrderChannelRequest
47
+ */
48
+ role?: CreateOrderChannelRequestRoleEnum;
43
49
  /**
44
50
  *
45
51
  * @type {CreateOrderChannelRequestSettings}
@@ -55,6 +61,14 @@ export declare const CreateOrderChannelRequestTypeEnum: {
55
61
  readonly Custom: "custom";
56
62
  };
57
63
  export type CreateOrderChannelRequestTypeEnum = typeof CreateOrderChannelRequestTypeEnum[keyof typeof CreateOrderChannelRequestTypeEnum];
64
+ /**
65
+ * @export
66
+ */
67
+ export declare const CreateOrderChannelRequestRoleEnum: {
68
+ readonly OrdersAndRates: "orders_and_rates";
69
+ readonly RatesOnly: "rates_only";
70
+ };
71
+ export type CreateOrderChannelRequestRoleEnum = typeof CreateOrderChannelRequestRoleEnum[keyof typeof CreateOrderChannelRequestRoleEnum];
58
72
  /**
59
73
  * Check if a given object implements the CreateOrderChannelRequest interface.
60
74
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.CreateOrderChannelRequestTypeEnum = void 0;
16
+ exports.CreateOrderChannelRequestRoleEnum = exports.CreateOrderChannelRequestTypeEnum = void 0;
17
17
  exports.instanceOfCreateOrderChannelRequest = instanceOfCreateOrderChannelRequest;
18
18
  exports.CreateOrderChannelRequestFromJSON = CreateOrderChannelRequestFromJSON;
19
19
  exports.CreateOrderChannelRequestFromJSONTyped = CreateOrderChannelRequestFromJSONTyped;
@@ -27,6 +27,13 @@ exports.CreateOrderChannelRequestTypeEnum = {
27
27
  Manual: 'manual',
28
28
  Custom: 'custom'
29
29
  };
30
+ /**
31
+ * @export
32
+ */
33
+ exports.CreateOrderChannelRequestRoleEnum = {
34
+ OrdersAndRates: 'orders_and_rates',
35
+ RatesOnly: 'rates_only'
36
+ };
30
37
  /**
31
38
  * Check if a given object implements the CreateOrderChannelRequest interface.
32
39
  */
@@ -49,6 +56,7 @@ function CreateOrderChannelRequestFromJSONTyped(json, ignoreDiscriminator) {
49
56
  'type': json['type'],
50
57
  'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
51
58
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
59
+ 'role': json['role'] == null ? undefined : json['role'],
52
60
  'settings': json['settings'] == null ? undefined : (0, CreateOrderChannelRequestSettings_1.CreateOrderChannelRequestSettingsFromJSON)(json['settings']),
53
61
  };
54
62
  }
@@ -64,6 +72,7 @@ function CreateOrderChannelRequestToJSONTyped(value, ignoreDiscriminator = false
64
72
  'type': value['type'],
65
73
  'brandId': value['brandId'],
66
74
  'enabled': value['enabled'],
75
+ 'role': value['role'],
67
76
  'settings': (0, CreateOrderChannelRequestSettings_1.CreateOrderChannelRequestSettingsToJSON)(value['settings']),
68
77
  };
69
78
  }
@@ -140,6 +140,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
140
140
  readonly OrderExists: "ORDER_EXISTS";
141
141
  readonly OrderChannelNotFound: "ORDER_CHANNEL_NOT_FOUND";
142
142
  readonly OrderChannelConfigInvalid: "ORDER_CHANNEL_CONFIG_INVALID";
143
+ readonly OrderChannelRatesOnly: "ORDER_CHANNEL_RATES_ONLY";
143
144
  readonly IntegrationNotConfigured: "INTEGRATION_NOT_CONFIGURED";
144
145
  readonly InstallationNotFound: "INSTALLATION_NOT_FOUND";
145
146
  readonly WebhookSignatureInvalid: "WEBHOOK_SIGNATURE_INVALID";
@@ -162,6 +163,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
162
163
  readonly AutomationInvalid: "AUTOMATION_INVALID";
163
164
  readonly ZippyDisabled: "ZIPPY_DISABLED";
164
165
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
166
+ readonly FilterInvalid: "FILTER_INVALID";
167
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
168
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
165
169
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
166
170
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
167
171
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -177,6 +181,16 @@ export declare const ListApiTokens401ResponseCodeEnum: {
177
181
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
178
182
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
179
183
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
184
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
185
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
186
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
187
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
188
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
189
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
190
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
191
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
192
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
193
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
180
194
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
181
195
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
182
196
  readonly DataExportNotReady: "DATA_EXPORT_NOT_READY";
@@ -125,6 +125,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
125
125
  OrderExists: 'ORDER_EXISTS',
126
126
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
127
127
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
128
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
128
129
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
129
130
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
130
131
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -147,6 +148,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
147
148
  AutomationInvalid: 'AUTOMATION_INVALID',
148
149
  ZippyDisabled: 'ZIPPY_DISABLED',
149
150
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
151
+ FilterInvalid: 'FILTER_INVALID',
152
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
153
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
150
154
  AdminForbidden: 'ADMIN_FORBIDDEN',
151
155
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
152
156
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -162,6 +166,16 @@ exports.ListApiTokens401ResponseCodeEnum = {
162
166
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
163
167
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
164
168
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
169
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
170
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
171
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
172
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
173
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
174
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
175
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
176
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
177
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
178
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
165
179
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
166
180
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
167
181
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',
@@ -40,6 +40,12 @@ export interface ListOrderChannels200ResponseDataInner {
40
40
  * @memberof ListOrderChannels200ResponseDataInner
41
41
  */
42
42
  enabled: boolean;
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.
45
+ * @type {ListOrderChannels200ResponseDataInnerRoleEnum}
46
+ * @memberof ListOrderChannels200ResponseDataInner
47
+ */
48
+ role: ListOrderChannels200ResponseDataInnerRoleEnum;
43
49
  /**
44
50
  * Brand this channel belongs to, or null for organization-wide. Orders synced from this channel inherit it, and so do the shipments and documents made from them.
45
51
  * @type {string}
@@ -111,6 +117,14 @@ export declare const ListOrderChannels200ResponseDataInnerTypeEnum: {
111
117
  readonly Custom: "custom";
112
118
  };
113
119
  export type ListOrderChannels200ResponseDataInnerTypeEnum = typeof ListOrderChannels200ResponseDataInnerTypeEnum[keyof typeof ListOrderChannels200ResponseDataInnerTypeEnum];
120
+ /**
121
+ * @export
122
+ */
123
+ export declare const ListOrderChannels200ResponseDataInnerRoleEnum: {
124
+ readonly OrdersAndRates: "orders_and_rates";
125
+ readonly RatesOnly: "rates_only";
126
+ };
127
+ export type ListOrderChannels200ResponseDataInnerRoleEnum = typeof ListOrderChannels200ResponseDataInnerRoleEnum[keyof typeof ListOrderChannels200ResponseDataInnerRoleEnum];
114
128
  /**
115
129
  * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
116
130
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ListOrderChannels200ResponseDataInnerTypeEnum = void 0;
16
+ exports.ListOrderChannels200ResponseDataInnerRoleEnum = exports.ListOrderChannels200ResponseDataInnerTypeEnum = void 0;
17
17
  exports.instanceOfListOrderChannels200ResponseDataInner = instanceOfListOrderChannels200ResponseDataInner;
18
18
  exports.ListOrderChannels200ResponseDataInnerFromJSON = ListOrderChannels200ResponseDataInnerFromJSON;
19
19
  exports.ListOrderChannels200ResponseDataInnerFromJSONTyped = ListOrderChannels200ResponseDataInnerFromJSONTyped;
@@ -29,6 +29,13 @@ exports.ListOrderChannels200ResponseDataInnerTypeEnum = {
29
29
  Manual: 'manual',
30
30
  Custom: 'custom'
31
31
  };
32
+ /**
33
+ * @export
34
+ */
35
+ exports.ListOrderChannels200ResponseDataInnerRoleEnum = {
36
+ OrdersAndRates: 'orders_and_rates',
37
+ RatesOnly: 'rates_only'
38
+ };
32
39
  /**
33
40
  * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
34
41
  */
@@ -41,6 +48,8 @@ function instanceOfListOrderChannels200ResponseDataInner(value) {
41
48
  return false;
42
49
  if (!('enabled' in value) || value['enabled'] === undefined)
43
50
  return false;
51
+ if (!('role' in value) || value['role'] === undefined)
52
+ return false;
44
53
  if (!('brandId' in value) || value['brandId'] === undefined)
45
54
  return false;
46
55
  if (!('hasCredentials' in value) || value['hasCredentials'] === undefined)
@@ -67,6 +76,7 @@ function ListOrderChannels200ResponseDataInnerFromJSONTyped(json, ignoreDiscrimi
67
76
  'name': json['name'],
68
77
  'type': json['type'],
69
78
  'enabled': json['enabled'],
79
+ 'role': json['role'],
70
80
  'brandId': json['brandId'],
71
81
  'hasCredentials': json['hasCredentials'],
72
82
  'settings': (0, ListOrderChannels200ResponseDataInnerSettings_1.ListOrderChannels200ResponseDataInnerSettingsFromJSON)(json['settings']),
@@ -91,6 +101,7 @@ function ListOrderChannels200ResponseDataInnerToJSONTyped(value, ignoreDiscrimin
91
101
  'name': value['name'],
92
102
  'type': value['type'],
93
103
  'enabled': value['enabled'],
104
+ 'role': value['role'],
94
105
  'brandId': value['brandId'],
95
106
  'hasCredentials': value['hasCredentials'],
96
107
  'settings': (0, ListOrderChannels200ResponseDataInnerSettings_1.ListOrderChannels200ResponseDataInnerSettingsToJSON)(value['settings']),
@@ -147,6 +147,7 @@ export declare const SendShipment422ResponseCodeEnum: {
147
147
  readonly OrderExists: "ORDER_EXISTS";
148
148
  readonly OrderChannelNotFound: "ORDER_CHANNEL_NOT_FOUND";
149
149
  readonly OrderChannelConfigInvalid: "ORDER_CHANNEL_CONFIG_INVALID";
150
+ readonly OrderChannelRatesOnly: "ORDER_CHANNEL_RATES_ONLY";
150
151
  readonly IntegrationNotConfigured: "INTEGRATION_NOT_CONFIGURED";
151
152
  readonly InstallationNotFound: "INSTALLATION_NOT_FOUND";
152
153
  readonly WebhookSignatureInvalid: "WEBHOOK_SIGNATURE_INVALID";
@@ -169,6 +170,9 @@ export declare const SendShipment422ResponseCodeEnum: {
169
170
  readonly AutomationInvalid: "AUTOMATION_INVALID";
170
171
  readonly ZippyDisabled: "ZIPPY_DISABLED";
171
172
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
173
+ readonly FilterInvalid: "FILTER_INVALID";
174
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
175
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
172
176
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
173
177
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
174
178
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -184,6 +188,16 @@ export declare const SendShipment422ResponseCodeEnum: {
184
188
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
185
189
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
186
190
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
191
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
192
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
193
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
194
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
195
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
196
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
197
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
198
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
199
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
200
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
187
201
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
188
202
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
189
203
  readonly DataExportNotReady: "DATA_EXPORT_NOT_READY";
@@ -126,6 +126,7 @@ exports.SendShipment422ResponseCodeEnum = {
126
126
  OrderExists: 'ORDER_EXISTS',
127
127
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
128
128
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
129
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
129
130
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
130
131
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
131
132
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -148,6 +149,9 @@ exports.SendShipment422ResponseCodeEnum = {
148
149
  AutomationInvalid: 'AUTOMATION_INVALID',
149
150
  ZippyDisabled: 'ZIPPY_DISABLED',
150
151
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
152
+ FilterInvalid: 'FILTER_INVALID',
153
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
154
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
151
155
  AdminForbidden: 'ADMIN_FORBIDDEN',
152
156
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
153
157
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -163,6 +167,16 @@ exports.SendShipment422ResponseCodeEnum = {
163
167
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
164
168
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
165
169
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
170
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
171
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
172
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
173
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
174
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
175
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
176
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
177
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
178
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
179
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
166
180
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
167
181
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
168
182
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',
@@ -34,6 +34,12 @@ export interface UpdateOrderChannelRequest {
34
34
  * @memberof UpdateOrderChannelRequest
35
35
  */
36
36
  enabled?: boolean;
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.
39
+ * @type {UpdateOrderChannelRequestRoleEnum}
40
+ * @memberof UpdateOrderChannelRequest
41
+ */
42
+ role?: UpdateOrderChannelRequestRoleEnum;
37
43
  /**
38
44
  * Type-specific platform credentials.
39
45
  * @type {{ [key: string]: any; }}
@@ -55,6 +61,14 @@ export interface UpdateOrderChannelRequest {
55
61
  */
56
62
  shippingRuleIds?: Array<string>;
57
63
  }
64
+ /**
65
+ * @export
66
+ */
67
+ export declare const UpdateOrderChannelRequestRoleEnum: {
68
+ readonly OrdersAndRates: "orders_and_rates";
69
+ readonly RatesOnly: "rates_only";
70
+ };
71
+ export type UpdateOrderChannelRequestRoleEnum = typeof UpdateOrderChannelRequestRoleEnum[keyof typeof UpdateOrderChannelRequestRoleEnum];
58
72
  /**
59
73
  * Check if a given object implements the UpdateOrderChannelRequest interface.
60
74
  */
@@ -13,12 +13,20 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.UpdateOrderChannelRequestRoleEnum = void 0;
16
17
  exports.instanceOfUpdateOrderChannelRequest = instanceOfUpdateOrderChannelRequest;
17
18
  exports.UpdateOrderChannelRequestFromJSON = UpdateOrderChannelRequestFromJSON;
18
19
  exports.UpdateOrderChannelRequestFromJSONTyped = UpdateOrderChannelRequestFromJSONTyped;
19
20
  exports.UpdateOrderChannelRequestToJSON = UpdateOrderChannelRequestToJSON;
20
21
  exports.UpdateOrderChannelRequestToJSONTyped = UpdateOrderChannelRequestToJSONTyped;
21
22
  const UpdateOrderChannelRequestSettings_1 = require("./UpdateOrderChannelRequestSettings");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.UpdateOrderChannelRequestRoleEnum = {
27
+ OrdersAndRates: 'orders_and_rates',
28
+ RatesOnly: 'rates_only'
29
+ };
22
30
  /**
23
31
  * Check if a given object implements the UpdateOrderChannelRequest interface.
24
32
  */
@@ -36,6 +44,7 @@ function UpdateOrderChannelRequestFromJSONTyped(json, ignoreDiscriminator) {
36
44
  'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
37
45
  'name': json['name'] == null ? undefined : json['name'],
38
46
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
47
+ 'role': json['role'] == null ? undefined : json['role'],
39
48
  'credentials': json['credentials'] === undefined ? undefined : json['credentials'] === null ? null : json['credentials'],
40
49
  'settings': json['settings'] == null ? undefined : (0, UpdateOrderChannelRequestSettings_1.UpdateOrderChannelRequestSettingsFromJSON)(json['settings']),
41
50
  'shippingRuleIds': json['shippingRuleIds'] == null ? undefined : json['shippingRuleIds'],
@@ -52,6 +61,7 @@ function UpdateOrderChannelRequestToJSONTyped(value, ignoreDiscriminator = false
52
61
  'brandId': value['brandId'],
53
62
  'name': value['name'],
54
63
  'enabled': value['enabled'],
64
+ 'role': value['role'],
55
65
  'credentials': value['credentials'],
56
66
  'settings': (0, UpdateOrderChannelRequestSettings_1.UpdateOrderChannelRequestSettingsToJSON)(value['settings']),
57
67
  'shippingRuleIds': value['shippingRuleIds'],
@@ -10,6 +10,7 @@ Name | Type
10
10
  `type` | string
11
11
  `brandId` | string
12
12
  `enabled` | boolean
13
+ `role` | string
13
14
  `settings` | [CreateOrderChannelRequestSettings](CreateOrderChannelRequestSettings.md)
14
15
 
15
16
  ## Example
@@ -23,6 +24,7 @@ const example = {
23
24
  "type": custom,
24
25
  "brandId": brnd_8f3kd92ld0,
25
26
  "enabled": true,
27
+ "role": orders_and_rates,
26
28
  "settings": null,
27
29
  } satisfies CreateOrderChannelRequest
28
30
 
@@ -10,6 +10,7 @@ Name | Type
10
10
  `name` | string
11
11
  `type` | string
12
12
  `enabled` | boolean
13
+ `role` | string
13
14
  `brandId` | string
14
15
  `hasCredentials` | boolean
15
16
  `settings` | [ListOrderChannels200ResponseDataInnerSettings](ListOrderChannels200ResponseDataInnerSettings.md)
@@ -32,6 +33,7 @@ const example = {
32
33
  "name": Anna's Shopify Store,
33
34
  "type": shopify,
34
35
  "enabled": true,
36
+ "role": orders_and_rates,
35
37
  "brandId": brnd_8f3kd92ld0,
36
38
  "hasCredentials": true,
37
39
  "settings": null,
package/docs/OrdersApi.md CHANGED
@@ -245,11 +245,11 @@ example().catch(console.error);
245
245
 
246
246
  ## listOrders
247
247
 
248
- > ListOrders200Response listOrders(orgId, page, limit, brandId, brandScope, status, orderChannelId, search)
248
+ > ListOrders200Response listOrders(orgId, page, limit, brandId, brandScope, status, orderChannelId, search, filter)
249
249
 
250
250
  List orders
251
251
 
252
- Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
252
+ Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
253
253
 
254
254
  ### Example
255
255
 
@@ -285,6 +285,8 @@ async function example() {
285
285
  orderChannelId: clz9k2f0a0001abcd1234efgh,
286
286
  // string | Search by order number or customer name/email. (optional)
287
287
  search: Anna,
288
+ // string | Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`. (optional)
289
+ filter: {"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]},
288
290
  } satisfies ListOrdersRequest;
289
291
 
290
292
  try {
@@ -312,6 +314,7 @@ example().catch(console.error);
312
314
  | **status** | `pending`, `processing`, `partially_fulfilled`, `fulfilled`, `error`, `cancelled` | Order fulfilment status derived from its shipments. | [Optional] [Defaults to `undefined`] [Enum: pending, processing, partially_fulfilled, fulfilled, error, cancelled] |
313
315
  | **orderChannelId** | `string` | Filter by order channel ID. | [Optional] [Defaults to `undefined`] |
314
316
  | **search** | `string` | Search by order number or customer name/email. | [Optional] [Defaults to `undefined`] |
317
+ | **filter** | `string` | Advanced filter as a JSON-encoded definition: a &#x60;conjunction&#x60; (&#x60;and&#x60;/&#x60;or&#x60;) over &#x60;conditions&#x60;, each &#x60;{ id, field, operator, value }&#x60; or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 &#x60;FILTER_INVALID&#x60;. | [Optional] [Defaults to `undefined`] |
315
318
 
316
319
  ### Return type
317
320
 
@@ -568,11 +568,11 @@ example().catch(console.error);
568
568
 
569
569
  ## listShipments
570
570
 
571
- > ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search)
571
+ > ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search, filter)
572
572
 
573
573
  List shipments
574
574
 
575
- List all shipments for an organization, paginated and ordered by newest first.
575
+ List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
576
576
 
577
577
  ### Example
578
578
 
@@ -608,6 +608,8 @@ async function example() {
608
608
  type: outbound,
609
609
  // string | Search by shipment reference or parcel tracking number. (optional)
610
610
  search: SHIP-1042,
611
+ // string | Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`. (optional)
612
+ filter: {"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]},
611
613
  } satisfies ListShipmentsRequest;
612
614
 
613
615
  try {
@@ -635,6 +637,7 @@ example().catch(console.error);
635
637
  | **status** | `draft`, `pending`, `processing`, `dispatched`, `partly_dispatched`, `error`, `cancelled`, `on_hold` | Filter by shipment status. | [Optional] [Defaults to `undefined`] [Enum: draft, pending, processing, dispatched, partly_dispatched, error, cancelled, on_hold] |
636
638
  | **type** | `outbound`, `inbound` | Filter by direction. | [Optional] [Defaults to `undefined`] [Enum: outbound, inbound] |
637
639
  | **search** | `string` | Search by shipment reference or parcel tracking number. | [Optional] [Defaults to `undefined`] |
640
+ | **filter** | `string` | Advanced filter as a JSON-encoded definition: a &#x60;conjunction&#x60; (&#x60;and&#x60;/&#x60;or&#x60;) over &#x60;conditions&#x60;, each &#x60;{ id, field, operator, value }&#x60; or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 &#x60;FILTER_INVALID&#x60;. | [Optional] [Defaults to `undefined`] |
638
641
 
639
642
  ### Return type
640
643
 
@@ -9,6 +9,7 @@ Name | Type
9
9
  `brandId` | string
10
10
  `name` | string
11
11
  `enabled` | boolean
12
+ `role` | string
12
13
  `credentials` | { [key: string]: any; }
13
14
  `settings` | [UpdateOrderChannelRequestSettings](UpdateOrderChannelRequestSettings.md)
14
15
  `shippingRuleIds` | Array&lt;string&gt;
@@ -23,6 +24,7 @@ const example = {
23
24
  "brandId": brnd_8f3kd92ld0,
24
25
  "name": Anna's Shopify Store,
25
26
  "enabled": true,
27
+ "role": orders_and_rates,
26
28
  "credentials": null,
27
29
  "settings": null,
28
30
  "shippingRuleIds": ["clz9k2f0a0002abcd5678ijkl"],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.3.0",
3
+ "version": "1.3.2",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -73,6 +73,7 @@ export interface ListOrdersRequest {
73
73
  status?: ListOrdersStatusEnum;
74
74
  orderChannelId?: string;
75
75
  search?: string;
76
+ filter?: string;
76
77
  }
77
78
 
78
79
  export interface UpdateOrderOperationRequest {
@@ -318,6 +319,10 @@ export class OrdersApi extends runtime.BaseAPI {
318
319
  queryParameters['search'] = requestParameters['search'];
319
320
  }
320
321
 
322
+ if (requestParameters['filter'] != null) {
323
+ queryParameters['filter'] = requestParameters['filter'];
324
+ }
325
+
321
326
  const headerParameters: runtime.HTTPHeaders = {};
322
327
 
323
328
  if (this.configuration && this.configuration.accessToken) {
@@ -341,7 +346,7 @@ export class OrdersApi extends runtime.BaseAPI {
341
346
  }
342
347
 
343
348
  /**
344
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
349
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
345
350
  * List orders
346
351
  */
347
352
  async listOrdersRaw(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrders200Response>> {
@@ -352,7 +357,7 @@ export class OrdersApi extends runtime.BaseAPI {
352
357
  }
353
358
 
354
359
  /**
355
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
360
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
356
361
  * List orders
357
362
  */
358
363
  async listOrders(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrders200Response> {
@@ -142,6 +142,7 @@ export interface ListShipmentsRequest {
142
142
  status?: ListShipmentsStatusEnum;
143
143
  type?: ListShipmentsTypeEnum;
144
144
  search?: string;
145
+ filter?: string;
145
146
  }
146
147
 
147
148
  export interface SendShipmentRequest {
@@ -688,6 +689,10 @@ export class ShipmentsApi extends runtime.BaseAPI {
688
689
  queryParameters['search'] = requestParameters['search'];
689
690
  }
690
691
 
692
+ if (requestParameters['filter'] != null) {
693
+ queryParameters['filter'] = requestParameters['filter'];
694
+ }
695
+
691
696
  const headerParameters: runtime.HTTPHeaders = {};
692
697
 
693
698
  if (this.configuration && this.configuration.accessToken) {
@@ -711,7 +716,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
711
716
  }
712
717
 
713
718
  /**
714
- * List all shipments for an organization, paginated and ordered by newest first.
719
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
715
720
  * List shipments
716
721
  */
717
722
  async listShipmentsRaw(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShipments200Response>> {
@@ -722,7 +727,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
722
727
  }
723
728
 
724
729
  /**
725
- * List all shipments for an organization, paginated and ordered by newest first.
730
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
726
731
  * List shipments
727
732
  */
728
733
  async listShipments(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShipments200Response> {
@@ -176,6 +176,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
176
176
  OrderExists: 'ORDER_EXISTS',
177
177
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
178
178
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
179
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
179
180
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
180
181
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
181
182
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -198,6 +199,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
198
199
  AutomationInvalid: 'AUTOMATION_INVALID',
199
200
  ZippyDisabled: 'ZIPPY_DISABLED',
200
201
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
202
+ FilterInvalid: 'FILTER_INVALID',
203
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
204
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
201
205
  AdminForbidden: 'ADMIN_FORBIDDEN',
202
206
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
203
207
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -213,6 +217,16 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
213
217
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
214
218
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
215
219
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
220
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
221
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
222
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
223
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
224
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
225
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
226
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
227
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
228
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
229
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
216
230
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
217
231
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
218
232
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',