@zippendo/sdk 1.3.4 → 1.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +3 -0
  2. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +3 -0
  3. package/dist/esm/models/GetBillingUsage200Response.d.ts +3 -3
  4. package/dist/esm/models/GetBillingUsage200Response.js +3 -3
  5. package/dist/esm/models/{GetBillingUsage200ResponseZippyMessages.d.ts → GetBillingUsage200ResponseZippyCredits.d.ts} +27 -15
  6. package/dist/esm/models/{GetBillingUsage200ResponseZippyMessages.js → GetBillingUsage200ResponseZippyCredits.js} +16 -8
  7. package/dist/esm/models/ListApiTokens401Response.d.ts +3 -0
  8. package/dist/esm/models/ListApiTokens401Response.js +3 -0
  9. package/dist/esm/models/SendShipment422Response.d.ts +3 -0
  10. package/dist/esm/models/SendShipment422Response.js +3 -0
  11. package/dist/esm/models/index.d.ts +1 -1
  12. package/dist/esm/models/index.js +1 -1
  13. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +3 -0
  14. package/dist/models/BatchSendShipments200ResponseResultsInner.js +3 -0
  15. package/dist/models/GetBillingUsage200Response.d.ts +3 -3
  16. package/dist/models/GetBillingUsage200Response.js +3 -3
  17. package/dist/models/{GetBillingUsage200ResponseZippyMessages.d.ts → GetBillingUsage200ResponseZippyCredits.d.ts} +27 -15
  18. package/dist/models/{GetBillingUsage200ResponseZippyMessages.js → GetBillingUsage200ResponseZippyCredits.js} +21 -13
  19. package/dist/models/ListApiTokens401Response.d.ts +3 -0
  20. package/dist/models/ListApiTokens401Response.js +3 -0
  21. package/dist/models/SendShipment422Response.d.ts +3 -0
  22. package/dist/models/SendShipment422Response.js +3 -0
  23. package/dist/models/index.d.ts +1 -1
  24. package/dist/models/index.js +1 -1
  25. package/docs/GetBillingUsage200Response.md +2 -2
  26. package/docs/{GetBillingUsage200ResponseZippyMessages.md → GetBillingUsage200ResponseZippyCredits.md} +11 -7
  27. package/docs/OrgsApi.md +1 -0
  28. package/package.json +1 -1
  29. package/src/models/BatchSendShipments200ResponseResultsInner.ts +3 -0
  30. package/src/models/GetBillingUsage200Response.ts +11 -11
  31. package/src/models/{GetBillingUsage200ResponseZippyMessages.ts → GetBillingUsage200ResponseZippyCredits.ts} +35 -17
  32. package/src/models/ListApiTokens401Response.ts +3 -0
  33. package/src/models/SendShipment422Response.ts +3 -0
  34. package/src/models/index.ts +1 -1
@@ -124,6 +124,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
124
124
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
125
125
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
126
126
  readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
127
+ readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
128
+ readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
129
+ readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
127
130
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
128
131
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
129
132
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -88,6 +88,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
88
88
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
89
89
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
90
90
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
91
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
92
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
93
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
91
94
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
92
95
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
93
96
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -9,9 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { GetBillingUsage200ResponseZippyMessages } from './GetBillingUsage200ResponseZippyMessages';
13
12
  import type { GetBillingUsage200ResponseAddOnsInner } from './GetBillingUsage200ResponseAddOnsInner';
14
13
  import type { GetBillingUsage200ResponseShipments } from './GetBillingUsage200ResponseShipments';
14
+ import type { GetBillingUsage200ResponseZippyCredits } from './GetBillingUsage200ResponseZippyCredits';
15
15
  import type { GetBillingUsage200ResponseCurrentPeriod } from './GetBillingUsage200ResponseCurrentPeriod';
16
16
  import type { GetBillingUsage200ResponseLimits } from './GetBillingUsage200ResponseLimits';
17
17
  /**
@@ -46,10 +46,10 @@ export interface GetBillingUsage200Response {
46
46
  addOns: Array<GetBillingUsage200ResponseAddOnsInner>;
47
47
  /**
48
48
  *
49
- * @type {GetBillingUsage200ResponseZippyMessages}
49
+ * @type {GetBillingUsage200ResponseZippyCredits}
50
50
  * @memberof GetBillingUsage200Response
51
51
  */
52
- zippyMessages?: GetBillingUsage200ResponseZippyMessages;
52
+ zippyCredits?: GetBillingUsage200ResponseZippyCredits;
53
53
  }
