@zippendo/sdk 1.2.1 → 1.2.3

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 (52) hide show
  1. package/dist/apis/AddressesApi.d.ts +2 -0
  2. package/dist/apis/AddressesApi.js +6 -0
  3. package/dist/apis/CarriersApi.d.ts +2 -0
  4. package/dist/apis/CarriersApi.js +6 -0
  5. package/dist/apis/RulesApi.d.ts +2 -0
  6. package/dist/apis/RulesApi.js +6 -0
  7. package/dist/apis/ShipmentsApi.d.ts +25 -0
  8. package/dist/apis/ShipmentsApi.js +30 -1
  9. package/dist/apis/WebhooksApi.d.ts +2 -0
  10. package/dist/apis/WebhooksApi.js +6 -0
  11. package/dist/esm/apis/AddressesApi.d.ts +2 -0
  12. package/dist/esm/apis/AddressesApi.js +6 -0
  13. package/dist/esm/apis/CarriersApi.d.ts +2 -0
  14. package/dist/esm/apis/CarriersApi.js +6 -0
  15. package/dist/esm/apis/RulesApi.d.ts +2 -0
  16. package/dist/esm/apis/RulesApi.js +6 -0
  17. package/dist/esm/apis/ShipmentsApi.d.ts +25 -0
  18. package/dist/esm/apis/ShipmentsApi.js +29 -0
  19. package/dist/esm/apis/WebhooksApi.d.ts +2 -0
  20. package/dist/esm/apis/WebhooksApi.js +6 -0
  21. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
  22. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +1 -0
  23. package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.d.ts +6 -0
  24. package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.js +4 -0
  25. package/dist/esm/models/ListApiTokens401Response.d.ts +1 -0
  26. package/dist/esm/models/ListApiTokens401Response.js +1 -0
  27. package/dist/esm/models/SendShipment422Response.d.ts +1 -0
  28. package/dist/esm/models/SendShipment422Response.js +1 -0
  29. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
  30. package/dist/models/BatchSendShipments200ResponseResultsInner.js +1 -0
  31. package/dist/models/GetBillingUsage200ResponseZippyMessages.d.ts +6 -0
  32. package/dist/models/GetBillingUsage200ResponseZippyMessages.js +4 -0
  33. package/dist/models/ListApiTokens401Response.d.ts +1 -0
  34. package/dist/models/ListApiTokens401Response.js +1 -0
  35. package/dist/models/SendShipment422Response.d.ts +1 -0
  36. package/dist/models/SendShipment422Response.js +1 -0
  37. package/docs/AddressesApi.md +7 -1
  38. package/docs/CarriersApi.md +7 -1
  39. package/docs/GetBillingUsage200ResponseZippyMessages.md +2 -0
  40. package/docs/RulesApi.md +7 -1
  41. package/docs/ShipmentsApi.md +10 -1
  42. package/docs/WebhooksApi.md +7 -1
  43. package/package.json +1 -1
  44. package/src/apis/AddressesApi.ts +10 -0
  45. package/src/apis/CarriersApi.ts +10 -0
  46. package/src/apis/RulesApi.ts +10 -0
  47. package/src/apis/ShipmentsApi.ts +37 -0
  48. package/src/apis/WebhooksApi.ts +10 -0
  49. package/src/models/BatchSendShipments200ResponseResultsInner.ts +1 -0
  50. package/src/models/GetBillingUsage200ResponseZippyMessages.ts +9 -0
  51. package/src/models/ListApiTokens401Response.ts +1 -0
  52. package/src/models/SendShipment422Response.ts +1 -0
@@ -31,6 +31,8 @@ export interface ListAddressesRequest {
31
31
  page?: number;
32
32
  limit?: number;
33
33
  type?: ListAddressesTypeEnum;
34
+ countryCode?: string;
35
+ search?: string;
34
36
  brandId?: string;
35
37
  brandScope?: ListAddressesBrandScopeEnum;
36
38
  }
