@zippendo/sdk 1.3.0 → 1.3.1

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 (34) hide show
  1. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +11 -0
  2. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +11 -0
  3. package/dist/esm/models/CreateOrderChannelRequest.d.ts +14 -0
  4. package/dist/esm/models/CreateOrderChannelRequest.js +9 -0
  5. package/dist/esm/models/ListApiTokens401Response.d.ts +11 -0
  6. package/dist/esm/models/ListApiTokens401Response.js +11 -0
  7. package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +14 -0
  8. package/dist/esm/models/ListOrderChannels200ResponseDataInner.js +11 -0
  9. package/dist/esm/models/SendShipment422Response.d.ts +11 -0
  10. package/dist/esm/models/SendShipment422Response.js +11 -0
  11. package/dist/esm/models/UpdateOrderChannelRequest.d.ts +14 -0
  12. package/dist/esm/models/UpdateOrderChannelRequest.js +9 -0
  13. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +11 -0
  14. package/dist/models/BatchSendShipments200ResponseResultsInner.js +11 -0
  15. package/dist/models/CreateOrderChannelRequest.d.ts +14 -0
  16. package/dist/models/CreateOrderChannelRequest.js +10 -1
  17. package/dist/models/ListApiTokens401Response.d.ts +11 -0
  18. package/dist/models/ListApiTokens401Response.js +11 -0
  19. package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +14 -0
  20. package/dist/models/ListOrderChannels200ResponseDataInner.js +12 -1
  21. package/dist/models/SendShipment422Response.d.ts +11 -0
  22. package/dist/models/SendShipment422Response.js +11 -0
  23. package/dist/models/UpdateOrderChannelRequest.d.ts +14 -0
  24. package/dist/models/UpdateOrderChannelRequest.js +10 -0
  25. package/docs/CreateOrderChannelRequest.md +2 -0
  26. package/docs/ListOrderChannels200ResponseDataInner.md +2 -0
  27. package/docs/UpdateOrderChannelRequest.md +2 -0
  28. package/package.json +1 -1
  29. package/src/models/BatchSendShipments200ResponseResultsInner.ts +11 -0
  30. package/src/models/CreateOrderChannelRequest.ts +17 -0
  31. package/src/models/ListApiTokens401Response.ts +11 -0
  32. package/src/models/ListOrderChannels200ResponseDataInner.ts +18 -0
  33. package/src/models/SendShipment422Response.ts +11 -0
  34. package/src/models/UpdateOrderChannelRequest.ts +19 -0
@@ -162,6 +162,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
162
162
  readonly OrderExists: "ORDER_EXISTS";
163
163
  readonly OrderChannelNotFound: "ORDER_CHANNEL_NOT_FOUND";
164
164
  readonly OrderChannelConfigInvalid: "ORDER_CHANNEL_CONFIG_INVALID";
165
+ readonly OrderChannelRatesOnly: "ORDER_CHANNEL_RATES_ONLY";
165
166
  readonly IntegrationNotConfigured: "INTEGRATION_NOT_CONFIGURED";
166
167
  readonly InstallationNotFound: "INSTALLATION_NOT_FOUND";
167
168
  readonly WebhookSignatureInvalid: "WEBHOOK_SIGNATURE_INVALID";
@@ -199,6 +200,16 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
199
200
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
200
201
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
201
202
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
203
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
204
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
205
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
206
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
207
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
208
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
209
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
210
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
211
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
212
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
202
213
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
203
214
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
204
215
  readonly DataExportNotReady: "DATA_EXPORT_NOT_READY";
@@ -126,6 +126,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
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',
@@ -163,6 +164,16 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
163
164
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
164
165
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
165
166
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
167
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
168
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
169
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
170
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
171
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
172
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
173
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
174
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
175
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
176
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
166
177
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
167
178
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
168
179
  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
  */
@@ -19,6 +19,13 @@ export const CreateOrderChannelRequestTypeEnum = {
19
19
  Manual: 'manual',
20
20
  Custom: 'custom'
21
21
  };
