@zippendo/sdk 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +6 -3
  2. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +4 -1
  3. package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +8 -2
  4. package/dist/esm/models/BatchSendShipments200ResponseSummary.js +4 -0
  5. package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.d.ts +6 -0
  6. package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.js +4 -0
  7. package/dist/esm/models/ListApiTokens401Response.d.ts +2 -0
  8. package/dist/esm/models/ListApiTokens401Response.js +2 -0
  9. package/dist/esm/models/SendShipment422Response.d.ts +2 -0
  10. package/dist/esm/models/SendShipment422Response.js +2 -0
  11. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +6 -3
  12. package/dist/models/BatchSendShipments200ResponseResultsInner.js +4 -1
  13. package/dist/models/BatchSendShipments200ResponseSummary.d.ts +8 -2
  14. package/dist/models/BatchSendShipments200ResponseSummary.js +4 -0
  15. package/dist/models/GetBillingUsage200ResponseZippyMessages.d.ts +6 -0
  16. package/dist/models/GetBillingUsage200ResponseZippyMessages.js +4 -0
  17. package/dist/models/ListApiTokens401Response.d.ts +2 -0
  18. package/dist/models/ListApiTokens401Response.js +2 -0
  19. package/dist/models/SendShipment422Response.d.ts +2 -0
  20. package/dist/models/SendShipment422Response.js +2 -0
  21. package/docs/BatchSendShipments200ResponseSummary.md +2 -0
  22. package/docs/GetBillingUsage200ResponseZippyMessages.md +2 -0
  23. package/package.json +1 -1
  24. package/src/models/BatchSendShipments200ResponseResultsInner.ts +7 -4
  25. package/src/models/BatchSendShipments200ResponseSummary.ts +11 -2
  26. package/src/models/GetBillingUsage200ResponseZippyMessages.ts +9 -0
  27. package/src/models/ListApiTokens401Response.ts +2 -0
  28. package/src/models/SendShipment422Response.ts +2 -0
