@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.
- package/dist/apis/OrdersApi.d.ts +3 -2
- package/dist/apis/OrdersApi.js +5 -2
- package/dist/apis/ShipmentsApi.d.ts +3 -2
- package/dist/apis/ShipmentsApi.js +5 -2
- package/dist/esm/apis/OrdersApi.d.ts +3 -2
- package/dist/esm/apis/OrdersApi.js +5 -2
- package/dist/esm/apis/ShipmentsApi.d.ts +3 -2
- package/dist/esm/apis/ShipmentsApi.js +5 -2
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +14 -0
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +14 -0
- package/dist/esm/models/CreateOrderChannelRequest.d.ts +14 -0
- package/dist/esm/models/CreateOrderChannelRequest.js +9 -0
- package/dist/esm/models/ListApiTokens401Response.d.ts +14 -0
- package/dist/esm/models/ListApiTokens401Response.js +14 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +14 -0
- package/dist/esm/models/ListOrderChannels200ResponseDataInner.js +11 -0
- package/dist/esm/models/SendShipment422Response.d.ts +14 -0
- package/dist/esm/models/SendShipment422Response.js +14 -0
- package/dist/esm/models/UpdateOrderChannelRequest.d.ts +14 -0
- package/dist/esm/models/UpdateOrderChannelRequest.js +9 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +14 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +14 -0
- package/dist/models/CreateOrderChannelRequest.d.ts +14 -0
- package/dist/models/CreateOrderChannelRequest.js +10 -1
- package/dist/models/ListApiTokens401Response.d.ts +14 -0
- package/dist/models/ListApiTokens401Response.js +14 -0
- package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +14 -0
- package/dist/models/ListOrderChannels200ResponseDataInner.js +12 -1
- package/dist/models/SendShipment422Response.d.ts +14 -0
- package/dist/models/SendShipment422Response.js +14 -0
- package/dist/models/UpdateOrderChannelRequest.d.ts +14 -0
- package/dist/models/UpdateOrderChannelRequest.js +10 -0
- package/docs/CreateOrderChannelRequest.md +2 -0
- package/docs/ListOrderChannels200ResponseDataInner.md +2 -0
- package/docs/OrdersApi.md +5 -2
- package/docs/ShipmentsApi.md +5 -2
- package/docs/UpdateOrderChannelRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +7 -2
- package/src/apis/ShipmentsApi.ts +7 -2
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +14 -0
- package/src/models/CreateOrderChannelRequest.ts +17 -0
- package/src/models/ListApiTokens401Response.ts +14 -0
- package/src/models/ListOrderChannels200ResponseDataInner.ts +18 -0
- package/src/models/SendShipment422Response.ts +14 -0
- package/src/models/UpdateOrderChannelRequest.ts +19 -0
|
@@ -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',
|
|
@@ -168,6 +169,9 @@ export const ListApiTokens401ResponseCodeEnum = {
|
|
|
168
169
|
AutomationInvalid: 'AUTOMATION_INVALID',
|
|
169
170
|
ZippyDisabled: 'ZIPPY_DISABLED',
|
|
170
171
|
ConversationNotFound: 'CONVERSATION_NOT_FOUND',
|
|
172
|
+
FilterInvalid: 'FILTER_INVALID',
|
|
173
|
+
SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
|
|
174
|
+
SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
|
|
171
175
|
AdminForbidden: 'ADMIN_FORBIDDEN',
|
|
172
176
|
JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
|
|
173
177
|
JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
|
|
@@ -183,6 +187,16 @@ export const ListApiTokens401ResponseCodeEnum = {
|
|
|
183
187
|
MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
|
|
184
188
|
MigrationNotFound: 'MIGRATION_NOT_FOUND',
|
|
185
189
|
MigrationInProgress: 'MIGRATION_IN_PROGRESS',
|
|
190
|
+
WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
|
|
191
|
+
WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
|
|
192
|
+
WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
|
|
193
|
+
WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
|
|
194
|
+
WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
|
|
195
|
+
WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
|
|
196
|
+
WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
|
|
197
|
+
WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
|
|
198
|
+
WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
|
|
199
|
+
WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
|
|
186
200
|
DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
|
|
187
201
|
DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
|
|
188
202
|
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',
|
|
@@ -182,6 +183,9 @@ export const SendShipment422ResponseCodeEnum = {
|
|
|
182
183
|
AutomationInvalid: 'AUTOMATION_INVALID',
|
|
183
184
|
ZippyDisabled: 'ZIPPY_DISABLED',
|
|
184
185
|
ConversationNotFound: 'CONVERSATION_NOT_FOUND',
|
|
186
|
+
FilterInvalid: 'FILTER_INVALID',
|
|
187
|
+
SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
|
|
188
|
+
SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
|
|
185
189
|
AdminForbidden: 'ADMIN_FORBIDDEN',
|
|
186
190
|
JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
|
|
187
191
|
JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
|
|
@@ -197,6 +201,16 @@ export const SendShipment422ResponseCodeEnum = {
|
|
|
197
201
|
MigrationSourceUnreachable: 'MIGRATION_SOURCE_UNREACHABLE',
|
|
198
202
|
MigrationNotFound: 'MIGRATION_NOT_FOUND',
|
|
199
203
|
MigrationInProgress: 'MIGRATION_IN_PROGRESS',
|
|
204
|
+
WmsConnectionNotFound: 'WMS_CONNECTION_NOT_FOUND',
|
|
205
|
+
WmsConnectionConfigInvalid: 'WMS_CONNECTION_CONFIG_INVALID',
|
|
206
|
+
WmsConnectionDisabled: 'WMS_CONNECTION_DISABLED',
|
|
207
|
+
WmsAccountMismatch: 'WMS_ACCOUNT_MISMATCH',
|
|
208
|
+
WmsHostIdUnmapped: 'WMS_HOST_ID_UNMAPPED',
|
|
209
|
+
WmsServicePointRequired: 'WMS_SERVICE_POINT_REQUIRED',
|
|
210
|
+
WmsDangerousGoodsUnsupported: 'WMS_DANGEROUS_GOODS_UNSUPPORTED',
|
|
211
|
+
WmsLabelInProgress: 'WMS_LABEL_IN_PROGRESS',
|
|
212
|
+
WmsLabelAlreadyBooked: 'WMS_LABEL_ALREADY_BOOKED',
|
|
213
|
+
WmsLabelCountMismatch: 'WMS_LABEL_COUNT_MISMATCH',
|
|
200
214
|
DataExportNotFound: 'DATA_EXPORT_NOT_FOUND',
|
|
201
215
|
DataExportInProgress: 'DATA_EXPORT_IN_PROGRESS',
|
|
202
216
|
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'],
|