54
54
  /**
55
55
  * Check if a given object implements the GetBillingUsage200Response interface.
@@ -11,9 +11,9 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { GetBillingUsage200ResponseZippyMessagesFromJSON, GetBillingUsage200ResponseZippyMessagesToJSON, } from './GetBillingUsage200ResponseZippyMessages';
15
14
  import { GetBillingUsage200ResponseAddOnsInnerFromJSON, GetBillingUsage200ResponseAddOnsInnerToJSON, } from './GetBillingUsage200ResponseAddOnsInner';
16
15
  import { GetBillingUsage200ResponseShipmentsFromJSON, GetBillingUsage200ResponseShipmentsToJSON, } from './GetBillingUsage200ResponseShipments';
16
+ import { GetBillingUsage200ResponseZippyCreditsFromJSON, GetBillingUsage200ResponseZippyCreditsToJSON, } from './GetBillingUsage200ResponseZippyCredits';
17
17
  import { GetBillingUsage200ResponseCurrentPeriodFromJSON, GetBillingUsage200ResponseCurrentPeriodToJSON, } from './GetBillingUsage200ResponseCurrentPeriod';
18
18
  import { GetBillingUsage200ResponseLimitsFromJSON, GetBillingUsage200ResponseLimitsToJSON, } from './GetBillingUsage200ResponseLimits';
19
19
  /**
@@ -42,7 +42,7 @@ export function GetBillingUsage200ResponseFromJSONTyped(json, ignoreDiscriminato
42
42
  'shipments': GetBillingUsage200ResponseShipmentsFromJSON(json['shipments']),
43
43
  'limits': GetBillingUsage200ResponseLimitsFromJSON(json['limits']),
44
44
  'addOns': (json['addOns'].map(GetBillingUsage200ResponseAddOnsInnerFromJSON)),
45
- 'zippyMessages': json['zippyMessages'] == null ? undefined : GetBillingUsage200ResponseZippyMessagesFromJSON(json['zippyMessages']),
45
+ 'zippyCredits': json['zippyCredits'] == null ? undefined : GetBillingUsage200ResponseZippyCreditsFromJSON(json['zippyCredits']),
46
46
  };
47
47
  }
48
48
  export function GetBillingUsage200ResponseToJSON(json) {
@@ -57,6 +57,6 @@ export function GetBillingUsage200ResponseToJSONTyped(value, ignoreDiscriminator
57
57
  'shipments': GetBillingUsage200ResponseShipmentsToJSON(value['shipments']),
58
58
  'limits': GetBillingUsage200ResponseLimitsToJSON(value['limits']),
59
59
  'addOns': (value['addOns'].map(GetBillingUsage200ResponseAddOnsInnerToJSON)),
60
- 'zippyMessages': GetBillingUsage200ResponseZippyMessagesToJSON(value['zippyMessages']),
60
+ 'zippyCredits': GetBillingUsage200ResponseZippyCreditsToJSON(value['zippyCredits']),
61
61
  };
62
62
  }
@@ -10,35 +10,47 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Zippy AI message usage this period (present when Zippy access is enabled)
13
+ * Zippy AI credit usage this period (present when the Zippy add-on is enabled)
14
14
  * @export
15
- * @interface GetBillingUsage200ResponseZippyMessages
15
+ * @interface GetBillingUsage200ResponseZippyCredits
16
16
  */
17
- export interface GetBillingUsage200ResponseZippyMessages {
17
+ export interface GetBillingUsage200ResponseZippyCredits {
18
18
  /**
19
- * Zippy messages used this period
19
+ * Zippy credits used this period, included bundle and metered alike
20
20
  * @type {number}
21
- * @memberof GetBillingUsage200ResponseZippyMessages
21
+ * @memberof GetBillingUsage200ResponseZippyCredits
22
22
  */
23
23
  used: number;
24
24
  /**
25
- * Zippy message charges so far, in øre
25
+ * Credits included in the add-on bundle this period
26
26
  * @type {number}
27
- * @memberof GetBillingUsage200ResponseZippyMessages
27
+ * @memberof GetBillingUsage200ResponseZippyCredits
28
+ */
29
+ included: number;
30
+ /**
31
+ * Credits beyond the bundle, metered this period
32
+ * @type {number}
33
+ * @memberof GetBillingUsage200ResponseZippyCredits
34
+ */
35
+ billed: number;
36
+ /**
37
+ * Metered credit charges so far, in øre (whole packs)
38
+ * @type {number}
39
+ * @memberof GetBillingUsage200ResponseZippyCredits
28
40
  */
29
41
  charges: number;
30
42
  /**
31
- * Maximum Zippy messages per month (-1 for unlimited)
43
+ * Maximum Zippy credits per month (-1 for unlimited)
32
44
  * @type {number}
33
- * @memberof GetBillingUsage200ResponseZippyMessages
45
+ * @memberof GetBillingUsage200ResponseZippyCredits
34
46
  */
35
47
  limit: number;
36
48
  }
37
49
  /**
38
- * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
50
+ * Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
39
51
  */
40
- export declare function instanceOfGetBillingUsage200ResponseZippyMessages(value: object): value is GetBillingUsage200ResponseZippyMessages;
41
- export declare function GetBillingUsage200ResponseZippyMessagesFromJSON(json: any): GetBillingUsage200ResponseZippyMessages;
42
- export declare function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyMessages;
43
- export declare function GetBillingUsage200ResponseZippyMessagesToJSON(json: any): GetBillingUsage200ResponseZippyMessages;
44
- export declare function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBillingUsage200ResponseZippyMessages | null, ignoreDiscriminator?: boolean): any;
52
+ export declare function instanceOfGetBillingUsage200ResponseZippyCredits(value: object): value is GetBillingUsage200ResponseZippyCredits;
53
+ export declare function GetBillingUsage200ResponseZippyCreditsFromJSON(json: any): GetBillingUsage200ResponseZippyCredits;
54
+ export declare function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyCredits;
55
+ export declare function GetBillingUsage200ResponseZippyCreditsToJSON(json: any): GetBillingUsage200ResponseZippyCredits;
56
+ export declare function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value?: GetBillingUsage200ResponseZippyCredits | null, ignoreDiscriminator?: boolean): any;
@@ -12,39 +12,47 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
15
+ * Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
16
16
  */