package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts CHANGED
@@ -23,19 +23,19 @@ export interface BatchSendShipments200ResponseResultsInner {
23
23
  */
24
24
  shipmentId: string;
25
25
  /**
26
- * Whether this shipment was successfully booked with its carrier.
26
+ * `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
27
27
  * @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
28
28
  * @memberof BatchSendShipments200ResponseResultsInner
29
29
  */
30
30
  status: BatchSendShipments200ResponseResultsInnerStatusEnum;
31
31
  /**
32
- * Canonical machine-readable error code, present when `status` is `failed`.
32
+ * Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
33
33
  * @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
34
34
  * @memberof BatchSendShipments200ResponseResultsInner
35
35
  */
36
36
  code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
37
37
  /**
38
- * Human-readable failure detail, present when `status` is `failed`.
38
+ * Human-readable detail, present when `status` is `failed` or `skipped`.
39
39
  * @type {string}
40
40
  * @memberof BatchSendShipments200ResponseResultsInner
41
41
  */
@@ -53,6 +53,7 @@ export interface BatchSendShipments200ResponseResultsInner {
53
53
  export declare const BatchSendShipments200ResponseResultsInnerStatusEnum: {
54
54
  readonly Sent: "sent";
55
55
  readonly Failed: "failed";
56
+ readonly Skipped: "skipped";
56
57
  };
57
58
  export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
58
59
  /**
@@ -119,11 +120,13 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
119
120
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
120
121
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
121
122
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
123
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
122
124
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
123
125
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
124
126
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
125
127
  readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
126
128
  readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
129
+ readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
127
130
  readonly ParcelNotFound: "PARCEL_NOT_FOUND";
128
131
  readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
129
132
  readonly PickupNotFound: "PICKUP_NOT_FOUND";
package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js CHANGED
@@ -17,7 +17,8 @@ import { SendShipment422ResponseErrorsInnerFromJSON, SendShipment422ResponseErro
17
17
  */
18
18
  export const BatchSendShipments200ResponseResultsInnerStatusEnum = {
19
19
  Sent: 'sent',
20
- Failed: 'failed'
20
+ Failed: 'failed',
21
+ Skipped: 'skipped'
21
22
  };
22
23
  /**
23
24
  * @export
@@ -83,11 +84,13 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
83
84
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
84
85
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
85
86
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
87
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
86
88
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
87
89
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
88
90
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
89
91
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
90
92
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
93
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
91
94
  ParcelNotFound: 'PARCEL_NOT_FOUND',
92
95
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
93
96
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts CHANGED
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface BatchSendShipments200ResponseSummary {
18
18
  /**
19
- * Number of unique shipments processed.
19
+ * Number of unique shipments requested.
20
20
  * @type {number}
21
21
  * @memberof BatchSendShipments200ResponseSummary
22
22
  */
@@ -28,11 +28,17 @@ export interface BatchSendShipments200ResponseSummary {
28
28
  */
29
29
  sent: number;
30
30
  /**
31
- * How many failed.
31
+ * How many the carrier or Zippendo rejected.
32
32
  * @type {number}
33
33
  * @memberof BatchSendShipments200ResponseSummary
34
34
  */
35
35
  failed: number;
36
+ /**
37
+ * How many the batch ran out of time to attempt. Submit these again.
38
+ * @type {number}
39
+ * @memberof BatchSendShipments200ResponseSummary
40
+ */
41
+ skipped: number;
36
42
  }
37
43
  /**
38
44
  * Check if a given object implements the BatchSendShipments200ResponseSummary interface.
package/dist/esm/models/BatchSendShipments200ResponseSummary.js CHANGED
@@ -21,6 +21,8 @@ export function instanceOfBatchSendShipments200ResponseSummary(value) {
21
21
  return false;
22
22
  if (!('failed' in value) || value['failed'] === undefined)
23
23
  return false;
24
+ if (!('skipped' in value) || value['skipped'] === undefined)
25
+ return false;
24
26
  return true;
25
27
  }
26
28
  export function BatchSendShipments200ResponseSummaryFromJSON(json) {
@@ -34,6 +36,7 @@ export function BatchSendShipments200ResponseSummaryFromJSONTyped(json, ignoreDi
34
36
  'total': json['total'],
35
37
  'sent': json['sent'],
36
38
  'failed': json['failed'],
39
+ 'skipped': json['skipped'],
37
40
  };
38
41
  }
39
42
  export function BatchSendShipments200ResponseSummaryToJSON(json) {
@@ -47,5 +50,6 @@ export function BatchSendShipments200ResponseSummaryToJSONTyped(value, ignoreDis
47
50
  'total': value['total'],
48
51
  'sent': value['sent'],
49
52
  'failed': value['failed'],
53
+ 'skipped': value['skipped'],
50
54
  };
51
55
  }
package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.d.ts CHANGED
@@ -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.
package/dist/esm/models/GetBillingUsage200ResponseZippyMessages.js CHANGED
@@ -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
  }
package/dist/esm/models/ListApiTokens401Response.d.ts CHANGED
@@ -98,11 +98,13 @@ 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";
104
105
  readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
105
106
  readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
107
+ readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
106
108
  readonly ParcelNotFound: "PARCEL_NOT_FOUND";
107
109
  readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
108
110
  readonly PickupNotFound: "PICKUP_NOT_FOUND";
package/dist/esm/models/ListApiTokens401Response.js CHANGED
@@ -75,11 +75,13 @@ 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',
81
82
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
82
83
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
84
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
83
85
  ParcelNotFound: 'PARCEL_NOT_FOUND',
84
86
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
85
87
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/dist/esm/models/SendShipment422Response.d.ts CHANGED
@@ -105,11 +105,13 @@ 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";
111
112
  readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
112
113
  readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
114
+ readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
113
115
  readonly ParcelNotFound: "PARCEL_NOT_FOUND";
114
116
  readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
115
117
  readonly PickupNotFound: "PICKUP_NOT_FOUND";
package/dist/esm/models/SendShipment422Response.js CHANGED
@@ -76,11 +76,13 @@ 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',
82
83
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
83
84
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
85
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
84
86
  ParcelNotFound: 'PARCEL_NOT_FOUND',
85
87
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
86
88
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts CHANGED
@@ -23,19 +23,19 @@ export interface BatchSendShipments200ResponseResultsInner {
23
23
  */
24
24
  shipmentId: string;
25
25
  /**
26
- * Whether this shipment was successfully booked with its carrier.
26
+ * `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
27
27
  * @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
28
28
  * @memberof BatchSendShipments200ResponseResultsInner
29
29
  */
30
30
  status: BatchSendShipments200ResponseResultsInnerStatusEnum;
31
31
  /**
32
- * Canonical machine-readable error code, present when `status` is `failed`.
32
+ * Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
33
33
  * @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
34
34
  * @memberof BatchSendShipments200ResponseResultsInner
35
35
  */
36
36
  code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
37
37
  /**
38
- * Human-readable failure detail, present when `status` is `failed`.
38
+ * Human-readable detail, present when `status` is `failed` or `skipped`.
39
39
  * @type {string}
40
40
  * @memberof BatchSendShipments200ResponseResultsInner
41
41
  */
@@ -53,6 +53,7 @@ export interface BatchSendShipments200ResponseResultsInner {
53
53
  export declare const BatchSendShipments200ResponseResultsInnerStatusEnum: {
54
54
  readonly Sent: "sent";
55
55
  readonly Failed: "failed";
56
+ readonly Skipped: "skipped";
56
57
  };
57
58
  export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
58
59
  /**
@@ -119,11 +120,13 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
119
120
  readonly BillingManagedByShopify: "BILLING_MANAGED_BY_SHOPIFY";
120
121
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
121
122
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
123
+ readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
122
124
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
123
125
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
124
126
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
125
127
  readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
126
128
  readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
129
+ readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
127
130
  readonly ParcelNotFound: "PARCEL_NOT_FOUND";
128
131
  readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
129
132
  readonly PickupNotFound: "PICKUP_NOT_FOUND";
package/dist/models/BatchSendShipments200ResponseResultsInner.js CHANGED
@@ -25,7 +25,8 @@ const SendShipment422ResponseErrorsInner_1 = require("./SendShipment422ResponseE
25
25
  */
26
26
  exports.BatchSendShipments200ResponseResultsInnerStatusEnum = {
27
27
  Sent: 'sent',
28
- Failed: 'failed'
28
+ Failed: 'failed',
29
+ Skipped: 'skipped'
29
30
  };
30
31
  /**
31
32
  * @export
@@ -91,11 +92,13 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
91
92
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
92
93
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
93
94
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
95
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
94
96
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
95
97
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
96
98
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
97
99
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
98
100
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
101
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
99
102
  ParcelNotFound: 'PARCEL_NOT_FOUND',
100
103
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
101
104
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/dist/models/BatchSendShipments200ResponseSummary.d.ts CHANGED
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface BatchSendShipments200ResponseSummary {
18
18
  /**
19
- * Number of unique shipments processed.
19
+ * Number of unique shipments requested.
20
20
  * @type {number}
21
21
  * @memberof BatchSendShipments200ResponseSummary
22
22
  */
@@ -28,11 +28,17 @@ export interface BatchSendShipments200ResponseSummary {
28
28
  */
29
29
  sent: number;
30
30
  /**
31
- * How many failed.
31
+ * How many the carrier or Zippendo rejected.
32
32
  * @type {number}
33
33
  * @memberof BatchSendShipments200ResponseSummary
34
34
  */
35
35
  failed: number;
36
+ /**
37
+ * How many the batch ran out of time to attempt. Submit these again.
38
+ * @type {number}
39
+ * @memberof BatchSendShipments200ResponseSummary
40
+ */
41
+ skipped: number;
36
42
  }
37
43
  /**
38
44
  * Check if a given object implements the BatchSendShipments200ResponseSummary interface.
package/dist/models/BatchSendShipments200ResponseSummary.js CHANGED
@@ -28,6 +28,8 @@ function instanceOfBatchSendShipments200ResponseSummary(value) {
28
28
  return false;
29
29
  if (!('failed' in value) || value['failed'] === undefined)
30
30
  return false;
31
+ if (!('skipped' in value) || value['skipped'] === undefined)
32
+ return false;
31
33
  return true;
32
34
  }
33
35
  function BatchSendShipments200ResponseSummaryFromJSON(json) {
@@ -41,6 +43,7 @@ function BatchSendShipments200ResponseSummaryFromJSONTyped(json, ignoreDiscrimin
41
43
  'total': json['total'],
42
44
  'sent': json['sent'],
43
45
  'failed': json['failed'],
46
+ 'skipped': json['skipped'],
44
47
  };
45
48
  }
46
49
  function BatchSendShipments200ResponseSummaryToJSON(json) {
@@ -54,5 +57,6 @@ function BatchSendShipments200ResponseSummaryToJSONTyped(value, ignoreDiscrimina
54
57
  'total': value['total'],
55
58
  'sent': value['sent'],
56
59
  'failed': value['failed'],
60
+ 'skipped': value['skipped'],
57
61
  };
58
62
  }
package/dist/models/GetBillingUsage200ResponseZippyMessages.d.ts CHANGED
@@ -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.
package/dist/models/GetBillingUsage200ResponseZippyMessages.js CHANGED
@@ -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
  }
package/dist/models/ListApiTokens401Response.d.ts CHANGED
@@ -98,11 +98,13 @@ 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";
104
105
  readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
105
106
  readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
107
+ readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
106
108
  readonly ParcelNotFound: "PARCEL_NOT_FOUND";
107
109
  readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
108
110
  readonly PickupNotFound: "PICKUP_NOT_FOUND";
package/dist/models/ListApiTokens401Response.js CHANGED
@@ -83,11 +83,13 @@ 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',
89
90
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
90
91
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
92
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
91
93
  ParcelNotFound: 'PARCEL_NOT_FOUND',
92
94
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
93
95
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/dist/models/SendShipment422Response.d.ts CHANGED
@@ -105,11 +105,13 @@ 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";
111
112
  readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
112
113
  readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
114
+ readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
113
115
  readonly ParcelNotFound: "PARCEL_NOT_FOUND";
114
116
  readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
115
117
  readonly PickupNotFound: "PICKUP_NOT_FOUND";
package/dist/models/SendShipment422Response.js CHANGED
@@ -84,11 +84,13 @@ 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',
90
91
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
91
92
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
93
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
92
94
  ParcelNotFound: 'PARCEL_NOT_FOUND',
93
95
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
94
96
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/docs/BatchSendShipments200ResponseSummary.md CHANGED
@@ -10,6 +10,7 @@ Name | Type
10
10
  `total` | number
11
11
  `sent` | number
12
12
  `failed` | number
13
+ `skipped` | number
13
14
 
14
15
  ## Example
15
16
 
@@ -21,6 +22,7 @@ const example = {
21
22
  "total": 3,
22
23
  "sent": 2,
23
24
  "failed": 1,
25
+ "skipped": 0,
24
26
  } satisfies BatchSendShipments200ResponseSummary
25
27
 
26
28
  console.log(example)
package/docs/GetBillingUsage200ResponseZippyMessages.md CHANGED
@@ -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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
package/src/models/BatchSendShipments200ResponseResultsInner.ts CHANGED
@@ -34,19 +34,19 @@ export interface BatchSendShipments200ResponseResultsInner {
34
34
  */
35
35
  shipmentId: string;
36
36
  /**
37
- * Whether this shipment was successfully booked with its carrier.
37
+ * `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
38
38
  * @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
39
39
  * @memberof BatchSendShipments200ResponseResultsInner
40
40
  */
41
41
  status: BatchSendShipments200ResponseResultsInnerStatusEnum;
42
42
  /**
43
- * Canonical machine-readable error code, present when `status` is `failed`.
43
+ * Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
44
44
  * @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
45
45
  * @memberof BatchSendShipments200ResponseResultsInner
46
46
  */
47
47
  code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
48
48
  /**
49
- * Human-readable failure detail, present when `status` is `failed`.
49
+ * Human-readable detail, present when `status` is `failed` or `skipped`.
50
50
  * @type {string}
51
51
  * @memberof BatchSendShipments200ResponseResultsInner
52
52
  */
@@ -65,7 +65,8 @@ export interface BatchSendShipments200ResponseResultsInner {
65
65
  */
66
66
  export const BatchSendShipments200ResponseResultsInnerStatusEnum = {
67
67
  Sent: 'sent',
68
- Failed: 'failed'
68
+ Failed: 'failed',
69
+ Skipped: 'skipped'
69
70
  } as const;
70
71
  export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
71
72
 
@@ -133,11 +134,13 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
133
134
  BillingManagedByShopify: 'BILLING_MANAGED_BY_SHOPIFY',
134
135
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
135
136
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
137
+ ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
136
138
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
137
139
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
138
140
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
139
141
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
140
142
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
143
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
141
144
  ParcelNotFound: 'PARCEL_NOT_FOUND',
142
145
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
143
146
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/src/models/BatchSendShipments200ResponseSummary.ts CHANGED
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface BatchSendShipments200ResponseSummary {
22
22
  /**
23
- * Number of unique shipments processed.
23
+ * Number of unique shipments requested.
24
24
  * @type {number}
25
25
  * @memberof BatchSendShipments200ResponseSummary
26
26
  */
@@ -32,11 +32,17 @@ export interface BatchSendShipments200ResponseSummary {
32
32
  */
33
33
  sent: number;
34
34
  /**
35
- * How many failed.
35
+ * How many the carrier or Zippendo rejected.
36
36
  * @type {number}
37
37
  * @memberof BatchSendShipments200ResponseSummary
38
38
  */
39
39
  failed: number;
40
+ /**
41
+ * How many the batch ran out of time to attempt. Submit these again.
42
+ * @type {number}
43
+ * @memberof BatchSendShipments200ResponseSummary
44
+ */
45
+ skipped: number;
40
46
  }
41
47
 
42
48
  /**
@@ -46,6 +52,7 @@ export function instanceOfBatchSendShipments200ResponseSummary(value: object): v
46
52
  if (!('total' in value) || value['total'] === undefined) return false;
47
53
  if (!('sent' in value) || value['sent'] === undefined) return false;
48
54
  if (!('failed' in value) || value['failed'] === undefined) return false;
55
+ if (!('skipped' in value) || value['skipped'] === undefined) return false;
49
56
  return true;
50
57
  }
51
58
 
@@ -62,6 +69,7 @@ export function BatchSendShipments200ResponseSummaryFromJSONTyped(json: any, ign
62
69
  'total': json['total'],
63
70
  'sent': json['sent'],
64
71
  'failed': json['failed'],
72
+ 'skipped': json['skipped'],
65
73
  };
66
74
  }
67
75
 
@@ -79,6 +87,7 @@ export function BatchSendShipments200ResponseSummaryToJSONTyped(value?: BatchSen
79
87
  'total': value['total'],
80
88
  'sent': value['sent'],
81
89
  'failed': value['failed'],
90
+ 'skipped': value['skipped'],
82
91
  };
83
92
  }
84
93
 
package/src/models/GetBillingUsage200ResponseZippyMessages.ts CHANGED
@@ -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
 
package/src/models/ListApiTokens401Response.ts CHANGED
@@ -104,11 +104,13 @@ 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',
110
111
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
111
112
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
113
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
112
114
  ParcelNotFound: 'PARCEL_NOT_FOUND',
113
115
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
114
116
  PickupNotFound: 'PICKUP_NOT_FOUND',
package/src/models/SendShipment422Response.ts CHANGED
@@ -118,11 +118,13 @@ 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',
124
125
  ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
125
126
  ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
127
+ ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
126
128
  ParcelNotFound: 'PARCEL_NOT_FOUND',
127
129
  ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
128
130
  PickupNotFound: 'PICKUP_NOT_FOUND',