22
+ /**
23
+ * @export
24
+ */
25
+ export const CreateOrderChannelRequestRoleEnum = {
26
+ OrdersAndRates: 'orders_and_rates',
27
+ RatesOnly: 'rates_only'
28
+ };
22
29
  /**
23
30
  * Check if a given object implements the CreateOrderChannelRequest interface.
24
31
  */
@@ -41,6 +48,7 @@ export function CreateOrderChannelRequestFromJSONTyped(json, ignoreDiscriminator
41
48
  'type': json['type'],
42
49
  'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
43
50
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
51
+ 'role': json['role'] == null ? undefined : json['role'],
44
52
  'settings': json['settings'] == null ? undefined : CreateOrderChannelRequestSettingsFromJSON(json['settings']),
45
53
  };
46
54
  }
@@ -56,6 +64,7 @@ export function CreateOrderChannelRequestToJSONTyped(value, ignoreDiscriminator
56
64
  'type': value['type'],
57
65
  'brandId': value['brandId'],
58
66
  'enabled': value['enabled'],
67
+ 'role': value['role'],
59
68
  'settings': CreateOrderChannelRequestSettingsToJSON(value['settings']),
60
69
  };
61
70
  }
@@ -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";
@@ -177,6 +178,16 @@ export declare const ListApiTokens401ResponseCodeEnum: {
177
178
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
178
179
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
179
180
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
181
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
182
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
183
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
184
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
185
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
186
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
187
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
188
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
189
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
190
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
180
191
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
181
192
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
182
193
  readonly DataExportNotReady: "DATA_EXPORT_NOT_READY";
@@ -117,6 +117,7 @@ export const ListApiTokens401ResponseCodeEnum = {
117
117
  OrderExists: 'ORDER_EXISTS',
118
118
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
119
119
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
120
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
120
121
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
121
122
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
122
123
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -154,6 +155,16 @@ export const ListApiTokens401ResponseCodeEnum = {
154
155
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
155
156
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
156
157
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
158
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
159
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
160
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
161
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
162
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
163
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
164
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
165
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
166
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
167
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
157
168
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
158
169
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
159
170
  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
  */
@@ -21,6 +21,13 @@ export const ListOrderChannels200ResponseDataInnerTypeEnum = {
21
21
  Manual: 'manual',
22
22
  Custom: 'custom'
23
23
  };
24
+ /**
25
+ * @export
26
+ */
27
+ export const ListOrderChannels200ResponseDataInnerRoleEnum = {
28
+ OrdersAndRates: 'orders_and_rates',
29
+ RatesOnly: 'rates_only'
30
+ };
24
31
  /**
25
32
  * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
26
33
  */
@@ -33,6 +40,8 @@ export function instanceOfListOrderChannels200ResponseDataInner(value) {
33
40
  return false;
34
41
  if (!('enabled' in value) || value['enabled'] === undefined)
35
42
  return false;
43
+ if (!('role' in value) || value['role'] === undefined)
44
+ return false;
36
45
  if (!('brandId' in value) || value['brandId'] === undefined)
37
46
  return false;
38
47
  if (!('hasCredentials' in value) || value['hasCredentials'] === undefined)
@@ -59,6 +68,7 @@ export function ListOrderChannels200ResponseDataInnerFromJSONTyped(json, ignoreD
59
68
  'name': json['name'],
60
69
  'type': json['type'],
61
70
  'enabled': json['enabled'],
71
+ 'role': json['role'],
62
72
  'brandId': json['brandId'],
63
73
  'hasCredentials': json['hasCredentials'],
64
74
  'settings': ListOrderChannels200ResponseDataInnerSettingsFromJSON(json['settings']),
@@ -83,6 +93,7 @@ export function ListOrderChannels200ResponseDataInnerToJSONTyped(value, ignoreDi
83
93
  'name': value['name'],
84
94
  'type': value['type'],
85
95
  'enabled': value['enabled'],
96
+ 'role': value['role'],
86
97
  'brandId': value['brandId'],
87
98
  'hasCredentials': value['hasCredentials'],
88
99
  'settings': 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";
@@ -184,6 +185,16 @@ export declare const SendShipment422ResponseCodeEnum: {
184
185
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
185
186
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
186
187
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
188
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
189
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
190
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
191
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
192
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
193
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
194
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
195
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
196
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
197
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
187
198
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
188
199
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
189
200
  readonly DataExportNotReady: "DATA_EXPORT_NOT_READY";
@@ -118,6 +118,7 @@ export const SendShipment422ResponseCodeEnum = {
118
118
  OrderExists: 'ORDER_EXISTS',
119
119
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
120
120
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
121
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
121
122
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
122
123
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
123
124
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -155,6 +156,16 @@ export const SendShipment422ResponseCodeEnum = {
155
156
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
156
157
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
157
158
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
159
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
160
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
161
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
162
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
163
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
164
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
165
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
166
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
167
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
168
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
158
169
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
159
170
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
160
171
  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
  */
@@ -12,6 +12,13 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { UpdateOrderChannelRequestSettingsFromJSON, UpdateOrderChannelRequestSettingsToJSON, } from './UpdateOrderChannelRequestSettings';
15
+ /**
16
+ * @export
17
+ */
18
+ export const UpdateOrderChannelRequestRoleEnum = {
19
+ OrdersAndRates: 'orders_and_rates',
20
+ RatesOnly: 'rates_only'
21
+ };
15
22
  /**
16
23
  * Check if a given object implements the UpdateOrderChannelRequest interface.
17
24
  */
@@ -29,6 +36,7 @@ export function UpdateOrderChannelRequestFromJSONTyped(json, ignoreDiscriminator
29
36
  'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
30
37
  'name': json['name'] == null ? undefined : json['name'],
31
38
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
39
+ 'role': json['role'] == null ? undefined : json['role'],
32
40
  'credentials': json['credentials'] === undefined ? undefined : json['credentials'] === null ? null : json['credentials'],
33
41
  'settings': json['settings'] == null ? undefined : UpdateOrderChannelRequestSettingsFromJSON(json['settings']),
34
42
  'shippingRuleIds': json['shippingRuleIds'] == null ? undefined : json['shippingRuleIds'],
@@ -45,6 +53,7 @@ export function UpdateOrderChannelRequestToJSONTyped(value, ignoreDiscriminator
45
53
  'brandId': value['brandId'],
46
54
  'name': value['name'],
47
55
  'enabled': value['enabled'],
56
+ 'role': value['role'],
48
57
  'credentials': value['credentials'],
49
58
  'settings': UpdateOrderChannelRequestSettingsToJSON(value['settings']),
50
59
  'shippingRuleIds': value['shippingRuleIds'],
@@ -162,6 +162,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
162
162
  readonly OrderExists: "ORDER_EXISTS";
163
163
  readonly OrderChannelNotFound: "ORDER_CHANNEL_NOT_FOUND";
164
164
  readonly OrderChannelConfigInvalid: "ORDER_CHANNEL_CONFIG_INVALID";
165
+ readonly OrderChannelRatesOnly: "ORDER_CHANNEL_RATES_ONLY";
165
166
  readonly IntegrationNotConfigured: "INTEGRATION_NOT_CONFIGURED";
166
167
  readonly InstallationNotFound: "INSTALLATION_NOT_FOUND";
167
168
  readonly WebhookSignatureInvalid: "WEBHOOK_SIGNATURE_INVALID";
@@ -199,6 +200,16 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
199
200
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
200
201
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
201
202
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
203
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
204
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
205
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
206
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
207
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
208
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
209
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
210
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
211
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
212
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
202
213
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
203
214
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
204
215
  readonly DataExportNotReady: "DATA_EXPORT_NOT_READY";
@@ -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',
@@ -171,6 +172,16 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
171
172
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
172
173
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
173
174
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
175
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
176
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
177
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
178
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
179
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
180
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
181
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
182
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
183
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
184
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
174
185
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
175
186
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
176
187
  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";
@@ -177,6 +178,16 @@ export declare const ListApiTokens401ResponseCodeEnum: {
177
178
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
178
179
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
179
180
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
181
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
182
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
183
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
184
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
185
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
186
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
187
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
188
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
189
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
190
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
180
191
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
181
192
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
182
193
  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',
@@ -162,6 +163,16 @@ exports.ListApiTokens401ResponseCodeEnum = {
162
163
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
163
164
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
164
165
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
166
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
167
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
168
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
169
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
170
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
171
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
172
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
173
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
174
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
175
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
165
176
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
166
177
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
167
178
  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";
@@ -184,6 +185,16 @@ export declare const SendShipment422ResponseCodeEnum: {
184
185
  readonly MigrationSourceUnreachable: "MIGRATION_SOURCE_UNREACHABLE";
185
186
  readonly MigrationNotFound: "MIGRATION_NOT_FOUND";
186
187
  readonly MigrationInProgress: "MIGRATION_IN_PROGRESS";
188
+ readonly WmsConnectionNotFound: "WMS_CONNECTION_NOT_FOUND";
189
+ readonly WmsConnectionConfigInvalid: "WMS_CONNECTION_CONFIG_INVALID";
190
+ readonly WmsConnectionDisabled: "WMS_CONNECTION_DISABLED";
191
+ readonly WmsAccountMismatch: "WMS_ACCOUNT_MISMATCH";
192
+ readonly WmsHostIdUnmapped: "WMS_HOST_ID_UNMAPPED";
193
+ readonly WmsServicePointRequired: "WMS_SERVICE_POINT_REQUIRED";
194
+ readonly WmsDangerousGoodsUnsupported: "WMS_DANGEROUS_GOODS_UNSUPPORTED";
195
+ readonly WmsLabelInProgress: "WMS_LABEL_IN_PROGRESS";
196
+ readonly WmsLabelAlreadyBooked: "WMS_LABEL_ALREADY_BOOKED";
197
+ readonly WmsLabelCountMismatch: "WMS_LABEL_COUNT_MISMATCH";
187
198
  readonly DataExportNotFound: "DATA_EXPORT_NOT_FOUND";
188
199
  readonly DataExportInProgress: "DATA_EXPORT_IN_PROGRESS";
189
200
  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',
@@ -163,6 +164,16 @@ exports.SendShipment422ResponseCodeEnum = {
163
164
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
164
165
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
165
166
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
167
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
168
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
169
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
170
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
171
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
172
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
173
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
174
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
175
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
176
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
166
177
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
167
178
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
168
179
  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,
@@ -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.1",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -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',
@@ -213,6 +214,16 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
213
214
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
214
215
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
215
216
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
217
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
218
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
219
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
220
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
221
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
222
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
223
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
224
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
225
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
226
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
216
227
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
217
228
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
218
229
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',
@@ -51,6 +51,12 @@ export interface CreateOrderChannelRequest {
51
51
  * @memberof CreateOrderChannelRequest
52
52
  */
53
53
  enabled?: boolean;
54
+ /**
55
+ * 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.
56
+ * @type {CreateOrderChannelRequestRoleEnum}
57
+ * @memberof CreateOrderChannelRequest
58
+ */
59
+ role?: CreateOrderChannelRequestRoleEnum;
54
60
  /**
55
61
  *
56
62
  * @type {CreateOrderChannelRequestSettings}
@@ -69,6 +75,15 @@ export const CreateOrderChannelRequestTypeEnum = {
69
75
  } as const;
70
76
  export type CreateOrderChannelRequestTypeEnum = typeof CreateOrderChannelRequestTypeEnum[keyof typeof CreateOrderChannelRequestTypeEnum];
71
77
 
78
+ /**
79
+ * @export
80
+ */
81
+ export const CreateOrderChannelRequestRoleEnum = {
82
+ OrdersAndRates: 'orders_and_rates',
83
+ RatesOnly: 'rates_only'
84
+ } as const;
85
+ export type CreateOrderChannelRequestRoleEnum = typeof CreateOrderChannelRequestRoleEnum[keyof typeof CreateOrderChannelRequestRoleEnum];
86
+
72
87
 
73
88
  /**
74
89
  * Check if a given object implements the CreateOrderChannelRequest interface.
@@ -93,6 +108,7 @@ export function CreateOrderChannelRequestFromJSONTyped(json: any, ignoreDiscrimi
93
108
  'type': json['type'],
94
109
  'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
95
110
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
111
+ 'role': json['role'] == null ? undefined : json['role'],
96
112
  'settings': json['settings'] == null ? undefined : CreateOrderChannelRequestSettingsFromJSON(json['settings']),
97
113
  };
98
114
  }
@@ -112,6 +128,7 @@ export function CreateOrderChannelRequestToJSONTyped(value?: CreateOrderChannelR
112
128
  'type': value['type'],
113
129
  'brandId': value['brandId'],
114
130
  'enabled': value['enabled'],
131
+ 'role': value['role'],
115
132
  'settings': CreateOrderChannelRequestSettingsToJSON(value['settings']),
116
133
  };
117
134
  }
@@ -146,6 +146,7 @@ export const ListApiTokens401ResponseCodeEnum = {
146
146
  OrderExists: 'ORDER_EXISTS',
147
147
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
148
148
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
149
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
149
150
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
150
151
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
151
152
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -183,6 +184,16 @@ export const ListApiTokens401ResponseCodeEnum = {
183
184
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
184
185
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
185
186
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
187
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
188
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
189
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
190
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
191
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
192
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
193
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
194
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
195
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
196
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
186
197
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
187
198
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
188
199
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',
@@ -51,6 +51,12 @@ export interface ListOrderChannels200ResponseDataInner {
51
51
  * @memberof ListOrderChannels200ResponseDataInner
52
52
  */
53
53
  enabled: boolean;
54
+ /**
55
+ * 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.
56
+ * @type {ListOrderChannels200ResponseDataInnerRoleEnum}
57
+ * @memberof ListOrderChannels200ResponseDataInner
58
+ */
59
+ role: ListOrderChannels200ResponseDataInnerRoleEnum;
54
60
  /**
55
61
  * 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.
56
62
  * @type {string}
@@ -125,6 +131,15 @@ export const ListOrderChannels200ResponseDataInnerTypeEnum = {
125
131
  } as const;
126
132
  export type ListOrderChannels200ResponseDataInnerTypeEnum = typeof ListOrderChannels200ResponseDataInnerTypeEnum[keyof typeof ListOrderChannels200ResponseDataInnerTypeEnum];
127
133
 
134
+ /**
135
+ * @export
136
+ */
137
+ export const ListOrderChannels200ResponseDataInnerRoleEnum = {
138
+ OrdersAndRates: 'orders_and_rates',
139
+ RatesOnly: 'rates_only'
140
+ } as const;
141
+ export type ListOrderChannels200ResponseDataInnerRoleEnum = typeof ListOrderChannels200ResponseDataInnerRoleEnum[keyof typeof ListOrderChannels200ResponseDataInnerRoleEnum];
142
+
128
143
 
129
144
  /**
130
145
  * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
@@ -134,6 +149,7 @@ export function instanceOfListOrderChannels200ResponseDataInner(value: object):
134
149
  if (!('name' in value) || value['name'] === undefined) return false;
135
150
  if (!('type' in value) || value['type'] === undefined) return false;
136
151
  if (!('enabled' in value) || value['enabled'] === undefined) return false;
152
+ if (!('role' in value) || value['role'] === undefined) return false;
137
153
  if (!('brandId' in value) || value['brandId'] === undefined) return false;
138
154
  if (!('hasCredentials' in value) || value['hasCredentials'] === undefined) return false;
139
155
  if (!('settings' in value) || value['settings'] === undefined) return false;
@@ -157,6 +173,7 @@ export function ListOrderChannels200ResponseDataInnerFromJSONTyped(json: any, ig
157
173
  'name': json['name'],
158
174
  'type': json['type'],
159
175
  'enabled': json['enabled'],
176
+ 'role': json['role'],
160
177
  'brandId': json['brandId'],
161
178
  'hasCredentials': json['hasCredentials'],
162
179
  'settings': ListOrderChannels200ResponseDataInnerSettingsFromJSON(json['settings']),
@@ -185,6 +202,7 @@ export function ListOrderChannels200ResponseDataInnerToJSONTyped(value?: ListOrd
185
202
  'name': value['name'],
186
203
  'type': value['type'],
187
204
  'enabled': value['enabled'],
205
+ 'role': value['role'],
188
206
  'brandId': value['brandId'],
189
207
  'hasCredentials': value['hasCredentials'],
190
208
  'settings': ListOrderChannels200ResponseDataInnerSettingsToJSON(value['settings']),
@@ -160,6 +160,7 @@ export const SendShipment422ResponseCodeEnum = {
160
160
  OrderExists: 'ORDER_EXISTS',
161
161
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
162
162
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
163
+ OrderChannelRatesOnly: 'ORDER_CHANNEL_RATES_ONLY',
163
164
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
164
165
  InstallationNotFound: 'INSTALLATION_NOT_FOUND',
165
166
  WebhookSignatureInvalid: 'WEBHOOK_SIGNATURE_INVALID',
@@ -197,6 +198,16 @@ export const SendShipment422ResponseCodeEnum = {
197
198
  MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
198
199
  MigrationNotFound: 'MIGRATION_NOT_FOUND',
199
200
  MigrationInProgress: 'MIGRATION_IN_PROGRESS',
201
+ WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
202
+ WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
203
+ WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
204
+ WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
205
+ WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
206
+ WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
207
+ WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
208
+ WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
209
+ WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
210
+ WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
200
211
  DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
201
212
  DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
202
213
  DataExportNotReady: 'DATA_EXPORT_NOT_READY',
@@ -45,6 +45,12 @@ export interface UpdateOrderChannelRequest {
45
45
  * @memberof UpdateOrderChannelRequest
46
46
  */
47
47
  enabled?: boolean;
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.
50
+ * @type {UpdateOrderChannelRequestRoleEnum}
51
+ * @memberof UpdateOrderChannelRequest
52
+ */
53
+ role?: UpdateOrderChannelRequestRoleEnum;
48
54
  /**
49
55
  * Type-specific platform credentials.
50
56
  * @type {{ [key: string]: any; }}
@@ -65,6 +71,17 @@ export interface UpdateOrderChannelRequest {
65
71
  shippingRuleIds?: Array<string>;
66
72
  }
67
73
 
74
+
75
+ /**
76
+ * @export
77
+ */
78
+ export const UpdateOrderChannelRequestRoleEnum = {
79
+ OrdersAndRates: 'orders_and_rates',
80
+ RatesOnly: 'rates_only'
81
+ } as const;
82
+ export type UpdateOrderChannelRequestRoleEnum = typeof UpdateOrderChannelRequestRoleEnum[keyof typeof UpdateOrderChannelRequestRoleEnum];
83
+
84
+
68
85
  /**
69
86
  * Check if a given object implements the UpdateOrderChannelRequest interface.
70
87
  */
@@ -85,6 +102,7 @@ export function UpdateOrderChannelRequestFromJSONTyped(json: any, ignoreDiscrimi
85
102
  'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
86
103
  'name': json['name'] == null ? undefined : json['name'],
87
104
  'enabled': json['enabled'] == null ? undefined : json['enabled'],
105
+ 'role': json['role'] == null ? undefined : json['role'],
88
106
  'credentials': json['credentials'] === undefined ? undefined : json['credentials'] === null ? null : json['credentials'],
89
107
  'settings': json['settings'] == null ? undefined : UpdateOrderChannelRequestSettingsFromJSON(json['settings']),
90
108
  'shippingRuleIds': json['shippingRuleIds'] == null ? undefined : json['shippingRuleIds'],
@@ -105,6 +123,7 @@ export function UpdateOrderChannelRequestToJSONTyped(value?: UpdateOrderChannelR
105
123
  'brandId': value['brandId'],
106
124
  'name': value['name'],
107
125
  'enabled': value['enabled'],
126
+ 'role': value['role'],
108
127
  'credentials': value['credentials'],
109
128
  'settings': UpdateOrderChannelRequestSettingsToJSON(value['settings']),
110
129
  'shippingRuleIds': value['shippingRuleIds'],