17
- export function instanceOfGetBillingUsage200ResponseZippyMessages(value) {
17
+ export function instanceOfGetBillingUsage200ResponseZippyCredits(value) {
18
18
  if (!('used' in value) || value['used'] === undefined)
19
19
  return false;
20
+ if (!('included' in value) || value['included'] === undefined)
21
+ return false;
22
+ if (!('billed' in value) || value['billed'] === undefined)
23
+ return false;
20
24
  if (!('charges' in value) || value['charges'] === undefined)
21
25
  return false;
22
26
  if (!('limit' in value) || value['limit'] === undefined)
23
27
  return false;
24
28
  return true;
25
29
  }
26
- export function GetBillingUsage200ResponseZippyMessagesFromJSON(json) {
27
- return GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, false);
30
+ export function GetBillingUsage200ResponseZippyCreditsFromJSON(json) {
31
+ return GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, false);
28
32
  }
29
- export function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, ignoreDiscriminator) {
33
+ export function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, ignoreDiscriminator) {
30
34
  if (json == null) {
31
35
  return json;
32
36
  }
33
37
  return {
34
38
  'used': json['used'],
39
+ 'included': json['included'],
40
+ 'billed': json['billed'],
35
41
  'charges': json['charges'],
36
42
  'limit': json['limit'],
37
43
  };
38
44
  }