@@ -212,6 +212,12 @@ class AddressesApi extends runtime.BaseAPI {
212
212
  if (requestParameters['type'] != null) {
213
213
  queryParameters['type'] = requestParameters['type'];
214
214
  }
215
+ if (requestParameters['countryCode'] != null) {
216
+ queryParameters['countryCode'] = requestParameters['countryCode'];
217
+ }
218
+ if (requestParameters['search'] != null) {
219
+ queryParameters['search'] = requestParameters['search'];
220
+ }
215
221
  if (requestParameters['brandId'] != null) {
216
222
  queryParameters['brandId'] = requestParameters['brandId'];
217
223
  }
@@ -45,6 +45,8 @@ export interface ListCarriersRequest {
45
45
  limit?: number;
46
46
  brandId?: string;
47
47
  brandScope?: ListCarriersBrandScopeEnum;
48
+ carrierSlug?: string;
49
+ search?: string;
48
50
  }
49
51
  export interface UpdateCarrierOperationRequest {
50
52
  orgId: string;
@@ -331,6 +331,12 @@ class CarriersApi extends runtime.BaseAPI {
331
331
  if (requestParameters['brandScope'] != null) {
332
332
  queryParameters['brandScope'] = requestParameters['brandScope'];
333
333
  }
334
+ if (requestParameters['carrierSlug'] != null) {
335
+ queryParameters['carrierSlug'] = requestParameters['carrierSlug'];
336
+ }
337
+ if (requestParameters['search'] != null) {
338
+ queryParameters['search'] = requestParameters['search'];
339
+ }
334
340
  const headerParameters = {};
335
341
  if (this.configuration && this.configuration.accessToken) {
336
342
  const token = this.configuration.accessToken;
@@ -34,6 +34,8 @@ export interface ListShippingRulesRequest {
34
34
  limit?: number;
35
35
  brandId?: string;
36
36
  brandScope?: ListShippingRulesBrandScopeEnum;
37
+ carrierId?: string;
38
+ search?: string;
37
39
  }
38
40
  export interface UpdateShippingRuleOperationRequest {
39
41
  orgId: string;
@@ -212,6 +212,12 @@ class RulesApi extends runtime.BaseAPI {
212
212
  if (requestParameters['brandScope'] != null) {
213
213
  queryParameters['brandScope'] = requestParameters['brandScope'];
214
214
  }
215
+ if (requestParameters['carrierId'] != null) {
216
+ queryParameters['carrierId'] = requestParameters['carrierId'];
217
+ }
218
+ if (requestParameters['search'] != null) {
219
+ queryParameters['search'] = requestParameters['search'];
220
+ }
215
221
  const headerParameters = {};
216
222
  if (this.configuration && this.configuration.accessToken) {
217
223
  const token = this.configuration.accessToken;
@@ -62,6 +62,9 @@ export interface ListShipmentsRequest {
62
62
  limit?: number;
63
63
  brandId?: string;
64
64
  brandScope?: ListShipmentsBrandScopeEnum;
65
+ status?: ListShipmentsStatusEnum;
66
+ type?: ListShipmentsTypeEnum;
67
+ search?: string;
65
68
  }
66
69
  export interface SendShipmentRequest {
67
70
  orgId: string;
@@ -290,3 +293,25 @@ export declare const ListShipmentsBrandScopeEnum: {
290
293
  readonly Both: "both";
291
294
  };
292
295
  export type ListShipmentsBrandScopeEnum = typeof ListShipmentsBrandScopeEnum[keyof typeof ListShipmentsBrandScopeEnum];
296
+ /**
297
+ * @export
298
+ */
299
+ export declare const ListShipmentsStatusEnum: {
300
+ readonly Draft: "draft";
301
+ readonly Pending: "pending";
302
+ readonly Processing: "processing";
303
+ readonly Dispatched: "dispatched";
304
+ readonly PartlyDispatched: "partly_dispatched";
305
+ readonly Error: "error";
306
+ readonly Cancelled: "cancelled";
307
+ readonly OnHold: "on_hold";
308
+ };
309
+ export type ListShipmentsStatusEnum = typeof ListShipmentsStatusEnum[keyof typeof ListShipmentsStatusEnum];
310
+ /**
311
+ * @export
312
+ */
313
+ export declare const ListShipmentsTypeEnum: {
314
+ readonly Outbound: "outbound";
315
+ readonly Inbound: "inbound";
316
+ };
317
+ export type ListShipmentsTypeEnum = typeof ListShipmentsTypeEnum[keyof typeof ListShipmentsTypeEnum];
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.ListShipmentsBrandScopeEnum = exports.GetShipmentDocumentContentDispositionEnum = exports.ShipmentsApi = void 0;
25
+ exports.ListShipmentsTypeEnum = exports.ListShipmentsStatusEnum = exports.ListShipmentsBrandScopeEnum = exports.GetShipmentDocumentContentDispositionEnum = exports.ShipmentsApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const BatchSendShipments200Response_1 = require("../models/BatchSendShipments200Response");
28
28
  const BatchSendShipmentsRequest_1 = require("../models/BatchSendShipmentsRequest");
@@ -443,6 +443,15 @@ class ShipmentsApi extends runtime.BaseAPI {
443
443
  if (requestParameters['brandScope'] != null) {
444
444
  queryParameters['brandScope'] = requestParameters['brandScope'];
445
445
  }
446
+ if (requestParameters['status'] != null) {
447
+ queryParameters['status'] = requestParameters['status'];
448
+ }
449
+ if (requestParameters['type'] != null) {
450
+ queryParameters['type'] = requestParameters['type'];
451
+ }
452
+ if (requestParameters['search'] != null) {
453
+ queryParameters['search'] = requestParameters['search'];
454
+ }
446
455
  const headerParameters = {};
447
456
  if (this.configuration && this.configuration.accessToken) {
448
457
  const token = this.configuration.accessToken;
@@ -774,3 +783,23 @@ exports.ListShipmentsBrandScopeEnum = {
774
783
  Shared: 'shared',
775
784
  Both: 'both'
776
785
  };
786
+ /**
787
+ * @export
788
+ */
789
+ exports.ListShipmentsStatusEnum = {
790
+ Draft: 'draft',
791
+ Pending: 'pending',
792
+ Processing: 'processing',
793
+ Dispatched: 'dispatched',
794
+ PartlyDispatched: 'partly_dispatched',
795
+ Error: 'error',
796
+ Cancelled: 'cancelled',
797
+ OnHold: 'on_hold'
798
+ };
799
+ /**
800
+ * @export
801
+ */
802
+ exports.ListShipmentsTypeEnum = {
803
+ Outbound: 'outbound',
804
+ Inbound: 'inbound'
805
+ };
@@ -41,6 +41,8 @@ export interface ListOrgWebhooksRequest {
41
41
  limit?: number;
42
42
  brandId?: string;
43
43
  brandScope?: ListOrgWebhooksBrandScopeEnum;
44
+ isActive?: string;
45
+ search?: string;
44
46
  }
45
47
  export interface TestOrgWebhookRequest {
46
48
  orgId: string;
@@ -271,6 +271,12 @@ class WebhooksApi extends runtime.BaseAPI {
271
271
  if (requestParameters['brandScope'] != null) {
272
272
  queryParameters['brandScope'] = requestParameters['brandScope'];
273
273
  }
274
+ if (requestParameters['isActive'] != null) {
275
+ queryParameters['isActive'] = requestParameters['isActive'];
276
+ }
277
+ if (requestParameters['search'] != null) {
278
+ queryParameters['search'] = requestParameters['search'];
279
+ }
274
280
  const headerParameters = {};
275
281
  if (this.configuration && this.configuration.accessToken) {
276
282
  const token = this.configuration.accessToken;
@@ -31,6 +31,8 @@ export interface ListAddressesRequest {
31
31
  page?: number;
32
32
  limit?: number;
33
33
  type?: ListAddressesTypeEnum;
34
+ countryCode?: string;
35
+ search?: string;
34
36
  brandId?: string;
35
37
  brandScope?: ListAddressesBrandScopeEnum;
36
38
  }
@@ -209,6 +209,12 @@ export class AddressesApi extends runtime.BaseAPI {
209
209
  if (requestParameters['type'] != null) {
210
210
  queryParameters['type'] = requestParameters['type'];
211
211
  }
212
+ if (requestParameters['countryCode'] != null) {
213
+ queryParameters['countryCode'] = requestParameters['countryCode'];
214
+ }
215
+ if (requestParameters['search'] != null) {
216
+ queryParameters['search'] = requestParameters['search'];
217
+ }
212
218
  if (requestParameters['brandId'] != null) {
213
219
  queryParameters['brandId'] = requestParameters['brandId'];
214
220
  }
@@ -45,6 +45,8 @@ export interface ListCarriersRequest {
45
45
  limit?: number;
46
46
  brandId?: string;
47
47
  brandScope?: ListCarriersBrandScopeEnum;
48
+ carrierSlug?: string;
49
+ search?: string;
48
50
  }
49
51
  export interface UpdateCarrierOperationRequest {
50
52
  orgId: string;
@@ -328,6 +328,12 @@ export class CarriersApi extends runtime.BaseAPI {
328
328
  if (requestParameters['brandScope'] != null) {
329
329
  queryParameters['brandScope'] = requestParameters['brandScope'];
330
330
  }
331
+ if (requestParameters['carrierSlug'] != null) {
332
+ queryParameters['carrierSlug'] = requestParameters['carrierSlug'];
333
+ }
334
+ if (requestParameters['search'] != null) {
335
+ queryParameters['search'] = requestParameters['search'];
336
+ }
331
337
  const headerParameters = {};
332
338
  if (this.configuration && this.configuration.accessToken) {
333
339
  const token = this.configuration.accessToken;
@@ -34,6 +34,8 @@ export interface ListShippingRulesRequest {
34
34
  limit?: number;
35
35
  brandId?: string;
36
36
  brandScope?: ListShippingRulesBrandScopeEnum;
37
+ carrierId?: string;
38
+ search?: string;
37
39
  }
38
40
  export interface UpdateShippingRuleOperationRequest {
39
41
  orgId: string;
@@ -209,6 +209,12 @@ export class RulesApi extends runtime.BaseAPI {
209
209
  if (requestParameters['brandScope'] != null) {
210
210
  queryParameters['brandScope'] = requestParameters['brandScope'];
211
211
  }
212
+ if (requestParameters['carrierId'] != null) {
213
+ queryParameters['carrierId'] = requestParameters['carrierId'];
214
+ }
215
+ if (requestParameters['search'] != null) {
216
+ queryParameters['search'] = requestParameters['search'];
217
+ }
212
218
  const headerParameters = {};
213
219
  if (this.configuration && this.configuration.accessToken) {
214
220
  const token = this.configuration.accessToken;
@@ -62,6 +62,9 @@ export interface ListShipmentsRequest {
62
62
  limit?: number;
63
63
  brandId?: string;
64
64
  brandScope?: ListShipmentsBrandScopeEnum;
65
+ status?: ListShipmentsStatusEnum;
66
+ type?: ListShipmentsTypeEnum;
67
+ search?: string;
65
68
  }
66
69
  export interface SendShipmentRequest {
67
70
  orgId: string;
@@ -290,3 +293,25 @@ export declare const ListShipmentsBrandScopeEnum: {
290
293
  readonly Both: "both";
291
294
  };
292
295
  export type ListShipmentsBrandScopeEnum = typeof ListShipmentsBrandScopeEnum[keyof typeof ListShipmentsBrandScopeEnum];
296
+ /**
297
+ * @export
298
+ */
299
+ export declare const ListShipmentsStatusEnum: {
300
+ readonly Draft: "draft";
301
+ readonly Pending: "pending";
302
+ readonly Processing: "processing";
303
+ readonly Dispatched: "dispatched";
304
+ readonly PartlyDispatched: "partly_dispatched";
305
+ readonly Error: "error";
306
+ readonly Cancelled: "cancelled";
307
+ readonly OnHold: "on_hold";
308
+ };
309
+ export type ListShipmentsStatusEnum = typeof ListShipmentsStatusEnum[keyof typeof ListShipmentsStatusEnum];
310
+ /**
311
+ * @export
312
+ */
313
+ export declare const ListShipmentsTypeEnum: {
314
+ readonly Outbound: "outbound";
315
+ readonly Inbound: "inbound";
316
+ };
317
+ export type ListShipmentsTypeEnum = typeof ListShipmentsTypeEnum[keyof typeof ListShipmentsTypeEnum];
@@ -440,6 +440,15 @@ export class ShipmentsApi extends runtime.BaseAPI {
440
440
  if (requestParameters['brandScope'] != null) {
441
441
  queryParameters['brandScope'] = requestParameters['brandScope'];
442
442
  }
443
+ if (requestParameters['status'] != null) {
444
+ queryParameters['status'] = requestParameters['status'];
445
+ }
446
+ if (requestParameters['type'] != null) {
447
+ queryParameters['type'] = requestParameters['type'];
448
+ }
449
+ if (requestParameters['search'] != null) {
450
+ queryParameters['search'] = requestParameters['search'];
451
+ }
443
452
  const headerParameters = {};
444
453
  if (this.configuration && this.configuration.accessToken) {
445
454
  const token = this.configuration.accessToken;
@@ -770,3 +779,23 @@ export const ListShipmentsBrandScopeEnum = {
770
779
  Shared: 'shared',
771
780
  Both: 'both'
772
781
  };
782
+ /**
783
+ * @export
784
+ */
785
+ export const ListShipmentsStatusEnum = {
786
+ Draft: 'draft',
787
+ Pending: 'pending',
788
+ Processing: 'processing',
789
+ Dispatched: 'dispatched',
790
+ PartlyDispatched: 'partly_dispatched',
791
+ Error: 'error',
792
+ Cancelled: 'cancelled',
793
+ OnHold: 'on_hold'
794
+ };
795
+ /**
796
+ * @export
797
+ */
798
+ export const ListShipmentsTypeEnum = {
799
+ Outbound: 'outbound',
800
+ Inbound: 'inbound'
801
+ };
@@ -41,6 +41,8 @@ export interface ListOrgWebhooksRequest {
41
41
  limit?: number;
42
42
  brandId?: string;
43
43
  brandScope?: ListOrgWebhooksBrandScopeEnum;
44
+ isActive?: string;
45
+ search?: string;
44
46
  }
45
47
  export interface TestOrgWebhookRequest {
46
48
  orgId: string;
@@ -268,6 +268,12 @@ export class WebhooksApi extends runtime.BaseAPI {
268
268
  if (requestParameters['brandScope'] != null) {
269
269
  queryParameters['brandScope'] = requestParameters['brandScope'];
270
270
  }
271
+ if (requestParameters['isActive'] != null) {
272
+ queryParameters['isActive'] = requestParameters['isActive'];
273
+ }
274
+ if (requestParameters['search'] != null) {
275
+ queryParameters['search'] = requestParameters['search'];
276
+ }
271
277
  const headerParameters = {};
272
278
  if (this.configuration && this.configuration.accessToken) {
273
279
  const token = this.configuration.accessToken;
@@ -120,6 +120,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
120
120
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
121
121
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
122
122
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
123
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
123
124
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
124
125
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
125
126
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -84,6 +84,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
84
84
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
85
85
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
86
86
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
87
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
87
88
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
88
89
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
89
90
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -27,6 +27,12 @@ export interface GetBillingUsage200ResponseZippyMessages {
27
27
  * @memberof GetBillingUsage200ResponseZippyMessages
28
28
  */
29
29
  charges: number;
30
+ /**
31
+ * Maximum Zippy messages per month (-1 for unlimited)
32
+ * @type {number}
33
+ * @memberof GetBillingUsage200ResponseZippyMessages
34
+ */
35
+ limit: number;
30
36
  }
31
37
  /**
32
38
  * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
@@ -19,6 +19,8 @@ export function instanceOfGetBillingUsage200ResponseZippyMessages(value) {
19
19
  return false;
20
20
  if (!('charges' in value) || value['charges'] === undefined)
21
21
  return false;
22
+ if (!('limit' in value) || value['limit'] === undefined)
23
+ return false;
22
24
  return true;
23
25
  }
24
26
  export function GetBillingUsage200ResponseZippyMessagesFromJSON(json) {
@@ -31,6 +33,7 @@ export function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, ignor
31
33
  return {
32
34
  'used': json['used'],
33
35
  'charges': json['charges'],
36
+ 'limit': json['limit'],
34
37
  };
35
38
  }
36
39
  export function GetBillingUsage200ResponseZippyMessagesToJSON(json) {
@@ -43,5 +46,6 @@ export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value, ignore
43
46
  return {
44
47
  'used': value['used'],
45
48
  'charges': value['charges'],
49
+ 'limit': value['limit'],
46
50
  };
47
51
  }
@@ -98,6 +98,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
98
98
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
99
99
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
100
100
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
101
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
101
102
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
102
103
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
103
104
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -75,6 +75,7 @@ export const ListApiTokens401ResponseCodeEnum = {
75
75
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
76
76
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
77
77
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
78
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
78
79
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
79
80
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
80
81
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -105,6 +105,7 @@ export declare const SendShipment422ResponseCodeEnum: {
105
105
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
106
106
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
107
107
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
108
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
108
109
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
109
110
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
110
111
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -76,6 +76,7 @@ export const SendShipment422ResponseCodeEnum = {
76
76
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
77
77
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
78
78
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
79
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
79
80
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
80
81
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
81
82
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -120,6 +120,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
120
120
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
121
121
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
122
122
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
123
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
123
124
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
124
125
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
125
126
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -92,6 +92,7 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
92
92
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
93
93
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
94
94
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
95
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
95
96
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
96
97
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
97
98
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -27,6 +27,12 @@ export interface GetBillingUsage200ResponseZippyMessages {
27
27
  * @memberof GetBillingUsage200ResponseZippyMessages
28
28
  */
29
29
  charges: number;
30
+ /**
31
+ * Maximum Zippy messages per month (-1 for unlimited)
32
+ * @type {number}
33
+ * @memberof GetBillingUsage200ResponseZippyMessages
34
+ */
35
+ limit: number;
30
36
  }
31
37
  /**
32
38
  * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
@@ -26,6 +26,8 @@ function instanceOfGetBillingUsage200ResponseZippyMessages(value) {
26
26
  return false;
27
27
  if (!('charges' in value) || value['charges'] === undefined)
28
28
  return false;
29
+ if (!('limit' in value) || value['limit'] === undefined)
30
+ return false;
29
31
  return true;
30
32
  }
31
33
  function GetBillingUsage200ResponseZippyMessagesFromJSON(json) {
@@ -38,6 +40,7 @@ function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, ignoreDiscri
38
40
  return {
39
41
  'used': json['used'],
40
42
  'charges': json['charges'],
43
+ 'limit': json['limit'],
41
44
  };
42
45
  }
43
46
  function GetBillingUsage200ResponseZippyMessagesToJSON(json) {
@@ -50,5 +53,6 @@ function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value, ignoreDiscrim
50
53
  return {
51
54
  'used': value['used'],
52
55
  'charges': value['charges'],
56
+ 'limit': value['limit'],
53
57
  };
54
58
  }
@@ -98,6 +98,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
98
98
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
99
99
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
100
100
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
101
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
101
102
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
102
103
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
103
104
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -83,6 +83,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
83
83
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
84
84
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
85
85
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
86
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
86
87
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
87
88
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
88
89
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -105,6 +105,7 @@ export declare const SendShipment422ResponseCodeEnum: {
105
105
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
106
106
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
107
107
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
108
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
108
109
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
109
110
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
110
111
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -84,6 +84,7 @@ exports.SendShipment422ResponseCodeEnum = {
84
84
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
85
85
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
86
86
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
87
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
87
88
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
88
89
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
89
90
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -243,7 +243,7 @@ example().catch(console.error);
243
243
 
244
244
  ## listAddresses
245
245
 
246
- > ListAddresses200Response listAddresses(orgId, page, limit, type, brandId, brandScope)
246
+ > ListAddresses200Response listAddresses(orgId, page, limit, type, countryCode, search, brandId, brandScope)
247
247
 
248
248
  List addresses
249
249
 
@@ -275,6 +275,10 @@ async function example() {
275
275
  limit: 20,
276
276
  // 'sender' | 'pickup' | 'return' | Filter by address type (sender, pickup, return) (optional)
277
277
  type: sender,
278
+ // string | Filter by ISO 3166-1 alpha-2 country code. (optional)
279
+ countryCode: DK,
280
+ // string | Search by address name, contact or city. (optional)
281
+ search: Copenhagen,
278
282
  // string | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. (optional)
279
283
  brandId: brnd_8f3kd92ld0,
280
284
  // 'own' | 'shared' | 'both' | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. (optional)
@@ -302,6 +306,8 @@ example().catch(console.error);
302
306
  | **page** | `number` | Page number (1-based) | [Optional] [Defaults to `1`] |
303
307
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
304
308
  | **type** | `sender`, `pickup`, `return` | Filter by address type (sender, pickup, return) | [Optional] [Defaults to `undefined`] [Enum: sender, pickup, return] |
309
+ | **countryCode** | `string` | Filter by ISO 3166-1 alpha-2 country code. | [Optional] [Defaults to `undefined`] |
310
+ | **search** | `string` | Search by address name, contact or city. | [Optional] [Defaults to `undefined`] |
305
311
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
306
312
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
307
313
 
@@ -403,7 +403,7 @@ example().catch(console.error);
403
403
 
404
404
  ## listCarriers
405
405
 
406
- > ListCarriers200Response listCarriers(orgId, page, limit, brandId, brandScope)
406
+ > ListCarriers200Response listCarriers(orgId, page, limit, brandId, brandScope, carrierSlug, search)
407
407
 
408
408
  List carriers
409
409
 
@@ -437,6 +437,10 @@ async function example() {
437
437
  brandId: brnd_8f3kd92ld0,
438
438
  // 'own' | 'shared' | 'both' | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. (optional)
439
439
  brandScope: own,
440
+ // string | Filter by carrier slug. (optional)
441
+ carrierSlug: gls,
442
+ // string | Search by carrier name. (optional)
443
+ search: PostNord,
440
444
  } satisfies ListCarriersRequest;
441
445
 
442
446
  try {
@@ -461,6 +465,8 @@ example().catch(console.error);
461
465
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
462
466
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
463
467
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
468
+ | **carrierSlug** | `string` | Filter by carrier slug. | [Optional] [Defaults to `undefined`] |
469
+ | **search** | `string` | Search by carrier name. | [Optional] [Defaults to `undefined`] |
464
470
 
465
471
  ### Return type
466
472
 
@@ -9,6 +9,7 @@ Name | Type
9
9
  ------------ | -------------
10
10
  `used` | number
11
11
  `charges` | number
12
+ `limit` | number
12
13
 
13
14
  ## Example
14
15
 
@@ -19,6 +20,7 @@ import type { GetBillingUsage200ResponseZippyMessages } from '@zippendo/sdk'
19
20
  const example = {
20
21
  "used": 42,
21
22
  "charges": 4158,
23
+ "limit": -1,
22
24
  } satisfies GetBillingUsage200ResponseZippyMessages
23
25
 
24
26
  console.log(example)
package/docs/RulesApi.md CHANGED
@@ -243,7 +243,7 @@ example().catch(console.error);
243
243
 
244
244
  ## listShippingRules
245
245
 
246
- > ListShippingRules200Response listShippingRules(orgId, page, limit, brandId, brandScope)
246
+ > ListShippingRules200Response listShippingRules(orgId, page, limit, brandId, brandScope, carrierId, search)
247
247
 
248
248
  List shipping rules
249
249
 
@@ -277,6 +277,10 @@ async function example() {
277
277
  brandId: brnd_8f3kd92ld0,
278
278
  // 'own' | 'shared' | 'both' | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. (optional)
279
279
  brandScope: own,
280
+ // string | Filter by carrier. (optional)
281
+ carrierId: carr_01HZX9K2QF,
282
+ // string | Search by rule name. (optional)
283
+ search: Home delivery,
280
284
  } satisfies ListShippingRulesRequest;
281
285
 
282
286
  try {
@@ -301,6 +305,8 @@ example().catch(console.error);
301
305
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
302
306
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
303
307
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
308
+ | **carrierId** | `string` | Filter by carrier. | [Optional] [Defaults to `undefined`] |
309
+ | **search** | `string` | Search by rule name. | [Optional] [Defaults to `undefined`] |
304
310
 
305
311
  ### Return type
306
312
 
@@ -568,7 +568,7 @@ example().catch(console.error);
568
568
 
569
569
  ## listShipments
570
570
 
571
- > ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope)
571
+ > ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search)
572
572
 
573
573
  List shipments
574
574
 
@@ -602,6 +602,12 @@ async function example() {
602
602
  brandId: brnd_8f3kd92ld0,
603
603
  // 'own' | 'shared' | 'both' | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. (optional)
604
604
  brandScope: own,
605
+ // 'draft' | 'pending' | 'processing' | 'dispatched' | 'partly_dispatched' | 'error' | 'cancelled' | 'on_hold' | Filter by shipment status. (optional)
606
+ status: dispatched,
607
+ // 'outbound' | 'inbound' | Filter by direction. (optional)
608
+ type: outbound,
609
+ // string | Search by shipment reference or parcel tracking number. (optional)
610
+ search: SHIP-1042,
605
611
  } satisfies ListShipmentsRequest;
606
612
 
607
613
  try {
@@ -626,6 +632,9 @@ example().catch(console.error);
626
632
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
627
633
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
628
634
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
635
+ | **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
+ | **type** | `outbound`, `inbound` | Filter by direction. | [Optional] [Defaults to `undefined`] [Enum: outbound, inbound] |
637
+ | **search** | `string` | Search by shipment reference or parcel tracking number. | [Optional] [Defaults to `undefined`] |
629
638
 
630
639
  ### Return type
631
640
 
@@ -330,7 +330,7 @@ example().catch(console.error);
330
330
 
331
331
  ## listOrgWebhooks
332
332
 
333
- > ListOrgWebhooks200Response listOrgWebhooks(orgId, page, limit, brandId, brandScope)
333
+ > ListOrgWebhooks200Response listOrgWebhooks(orgId, page, limit, brandId, brandScope, isActive, search)
334
334
 
335
335
  List webhooks
336
336
 
@@ -364,6 +364,10 @@ async function example() {
364
364
  brandId: brnd_8f3kd92ld0,
365
365
  // 'own' | 'shared' | 'both' | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. (optional)
366
366
  brandScope: own,
367
+ // string | Filter by active state. (optional)
368
+ isActive: true,
369
+ // string | Search by webhook name or URL. (optional)
370
+ search: fulfilment,
367
371
  } satisfies ListOrgWebhooksRequest;
368
372
 
369
373
  try {
@@ -388,6 +392,8 @@ example().catch(console.error);
388
392
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
389
393
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
390
394
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
395
+ | **isActive** | `string` | Filter by active state. | [Optional] [Defaults to `undefined`] |
396
+ | **search** | `string` | Search by webhook name or URL. | [Optional] [Defaults to `undefined`] |
391
397
 
392
398
  ### Return type
393
399
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -59,6 +59,8 @@ export interface ListAddressesRequest {
59
59
  page?: number;
60
60
  limit?: number;
61
61
  type?: ListAddressesTypeEnum;
62
+ countryCode?: string;
63
+ search?: string;
62
64
  brandId?: string;
63
65
  brandScope?: ListAddressesBrandScopeEnum;
64
66
  }
@@ -294,6 +296,14 @@ export class AddressesApi extends runtime.BaseAPI {
294
296
  queryParameters['type'] = requestParameters['type'];
295
297
  }
296
298
 
299
+ if (requestParameters['countryCode'] != null) {
300
+ queryParameters['countryCode'] = requestParameters['countryCode'];
301
+ }
302
+
303
+ if (requestParameters['search'] != null) {
304
+ queryParameters['search'] = requestParameters['search'];
305
+ }
306
+
297
307
  if (requestParameters['brandId'] != null) {
298
308
  queryParameters['brandId'] = requestParameters['brandId'];
299
309
  }
@@ -87,6 +87,8 @@ export interface ListCarriersRequest {
87
87
  limit?: number;
88
88
  brandId?: string;
89
89
  brandScope?: ListCarriersBrandScopeEnum;
90
+ carrierSlug?: string;
91
+ search?: string;
90
92
  }
91
93
 
92
94
  export interface UpdateCarrierOperationRequest {
@@ -468,6 +470,14 @@ export class CarriersApi extends runtime.BaseAPI {
468
470
  queryParameters['brandScope'] = requestParameters['brandScope'];
469
471
  }
470
472
 
473
+ if (requestParameters['carrierSlug'] != null) {
474
+ queryParameters['carrierSlug'] = requestParameters['carrierSlug'];
475
+ }
476
+
477
+ if (requestParameters['search'] != null) {
478
+ queryParameters['search'] = requestParameters['search'];
479
+ }
480
+
471
481
  const headerParameters: runtime.HTTPHeaders = {};
472
482
 
473
483
  if (this.configuration && this.configuration.accessToken) {
@@ -70,6 +70,8 @@ export interface ListShippingRulesRequest {
70
70
  limit?: number;
71
71
  brandId?: string;
72
72
  brandScope?: ListShippingRulesBrandScopeEnum;
73
+ carrierId?: string;
74
+ search?: string;
73
75
  }
74
76
 
75
77
  export interface UpdateShippingRuleOperationRequest {
@@ -303,6 +305,14 @@ export class RulesApi extends runtime.BaseAPI {
303
305
  queryParameters['brandScope'] = requestParameters['brandScope'];
304
306
  }
305
307
 
308
+ if (requestParameters['carrierId'] != null) {
309
+ queryParameters['carrierId'] = requestParameters['carrierId'];
310
+ }
311
+
312
+ if (requestParameters['search'] != null) {
313
+ queryParameters['search'] = requestParameters['search'];
314
+ }
315
+
306
316
  const headerParameters: runtime.HTTPHeaders = {};
307
317
 
308
318
  if (this.configuration && this.configuration.accessToken) {
@@ -139,6 +139,9 @@ export interface ListShipmentsRequest {
139
139
  limit?: number;
140
140
  brandId?: string;
141
141
  brandScope?: ListShipmentsBrandScopeEnum;
142
+ status?: ListShipmentsStatusEnum;
143
+ type?: ListShipmentsTypeEnum;
144
+ search?: string;
142
145
  }
143
146
 
144
147
  export interface SendShipmentRequest {
@@ -673,6 +676,18 @@ export class ShipmentsApi extends runtime.BaseAPI {
673
676
  queryParameters['brandScope'] = requestParameters['brandScope'];
674
677
  }
675
678
 
679
+ if (requestParameters['status'] != null) {
680
+ queryParameters['status'] = requestParameters['status'];
681
+ }
682
+
683
+ if (requestParameters['type'] != null) {
684
+ queryParameters['type'] = requestParameters['type'];
685
+ }
686
+
687
+ if (requestParameters['search'] != null) {
688
+ queryParameters['search'] = requestParameters['search'];
689
+ }
690
+
676
691
  const headerParameters: runtime.HTTPHeaders = {};
677
692
 
678
693
  if (this.configuration && this.configuration.accessToken) {
@@ -1079,3 +1094,25 @@ export const ListShipmentsBrandScopeEnum = {
1079
1094
  Both: 'both'
1080
1095
  } as const;
1081
1096
  export type ListShipmentsBrandScopeEnum = typeof ListShipmentsBrandScopeEnum[keyof typeof ListShipmentsBrandScopeEnum];
1097
+ /**
1098
+ * @export
1099
+ */
1100
+ export const ListShipmentsStatusEnum = {
1101
+ Draft: 'draft',
1102
+ Pending: 'pending',
1103
+ Processing: 'processing',
1104
+ Dispatched: 'dispatched',
1105
+ PartlyDispatched: 'partly_dispatched',
1106
+ Error: 'error',
1107
+ Cancelled: 'cancelled',
1108
+ OnHold: 'on_hold'
1109
+ } as const;
1110
+ export type ListShipmentsStatusEnum = typeof ListShipmentsStatusEnum[keyof typeof ListShipmentsStatusEnum];
1111
+ /**
1112
+ * @export
1113
+ */
1114
+ export const ListShipmentsTypeEnum = {
1115
+ Outbound: 'outbound',
1116
+ Inbound: 'inbound'
1117
+ } as const;
1118
+ export type ListShipmentsTypeEnum = typeof ListShipmentsTypeEnum[keyof typeof ListShipmentsTypeEnum];
@@ -82,6 +82,8 @@ export interface ListOrgWebhooksRequest {
82
82
  limit?: number;
83
83
  brandId?: string;
84
84
  brandScope?: ListOrgWebhooksBrandScopeEnum;
85
+ isActive?: string;
86
+ search?: string;
85
87
  }
86
88
 
87
89
  export interface TestOrgWebhookRequest {
@@ -391,6 +393,14 @@ export class WebhooksApi extends runtime.BaseAPI {
391
393
  queryParameters['brandScope'] = requestParameters['brandScope'];
392
394
  }
393
395
 
396
+ if (requestParameters['isActive'] != null) {
397
+ queryParameters['isActive'] = requestParameters['isActive'];
398
+ }
399
+
400
+ if (requestParameters['search'] != null) {
401
+ queryParameters['search'] = requestParameters['search'];
402
+ }
403
+
394
404
  const headerParameters: runtime.HTTPHeaders = {};
395
405
 
396
406
  if (this.configuration && this.configuration.accessToken) {
@@ -134,6 +134,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
134
134
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
135
135
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
136
136
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
137
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
137
138
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
138
139
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
139
140
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -31,6 +31,12 @@ export interface GetBillingUsage200ResponseZippyMessages {
31
31
  * @memberof GetBillingUsage200ResponseZippyMessages
32
32
  */
33
33
  charges: number;
34
+ /**
35
+ * Maximum Zippy messages per month (-1 for unlimited)
36
+ * @type {number}
37
+ * @memberof GetBillingUsage200ResponseZippyMessages
38
+ */
39
+ limit: number;
34
40
  }
35
41
 
36
42
  /**
@@ -39,6 +45,7 @@ export interface GetBillingUsage200ResponseZippyMessages {
39
45
  export function instanceOfGetBillingUsage200ResponseZippyMessages(value: object): value is GetBillingUsage200ResponseZippyMessages {
40
46
  if (!('used' in value) || value['used'] === undefined) return false;
41
47
  if (!('charges' in value) || value['charges'] === undefined) return false;
48
+ if (!('limit' in value) || value['limit'] === undefined) return false;
42
49
  return true;
43
50
  }
44
51
 
@@ -54,6 +61,7 @@ export function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json: any,
54
61
 
55
62
  'used': json['used'],
56
63
  'charges': json['charges'],
64
+ 'limit': json['limit'],
57
65
  };
58
66
  }
59
67
 
@@ -70,6 +78,7 @@ export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBi
70
78
 
71
79
  'used': value['used'],
72
80
  'charges': value['charges'],
81
+ 'limit': value['limit'],
73
82
  };
74
83
  }
75
84
 
@@ -104,6 +104,7 @@ export const ListApiTokens401ResponseCodeEnum = {
104
104
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
105
105
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
106
106
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
107
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
107
108
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
108
109
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
109
110
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -118,6 +118,7 @@ export const SendShipment422ResponseCodeEnum = {
118
118
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
119
119
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
120
120
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
121
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
121
122
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
122
123
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
123
124
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',