39
- export function GetBillingUsage200ResponseZippyMessagesToJSON(json) {
40
- return GetBillingUsage200ResponseZippyMessagesToJSONTyped(json, false);
45
+ export function GetBillingUsage200ResponseZippyCreditsToJSON(json) {
46
+ return GetBillingUsage200ResponseZippyCreditsToJSONTyped(json, false);
41
47
  }
42
- export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value, ignoreDiscriminator = false) {
48
+ export function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value, ignoreDiscriminator = false) {
43
49
  if (value == null) {
44
50
  return value;
45
51
  }
46
52
  return {
47
53
  'used': value['used'],
54
+ 'included': value['included'],
55
+ 'billed': value['billed'],
48
56
  'charges': value['charges'],
49
57
  'limit': value['limit'],
50
58
  };
@@ -102,6 +102,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
102
102
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
103
103
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
104
104
  readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
105
+ readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
106
+ readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
107
+ readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
105
108
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
106
109
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
107
110
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -79,6 +79,9 @@ export const ListApiTokens401ResponseCodeEnum = {
79
79
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
80
80
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
81
81
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
82
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
83
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
84
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
82
85
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
83
86
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
84
87
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -109,6 +109,9 @@ export declare const SendShipment422ResponseCodeEnum: {
109
109
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
110
110
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
111
111
  readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
112
+ readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
113
+ readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
114
+ readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
112
115
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
113
116
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
114
117
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -80,6 +80,9 @@ export const SendShipment422ResponseCodeEnum = {
80
80
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
81
81
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
82
82
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
83
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
84
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
85
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
83
86
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
84
87
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
85
88
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -71,7 +71,7 @@ export * from './GetBillingUsage200ResponseCurrentPeriod';
71
71
  export * from './GetBillingUsage200ResponseLimits';
72
72
  export * from './GetBillingUsage200ResponseLimitsTeamMembers';
73
73
  export * from './GetBillingUsage200ResponseShipments';
74
- export * from './GetBillingUsage200ResponseZippyMessages';
74
+ export * from './GetBillingUsage200ResponseZippyCredits';
75
75
  export * from './GetOrder200Response';
76
76
  export * from './GetOrder200ResponseOrderLinesInner';
77
77
  export * from './GetOrder200ResponseShipmentsInner';
@@ -73,7 +73,7 @@ export * from './GetBillingUsage200ResponseCurrentPeriod';
73
73
  export * from './GetBillingUsage200ResponseLimits';
74
74
  export * from './GetBillingUsage200ResponseLimitsTeamMembers';
75
75
  export * from './GetBillingUsage200ResponseShipments';
76
- export * from './GetBillingUsage200ResponseZippyMessages';
76
+ export * from './GetBillingUsage200ResponseZippyCredits';
77
77
  export * from './GetOrder200Response';
78
78
  export * from './GetOrder200ResponseOrderLinesInner';
79
79
  export * from './GetOrder200ResponseShipmentsInner';
@@ -124,6 +124,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
124
124
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
125
125
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
126
126
  readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
127
+ readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
128
+ readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
129
+ readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
127
130
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
128
131
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
129
132
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -96,6 +96,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
96
96
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
97
97
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
98
98
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
99
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
100
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
101
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
99
102
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
100
103
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
101
104
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -9,9 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { GetBillingUsage200ResponseZippyMessages } from './GetBillingUsage200ResponseZippyMessages';
13
12
  import type { GetBillingUsage200ResponseAddOnsInner } from './GetBillingUsage200ResponseAddOnsInner';
14
13
  import type { GetBillingUsage200ResponseShipments } from './GetBillingUsage200ResponseShipments';
14
+ import type { GetBillingUsage200ResponseZippyCredits } from './GetBillingUsage200ResponseZippyCredits';
15
15
  import type { GetBillingUsage200ResponseCurrentPeriod } from './GetBillingUsage200ResponseCurrentPeriod';
16
16
  import type { GetBillingUsage200ResponseLimits } from './GetBillingUsage200ResponseLimits';
17
17
  /**
@@ -46,10 +46,10 @@ export interface GetBillingUsage200Response {
46
46
  addOns: Array<GetBillingUsage200ResponseAddOnsInner>;
47
47
  /**
48
48
  *
49
- * @type {GetBillingUsage200ResponseZippyMessages}
49
+ * @type {GetBillingUsage200ResponseZippyCredits}
50
50
  * @memberof GetBillingUsage200Response
51
51
  */
52
- zippyMessages?: GetBillingUsage200ResponseZippyMessages;
52
+ zippyCredits?: GetBillingUsage200ResponseZippyCredits;
53
53
  }
54
54
  /**
55
55
  * Check if a given object implements the GetBillingUsage200Response interface.
@@ -18,9 +18,9 @@ exports.GetBillingUsage200ResponseFromJSON = GetBillingUsage200ResponseFromJSON;
18
18
  exports.GetBillingUsage200ResponseFromJSONTyped = GetBillingUsage200ResponseFromJSONTyped;
19
19
  exports.GetBillingUsage200ResponseToJSON = GetBillingUsage200ResponseToJSON;
20
20
  exports.GetBillingUsage200ResponseToJSONTyped = GetBillingUsage200ResponseToJSONTyped;
21
- const GetBillingUsage200ResponseZippyMessages_1 = require("./GetBillingUsage200ResponseZippyMessages");
22
21
  const GetBillingUsage200ResponseAddOnsInner_1 = require("./GetBillingUsage200ResponseAddOnsInner");
23
22
  const GetBillingUsage200ResponseShipments_1 = require("./GetBillingUsage200ResponseShipments");
23
+ const GetBillingUsage200ResponseZippyCredits_1 = require("./GetBillingUsage200ResponseZippyCredits");
24
24
  const GetBillingUsage200ResponseCurrentPeriod_1 = require("./GetBillingUsage200ResponseCurrentPeriod");
25
25
  const GetBillingUsage200ResponseLimits_1 = require("./GetBillingUsage200ResponseLimits");
26
26
  /**
@@ -49,7 +49,7 @@ function GetBillingUsage200ResponseFromJSONTyped(json, ignoreDiscriminator) {
49
49
  'shipments': (0, GetBillingUsage200ResponseShipments_1.GetBillingUsage200ResponseShipmentsFromJSON)(json['shipments']),
50
50
  'limits': (0, GetBillingUsage200ResponseLimits_1.GetBillingUsage200ResponseLimitsFromJSON)(json['limits']),
51
51
  'addOns': (json['addOns'].map(GetBillingUsage200ResponseAddOnsInner_1.GetBillingUsage200ResponseAddOnsInnerFromJSON)),
52
- 'zippyMessages': json['zippyMessages'] == null ? undefined : (0, GetBillingUsage200ResponseZippyMessages_1.GetBillingUsage200ResponseZippyMessagesFromJSON)(json['zippyMessages']),
52
+ 'zippyCredits': json['zippyCredits'] == null ? undefined : (0, GetBillingUsage200ResponseZippyCredits_1.GetBillingUsage200ResponseZippyCreditsFromJSON)(json['zippyCredits']),
53
53
  };
54
54
  }
55
55
  function GetBillingUsage200ResponseToJSON(json) {
@@ -64,6 +64,6 @@ function GetBillingUsage200ResponseToJSONTyped(value, ignoreDiscriminator = fals
64
64
  'shipments': (0, GetBillingUsage200ResponseShipments_1.GetBillingUsage200ResponseShipmentsToJSON)(value['shipments']),
65
65
  'limits': (0, GetBillingUsage200ResponseLimits_1.GetBillingUsage200ResponseLimitsToJSON)(value['limits']),
66
66
  'addOns': (value['addOns'].map(GetBillingUsage200ResponseAddOnsInner_1.GetBillingUsage200ResponseAddOnsInnerToJSON)),
67
- 'zippyMessages': (0, GetBillingUsage200ResponseZippyMessages_1.GetBillingUsage200ResponseZippyMessagesToJSON)(value['zippyMessages']),
67
+ 'zippyCredits': (0, GetBillingUsage200ResponseZippyCredits_1.GetBillingUsage200ResponseZippyCreditsToJSON)(value['zippyCredits']),
68
68
  };
69
69
  }
@@ -10,35 +10,47 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Zippy AI message usage this period (present when Zippy access is enabled)
13
+ * Zippy AI credit usage this period (present when the Zippy add-on is enabled)
14
14
  * @export
15
- * @interface GetBillingUsage200ResponseZippyMessages
15
+ * @interface GetBillingUsage200ResponseZippyCredits
16
16
  */
17
- export interface GetBillingUsage200ResponseZippyMessages {
17
+ export interface GetBillingUsage200ResponseZippyCredits {
18
18
  /**
19
- * Zippy messages used this period
19
+ * Zippy credits used this period, included bundle and metered alike
20
20
  * @type {number}
21
- * @memberof GetBillingUsage200ResponseZippyMessages
21
+ * @memberof GetBillingUsage200ResponseZippyCredits
22
22
  */
23
23
  used: number;
24
24
  /**
25
- * Zippy message charges so far, in øre
25
+ * Credits included in the add-on bundle this period
26
26
  * @type {number}
27
- * @memberof GetBillingUsage200ResponseZippyMessages
27
+ * @memberof GetBillingUsage200ResponseZippyCredits
28
+ */
29
+ included: number;
30
+ /**
31
+ * Credits beyond the bundle, metered this period
32
+ * @type {number}
33
+ * @memberof GetBillingUsage200ResponseZippyCredits
34
+ */
35
+ billed: number;
36
+ /**
37
+ * Metered credit charges so far, in øre (whole packs)
38
+ * @type {number}
39
+ * @memberof GetBillingUsage200ResponseZippyCredits
28
40
  */
29
41
  charges: number;
30
42
  /**
31
- * Maximum Zippy messages per month (-1 for unlimited)
43
+ * Maximum Zippy credits per month (-1 for unlimited)
32
44
  * @type {number}
33
- * @memberof GetBillingUsage200ResponseZippyMessages
45
+ * @memberof GetBillingUsage200ResponseZippyCredits
34
46
  */
35
47
  limit: number;
36
48
  }
37
49
  /**
38
- * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
50
+ * Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
39
51
  */
40
- export declare function instanceOfGetBillingUsage200ResponseZippyMessages(value: object): value is GetBillingUsage200ResponseZippyMessages;
41
- export declare function GetBillingUsage200ResponseZippyMessagesFromJSON(json: any): GetBillingUsage200ResponseZippyMessages;
42
- export declare function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyMessages;
43
- export declare function GetBillingUsage200ResponseZippyMessagesToJSON(json: any): GetBillingUsage200ResponseZippyMessages;
44
- export declare function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBillingUsage200ResponseZippyMessages | null, ignoreDiscriminator?: boolean): any;
52
+ export declare function instanceOfGetBillingUsage200ResponseZippyCredits(value: object): value is GetBillingUsage200ResponseZippyCredits;
53
+ export declare function GetBillingUsage200ResponseZippyCreditsFromJSON(json: any): GetBillingUsage200ResponseZippyCredits;
54
+ export declare function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyCredits;
55
+ export declare function GetBillingUsage200ResponseZippyCreditsToJSON(json: any): GetBillingUsage200ResponseZippyCredits;
56
+ export declare function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value?: GetBillingUsage200ResponseZippyCredits | null, ignoreDiscriminator?: boolean): any;
@@ -13,45 +13,53 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfGetBillingUsage200ResponseZippyMessages = instanceOfGetBillingUsage200ResponseZippyMessages;
17
- exports.GetBillingUsage200ResponseZippyMessagesFromJSON = GetBillingUsage200ResponseZippyMessagesFromJSON;
18
- exports.GetBillingUsage200ResponseZippyMessagesFromJSONTyped = GetBillingUsage200ResponseZippyMessagesFromJSONTyped;
19
- exports.GetBillingUsage200ResponseZippyMessagesToJSON = GetBillingUsage200ResponseZippyMessagesToJSON;
20
- exports.GetBillingUsage200ResponseZippyMessagesToJSONTyped = GetBillingUsage200ResponseZippyMessagesToJSONTyped;
16
+ exports.instanceOfGetBillingUsage200ResponseZippyCredits = instanceOfGetBillingUsage200ResponseZippyCredits;
17
+ exports.GetBillingUsage200ResponseZippyCreditsFromJSON = GetBillingUsage200ResponseZippyCreditsFromJSON;
18
+ exports.GetBillingUsage200ResponseZippyCreditsFromJSONTyped = GetBillingUsage200ResponseZippyCreditsFromJSONTyped;
19
+ exports.GetBillingUsage200ResponseZippyCreditsToJSON = GetBillingUsage200ResponseZippyCreditsToJSON;
20
+ exports.GetBillingUsage200ResponseZippyCreditsToJSONTyped = GetBillingUsage200ResponseZippyCreditsToJSONTyped;
21
21
  /**
22
- * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
22
+ * Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
23
23
  */
24
- function instanceOfGetBillingUsage200ResponseZippyMessages(value) {
24
+ function instanceOfGetBillingUsage200ResponseZippyCredits(value) {
25
25
  if (!('used' in value) || value['used'] === undefined)
26
26
  return false;
27
+ if (!('included' in value) || value['included'] === undefined)
28
+ return false;
29
+ if (!('billed' in value) || value['billed'] === undefined)
30
+ return false;
27
31
  if (!('charges' in value) || value['charges'] === undefined)
28
32
  return false;
29
33
  if (!('limit' in value) || value['limit'] === undefined)
30
34
  return false;
31
35
  return true;
32
36
  }
33
- function GetBillingUsage200ResponseZippyMessagesFromJSON(json) {
34
- return GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, false);
37
+ function GetBillingUsage200ResponseZippyCreditsFromJSON(json) {
38
+ return GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, false);
35
39
  }
36
- function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, ignoreDiscriminator) {
40
+ function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, ignoreDiscriminator) {
37
41
  if (json == null) {
38
42
  return json;
39
43
  }
40
44
  return {
41
45
  'used': json['used'],
46
+ 'included': json['included'],
47
+ 'billed': json['billed'],
42
48
  'charges': json['charges'],
43
49
  'limit': json['limit'],
44
50
  };
45
51
  }
46
- function GetBillingUsage200ResponseZippyMessagesToJSON(json) {
47
- return GetBillingUsage200ResponseZippyMessagesToJSONTyped(json, false);
52
+ function GetBillingUsage200ResponseZippyCreditsToJSON(json) {
53
+ return GetBillingUsage200ResponseZippyCreditsToJSONTyped(json, false);
48
54
  }
49
- function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value, ignoreDiscriminator = false) {
55
+ function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value, ignoreDiscriminator = false) {
50
56
  if (value == null) {
51
57
  return value;
52
58
  }
53
59
  return {
54
60
  'used': value['used'],
61
+ 'included': value['included'],
62
+ 'billed': value['billed'],
55
63
  'charges': value['charges'],
56
64
  'limit': value['limit'],
57
65
  };
@@ -102,6 +102,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
102
102
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
103
103
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
104
104
  readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
105
+ readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
106
+ readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
107
+ readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
105
108
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
106
109
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
107
110
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -87,6 +87,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
87
87
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
88
88
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
89
89
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
90
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
91
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
92
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
90
93
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
91
94
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
92
95
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -109,6 +109,9 @@ export declare const SendShipment422ResponseCodeEnum: {
109
109
  readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
110
110
  readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
111
111
  readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
112
+ readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
113
+ readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
114
+ readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
112
115
  readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
113
116
  readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
114
117
  readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
@@ -88,6 +88,9 @@ exports.SendShipment422ResponseCodeEnum = {
88
88
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
89
89
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
90
90
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
91
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
92
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
93
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
91
94
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
92
95
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
93
96
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -71,7 +71,7 @@ export * from './GetBillingUsage200ResponseCurrentPeriod';
71
71
  export * from './GetBillingUsage200ResponseLimits';
72
72
  export * from './GetBillingUsage200ResponseLimitsTeamMembers';
73
73
  export * from './GetBillingUsage200ResponseShipments';
74
- export * from './GetBillingUsage200ResponseZippyMessages';
74
+ export * from './GetBillingUsage200ResponseZippyCredits';
75
75
  export * from './GetOrder200Response';
76
76
  export * from './GetOrder200ResponseOrderLinesInner';
77
77
  export * from './GetOrder200ResponseShipmentsInner';
@@ -89,7 +89,7 @@ __exportStar(require("./GetBillingUsage200ResponseCurrentPeriod"), exports);
89
89
  __exportStar(require("./GetBillingUsage200ResponseLimits"), exports);
90
90
  __exportStar(require("./GetBillingUsage200ResponseLimitsTeamMembers"), exports);
91
91
  __exportStar(require("./GetBillingUsage200ResponseShipments"), exports);
92
- __exportStar(require("./GetBillingUsage200ResponseZippyMessages"), exports);
92
+ __exportStar(require("./GetBillingUsage200ResponseZippyCredits"), exports);
93
93
  __exportStar(require("./GetOrder200Response"), exports);
94
94
  __exportStar(require("./GetOrder200ResponseOrderLinesInner"), exports);
95
95
  __exportStar(require("./GetOrder200ResponseShipmentsInner"), exports);
@@ -10,7 +10,7 @@ Name | Type
10
10
  `shipments` | [GetBillingUsage200ResponseShipments](GetBillingUsage200ResponseShipments.md)
11
11
  `limits` | [GetBillingUsage200ResponseLimits](GetBillingUsage200ResponseLimits.md)
12
12
  `addOns` | [Array&lt;GetBillingUsage200ResponseAddOnsInner&gt;](GetBillingUsage200ResponseAddOnsInner.md)
13
- `zippyMessages` | [GetBillingUsage200ResponseZippyMessages](GetBillingUsage200ResponseZippyMessages.md)
13
+ `zippyCredits` | [GetBillingUsage200ResponseZippyCredits](GetBillingUsage200ResponseZippyCredits.md)
14
14
 
15
15
  ## Example
16
16
 
@@ -23,7 +23,7 @@ const example = {
23
23
  "shipments": null,
24
24
  "limits": null,
25
25
  "addOns": [],
26
- "zippyMessages": null,
26
+ "zippyCredits": null,
27
27
  } satisfies GetBillingUsage200Response
28
28
 
29
29
  console.log(example)
@@ -1,27 +1,31 @@
1
1
 
2
- # GetBillingUsage200ResponseZippyMessages
2
+ # GetBillingUsage200ResponseZippyCredits
3
3
 
4
- Zippy AI message usage this period (present when Zippy access is enabled)
4
+ Zippy AI credit usage this period (present when the Zippy add-on is enabled)
5
5
 
6
6
  ## Properties
7
7
 
8
8
  Name | Type
9
9
  ------------ | -------------
10
10
  `used` | number
11
+ `included` | number
12
+ `billed` | number
11
13
  `charges` | number
12
14
  `limit` | number
13
15
 
14
16
  ## Example
15
17
 
16
18
  ```typescript
17
- import type { GetBillingUsage200ResponseZippyMessages } from '@zippendo/sdk'
19
+ import type { GetBillingUsage200ResponseZippyCredits } from '@zippendo/sdk'
18
20
 
19
21
  // TODO: Update the object below with actual values
20
22
  const example = {
21
- "used": 42,
22
- "charges": 4158,
23
+ "used": 2640,
24
+ "included": 2500,
25
+ "billed": 140,
26
+ "charges": 1000,
23
27
  "limit": -1,
24
- } satisfies GetBillingUsage200ResponseZippyMessages
28
+ } satisfies GetBillingUsage200ResponseZippyCredits
25
29
 
26
30
  console.log(example)
27
31
 
@@ -30,7 +34,7 @@ const exampleJSON: string = JSON.stringify(example)
30
34
  console.log(exampleJSON)
31
35
 
32
36
  // Parse the JSON string back to an object
33
- const exampleParsed = JSON.parse(exampleJSON) as GetBillingUsage200ResponseZippyMessages
37
+ const exampleParsed = JSON.parse(exampleJSON) as GetBillingUsage200ResponseZippyCredits
34
38
  console.log(exampleParsed)
35
39
  ```
36
40
 
package/docs/OrgsApi.md CHANGED
@@ -372,6 +372,7 @@ example().catch(console.error);
372
372
  | Status code | Description | Response headers |
373
373
  |-------------|-------------|------------------|
374
374
  | **200** | Default Response | - |
375
+ | **400** | Default Response | - |
375
376
  | **404** | Default Response | - |
376
377
 
377
378
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.3.4",
3
+ "version": "1.3.5",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -138,6 +138,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
138
138
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
139
139
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
140
140
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
141
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
142
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
143
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
141
144
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
142
145
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
143
146
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -13,13 +13,6 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { GetBillingUsage200ResponseZippyMessages } from './GetBillingUsage200ResponseZippyMessages';
17
- import {
18
- GetBillingUsage200ResponseZippyMessagesFromJSON,
19
- GetBillingUsage200ResponseZippyMessagesFromJSONTyped,
20
- GetBillingUsage200ResponseZippyMessagesToJSON,
21
- GetBillingUsage200ResponseZippyMessagesToJSONTyped,
22
- } from './GetBillingUsage200ResponseZippyMessages';
23
16
  import type { GetBillingUsage200ResponseAddOnsInner } from './GetBillingUsage200ResponseAddOnsInner';
24
17
  import {
25
18
  GetBillingUsage200ResponseAddOnsInnerFromJSON,
@@ -34,6 +27,13 @@ import {
34
27
  GetBillingUsage200ResponseShipmentsToJSON,
35
28
  GetBillingUsage200ResponseShipmentsToJSONTyped,
36
29
  } from './GetBillingUsage200ResponseShipments';
30
+ import type { GetBillingUsage200ResponseZippyCredits } from './GetBillingUsage200ResponseZippyCredits';
31
+ import {
32
+ GetBillingUsage200ResponseZippyCreditsFromJSON,
33
+ GetBillingUsage200ResponseZippyCreditsFromJSONTyped,
34
+ GetBillingUsage200ResponseZippyCreditsToJSON,
35
+ GetBillingUsage200ResponseZippyCreditsToJSONTyped,
36
+ } from './GetBillingUsage200ResponseZippyCredits';
37
37
  import type { GetBillingUsage200ResponseCurrentPeriod } from './GetBillingUsage200ResponseCurrentPeriod';
38
38
  import {
39
39
  GetBillingUsage200ResponseCurrentPeriodFromJSON,
@@ -81,10 +81,10 @@ export interface GetBillingUsage200Response {
81
81
  addOns: Array<GetBillingUsage200ResponseAddOnsInner>;
82
82
  /**
83
83
  *
84
- * @type {GetBillingUsage200ResponseZippyMessages}
84
+ * @type {GetBillingUsage200ResponseZippyCredits}
85
85
  * @memberof GetBillingUsage200Response
86
86
  */
87
- zippyMessages?: GetBillingUsage200ResponseZippyMessages;
87
+ zippyCredits?: GetBillingUsage200ResponseZippyCredits;
88
88
  }
89
89
 
90
90
  /**
@@ -112,7 +112,7 @@ export function GetBillingUsage200ResponseFromJSONTyped(json: any, ignoreDiscrim
112
112
  'shipments': GetBillingUsage200ResponseShipmentsFromJSON(json['shipments']),
113
113
  'limits': GetBillingUsage200ResponseLimitsFromJSON(json['limits']),
114
114
  'addOns': ((json['addOns'] as Array<any>).map(GetBillingUsage200ResponseAddOnsInnerFromJSON)),
115
- 'zippyMessages': json['zippyMessages'] == null ? undefined : GetBillingUsage200ResponseZippyMessagesFromJSON(json['zippyMessages']),
115
+ 'zippyCredits': json['zippyCredits'] == null ? undefined : GetBillingUsage200ResponseZippyCreditsFromJSON(json['zippyCredits']),
116
116
  };
117
117
  }
118
118
 
@@ -131,7 +131,7 @@ export function GetBillingUsage200ResponseToJSONTyped(value?: GetBillingUsage200
131
131
  'shipments': GetBillingUsage200ResponseShipmentsToJSON(value['shipments']),
132
132
  'limits': GetBillingUsage200ResponseLimitsToJSON(value['limits']),
133
133
  'addOns': ((value['addOns'] as Array<any>).map(GetBillingUsage200ResponseAddOnsInnerToJSON)),
134
- 'zippyMessages': GetBillingUsage200ResponseZippyMessagesToJSON(value['zippyMessages']),
134
+ 'zippyCredits': GetBillingUsage200ResponseZippyCreditsToJSON(value['zippyCredits']),
135
135
  };
136
136
  }
137
137
 
@@ -14,62 +14,78 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- * Zippy AI message usage this period (present when Zippy access is enabled)
17
+ * Zippy AI credit usage this period (present when the Zippy add-on is enabled)
18
18
  * @export
19
- * @interface GetBillingUsage200ResponseZippyMessages
19
+ * @interface GetBillingUsage200ResponseZippyCredits
20
20
  */
21
- export interface GetBillingUsage200ResponseZippyMessages {
21
+ export interface GetBillingUsage200ResponseZippyCredits {
22
22
  /**
23
- * Zippy messages used this period
23
+ * Zippy credits used this period, included bundle and metered alike
24
24
  * @type {number}
25
- * @memberof GetBillingUsage200ResponseZippyMessages
25
+ * @memberof GetBillingUsage200ResponseZippyCredits
26
26
  */
27
27
  used: number;
28
28
  /**
29
- * Zippy message charges so far, in øre
29
+ * Credits included in the add-on bundle this period
30
30
  * @type {number}
31
- * @memberof GetBillingUsage200ResponseZippyMessages
31
+ * @memberof GetBillingUsage200ResponseZippyCredits
32
+ */
33
+ included: number;
34
+ /**
35
+ * Credits beyond the bundle, metered this period
36
+ * @type {number}
37
+ * @memberof GetBillingUsage200ResponseZippyCredits
38
+ */
39
+ billed: number;
40
+ /**
41
+ * Metered credit charges so far, in øre (whole packs)
42
+ * @type {number}
43
+ * @memberof GetBillingUsage200ResponseZippyCredits
32
44
  */
33
45
  charges: number;
34
46
  /**
35
- * Maximum Zippy messages per month (-1 for unlimited)
47
+ * Maximum Zippy credits per month (-1 for unlimited)
36
48
  * @type {number}
37
- * @memberof GetBillingUsage200ResponseZippyMessages
49
+ * @memberof GetBillingUsage200ResponseZippyCredits
38
50
  */
39
51
  limit: number;
40
52
  }
41
53
 
42
54
  /**
43
- * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
55
+ * Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
44
56
  */
45
- export function instanceOfGetBillingUsage200ResponseZippyMessages(value: object): value is GetBillingUsage200ResponseZippyMessages {
57
+ export function instanceOfGetBillingUsage200ResponseZippyCredits(value: object): value is GetBillingUsage200ResponseZippyCredits {
46
58
  if (!('used' in value) || value['used'] === undefined) return false;
59
+ if (!('included' in value) || value['included'] === undefined) return false;
60
+ if (!('billed' in value) || value['billed'] === undefined) return false;
47
61
  if (!('charges' in value) || value['charges'] === undefined) return false;
48
62
  if (!('limit' in value) || value['limit'] === undefined) return false;
49
63
  return true;
50
64
  }
51
65
 
52
- export function GetBillingUsage200ResponseZippyMessagesFromJSON(json: any): GetBillingUsage200ResponseZippyMessages {
53
- return GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, false);
66
+ export function GetBillingUsage200ResponseZippyCreditsFromJSON(json: any): GetBillingUsage200ResponseZippyCredits {
67
+ return GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, false);
54
68
  }
55
69
 
56
- export function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyMessages {
70
+ export function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyCredits {
57
71
  if (json == null) {
58
72
  return json;
59
73
  }
60
74
  return {
61
75
 
62
76
  'used': json['used'],
77
+ 'included': json['included'],
78
+ 'billed': json['billed'],
63
79
  'charges': json['charges'],
64
80
  'limit': json['limit'],
65
81
  };
66
82
  }
67
83
 
68
- export function GetBillingUsage200ResponseZippyMessagesToJSON(json: any): GetBillingUsage200ResponseZippyMessages {
69
- return GetBillingUsage200ResponseZippyMessagesToJSONTyped(json, false);
84
+ export function GetBillingUsage200ResponseZippyCreditsToJSON(json: any): GetBillingUsage200ResponseZippyCredits {
85
+ return GetBillingUsage200ResponseZippyCreditsToJSONTyped(json, false);
70
86
  }
71
87
 
72
- export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBillingUsage200ResponseZippyMessages | null, ignoreDiscriminator: boolean = false): any {
88
+ export function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value?: GetBillingUsage200ResponseZippyCredits | null, ignoreDiscriminator: boolean = false): any {
73
89
  if (value == null) {
74
90
  return value;
75
91
  }
@@ -77,6 +93,8 @@ export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBi
77
93
  return {
78
94
 
79
95
  'used': value['used'],
96
+ 'included': value['included'],
97
+ 'billed': value['billed'],
80
98
  'charges': value['charges'],
81
99
  'limit': value['limit'],
82
100
  };
@@ -108,6 +108,9 @@ export const ListApiTokens401ResponseCodeEnum = {
108
108
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
109
109
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
110
110
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
111
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
112
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
113
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
111
114
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
112
115
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
113
116
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -122,6 +122,9 @@ export const SendShipment422ResponseCodeEnum = {
122
122
  BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
123
123
  ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
124
124
  ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
125
+ ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
126
+ ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
127
+ ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
125
128
  ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
126
129
  ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
127
130
  ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
@@ -73,7 +73,7 @@ export * from './GetBillingUsage200ResponseCurrentPeriod';
73
73
  export * from './GetBillingUsage200ResponseLimits';
74
74
  export * from './GetBillingUsage200ResponseLimitsTeamMembers';
75
75
  export * from './GetBillingUsage200ResponseShipments';
76
- export * from './GetBillingUsage200ResponseZippyMessages';
76
+ export * from './GetBillingUsage200ResponseZippyCredits';
77
77
  export * from './GetOrder200Response';
78
78
  export * from './GetOrder200ResponseOrderLinesInner';
79
79
  export * from './GetOrder200ResponseShipmentsInner';