@zippendo/sdk 1.3.3 → 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 (59) 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/CreateAddressRequest.d.ts +11 -5
  4. package/dist/esm/models/CreateAddressRequest.js +5 -5
  5. package/dist/esm/models/GetBillingUsage200Response.d.ts +3 -3
  6. package/dist/esm/models/GetBillingUsage200Response.js +3 -3
  7. package/dist/esm/models/{GetBillingUsage200ResponseZippyMessages.d.ts → GetBillingUsage200ResponseZippyCredits.d.ts} +27 -15
  8. package/dist/esm/models/{GetBillingUsage200ResponseZippyMessages.js → GetBillingUsage200ResponseZippyCredits.js} +16 -8
  9. package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts +9 -3
  10. package/dist/esm/models/ListAddresses200ResponseDataInner.js +4 -0
  11. package/dist/esm/models/ListApiTokens401Response.d.ts +3 -0
  12. package/dist/esm/models/ListApiTokens401Response.js +3 -0
  13. package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts +9 -3
  14. package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js +4 -0
  15. package/dist/esm/models/SendShipment422Response.d.ts +3 -0
  16. package/dist/esm/models/SendShipment422Response.js +3 -0
  17. package/dist/esm/models/UpdateAddressRequest.d.ts +13 -7
  18. package/dist/esm/models/UpdateAddressRequest.js +5 -3
  19. package/dist/esm/models/index.d.ts +1 -1
  20. package/dist/esm/models/index.js +1 -1
  21. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +3 -0
  22. package/dist/models/BatchSendShipments200ResponseResultsInner.js +3 -0
  23. package/dist/models/CreateAddressRequest.d.ts +11 -5
  24. package/dist/models/CreateAddressRequest.js +5 -5
  25. package/dist/models/GetBillingUsage200Response.d.ts +3 -3
  26. package/dist/models/GetBillingUsage200Response.js +3 -3
  27. package/dist/models/{GetBillingUsage200ResponseZippyMessages.d.ts → GetBillingUsage200ResponseZippyCredits.d.ts} +27 -15
  28. package/dist/models/{GetBillingUsage200ResponseZippyMessages.js → GetBillingUsage200ResponseZippyCredits.js} +21 -13
  29. package/dist/models/ListAddresses200ResponseDataInner.d.ts +9 -3
  30. package/dist/models/ListAddresses200ResponseDataInner.js +4 -0
  31. package/dist/models/ListApiTokens401Response.d.ts +3 -0
  32. package/dist/models/ListApiTokens401Response.js +3 -0
  33. package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts +9 -3
  34. package/dist/models/ListShipments200ResponseDataInnerAddress.js +4 -0
  35. package/dist/models/SendShipment422Response.d.ts +3 -0
  36. package/dist/models/SendShipment422Response.js +3 -0
  37. package/dist/models/UpdateAddressRequest.d.ts +13 -7
  38. package/dist/models/UpdateAddressRequest.js +5 -3
  39. package/dist/models/index.d.ts +1 -1
  40. package/dist/models/index.js +1 -1
  41. package/docs/AddressesApi.md +2 -2
  42. package/docs/CreateAddressRequest.md +4 -2
  43. package/docs/GetBillingUsage200Response.md +2 -2
  44. package/docs/{GetBillingUsage200ResponseZippyMessages.md → GetBillingUsage200ResponseZippyCredits.md} +11 -7
  45. package/docs/ListAddresses200ResponseDataInner.md +3 -1
  46. package/docs/ListShipments200ResponseDataInnerAddress.md +3 -1
  47. package/docs/OrgsApi.md +1 -0
  48. package/docs/UpdateAddressRequest.md +3 -1
  49. package/package.json +1 -1
  50. package/src/models/BatchSendShipments200ResponseResultsInner.ts +3 -0
  51. package/src/models/CreateAddressRequest.ts +16 -9
  52. package/src/models/GetBillingUsage200Response.ts +11 -11
  53. package/src/models/{GetBillingUsage200ResponseZippyMessages.ts → GetBillingUsage200ResponseZippyCredits.ts} +35 -17
  54. package/src/models/ListAddresses200ResponseDataInner.ts +12 -3
  55. package/src/models/ListApiTokens401Response.ts +3 -0
  56. package/src/models/ListShipments200ResponseDataInnerAddress.ts +12 -3
  57. package/src/models/SendShipment422Response.ts +3 -0
  58. package/src/models/UpdateAddressRequest.ts +18 -10
  59. 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',
@@ -16,17 +16,23 @@
16
16
  */
17
17
  export interface CreateAddressRequest {
18
18
  /**
19
- * Name of the address
19
+ * Company or person the parcel is sent from, printed on labels
20
20
  * @type {string}
21
21
  * @memberof CreateAddressRequest
22
22
  */
23
23
  name: string;
24
24
  /**
25
- * Attention contact person
25
+ * Internal label for this address; never printed or sent to a carrier
26
26
  * @type {string}
27
27
  * @memberof CreateAddressRequest
28
28
  */
29
- attContact: string;
29
+ description?: string | null;
30
+ /**
31
+ * Contact person at this address, printed as the att. line
32
+ * @type {string}
33
+ * @memberof CreateAddressRequest
34
+ */
35
+ attContact?: string | null;
30
36
  /**
31
37
  * Address line 1
32
38
  * @type {string}
@@ -38,7 +44,7 @@ export interface CreateAddressRequest {
38
44
  * @type {string}
39
45
  * @memberof CreateAddressRequest
40
46
  */
41
- address2?: string;
47
+ address2?: string | null;
42
48
  /**
43
49
  * Postal/ZIP code
44
50
  * @type {string}
@@ -68,7 +74,7 @@ export interface CreateAddressRequest {
68
74
  * @type {string}
69
75
  * @memberof CreateAddressRequest
70
76
  */
71
- state?: string;
77
+ state?: string | null;
72
78
  /**
73
79
  * Email address
74
80
  * @type {string}
@@ -25,8 +25,6 @@ export const CreateAddressRequestAddressTypesEnum = {
25
25
  export function instanceOfCreateAddressRequest(value) {
26
26
  if (!('name' in value) || value['name'] === undefined)
27
27
  return false;
28
- if (!('attContact' in value) || value['attContact'] === undefined)
29
- return false;
30
28
  if (!('address1' in value) || value['address1'] === undefined)
31
29
  return false;
32
30
  if (!('zipcode' in value) || value['zipcode'] === undefined)
@@ -50,14 +48,15 @@ export function CreateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
50
48
  }
51
49
  return {
52
50
  'name': json['name'],
53
- 'attContact': json['attContact'],
51
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
52
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
54
53
  'address1': json['address1'],
55
- 'address2': json['address2'] == null ? undefined : json['address2'],
54
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
56
55
  'zipcode': json['zipcode'],
57
56
  'city': json['city'],
58
57
  'phone': json['phone'],
59
58
  'countryCode': json['countryCode'],
60
- 'state': json['state'] == null ? undefined : json['state'],
59
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
61
60
  'email': json['email'],
62
61
  'customs': json['customs'] == null ? undefined : json['customs'],
63
62
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -73,6 +72,7 @@ export function CreateAddressRequestToJSONTyped(value, ignoreDiscriminator = fal
73
72
  }
74
73
  return {
75
74
  'name': value['name'],
75
+ 'description': value['description'],
76
76
  'attContact': value['attContact'],
77
77
  'address1': value['address1'],
78
78
  'address2': value['address2'],
@@ -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
  };
@@ -22,17 +22,23 @@ export interface ListAddresses200ResponseDataInner {
22
22
  */
23
23
  id: string;
24
24
  /**
25
- * Name of the address
25
+ * Company or person the parcel is sent from, printed on labels
26
26
  * @type {string}
27
27
  * @memberof ListAddresses200ResponseDataInner
28
28
  */
29
29
  name: string;
30
30
  /**
31
- * Attention contact person
31
+ * Internal label for this address; never printed or sent to a carrier
32
32
  * @type {string}
33
33
  * @memberof ListAddresses200ResponseDataInner
34
34
  */
35
- attContact: string;
35
+ description: string | null;
36
+ /**
37
+ * Contact person at this address, printed as the att. line
38
+ * @type {string}
39
+ * @memberof ListAddresses200ResponseDataInner
40
+ */
41
+ attContact: string | null;
36
42
  /**
37
43
  * Address line 1
38
44
  * @type {string}
@@ -27,6 +27,8 @@ export function instanceOfListAddresses200ResponseDataInner(value) {
27
27
  return false;
28
28
  if (!('name' in value) || value['name'] === undefined)
29
29
  return false;
30
+ if (!('description' in value) || value['description'] === undefined)
31
+ return false;
30
32
  if (!('attContact' in value) || value['attContact'] === undefined)
31
33
  return false;
32
34
  if (!('address1' in value) || value['address1'] === undefined)
@@ -67,6 +69,7 @@ export function ListAddresses200ResponseDataInnerFromJSONTyped(json, ignoreDiscr
67
69
  return {
68
70
  'id': json['id'],
69
71
  'name': json['name'],
72
+ 'description': json['description'],
70
73
  'attContact': json['attContact'],
71
74
  'address1': json['address1'],
72
75
  'address2': json['address2'],
@@ -94,6 +97,7 @@ export function ListAddresses200ResponseDataInnerToJSONTyped(value, ignoreDiscri
94
97
  return {
95
98
  'id': value['id'],
96
99
  'name': value['name'],
100
+ 'description': value['description'],
97
101
  'attContact': value['attContact'],
98
102
  'address1': value['address1'],
99
103
  'address2': value['address2'],
@@ -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',
@@ -22,17 +22,23 @@ export interface ListShipments200ResponseDataInnerAddress {
22
22
  */
23
23
  id: string;
24
24
  /**
25
- * Name of the address
25
+ * Company or person the parcel is sent from, printed on labels
26
26
  * @type {string}
27
27
  * @memberof ListShipments200ResponseDataInnerAddress
28
28
  */
29
29
  name: string;
30
30
  /**
31
- * Attention contact person
31
+ * Internal label for this address; never printed or sent to a carrier
32
32
  * @type {string}
33
33
  * @memberof ListShipments200ResponseDataInnerAddress
34
34
  */
35
- attContact: string;
35
+ description: string | null;
36
+ /**
37
+ * Contact person at this address, printed as the att. line
38
+ * @type {string}
39
+ * @memberof ListShipments200ResponseDataInnerAddress
40
+ */
41
+ attContact: string | null;
36
42
  /**
37
43
  * Address line 1
38
44
  * @type {string}
@@ -27,6 +27,8 @@ export function instanceOfListShipments200ResponseDataInnerAddress(value) {
27
27
  return false;
28
28
  if (!('name' in value) || value['name'] === undefined)
29
29
  return false;
30
+ if (!('description' in value) || value['description'] === undefined)
31
+ return false;
30
32
  if (!('attContact' in value) || value['attContact'] === undefined)
31
33
  return false;
32
34
  if (!('address1' in value) || value['address1'] === undefined)
@@ -67,6 +69,7 @@ export function ListShipments200ResponseDataInnerAddressFromJSONTyped(json, igno
67
69
  return {
68
70
  'id': json['id'],
69
71
  'name': json['name'],
72
+ 'description': json['description'],
70
73
  'attContact': json['attContact'],
71
74
  'address1': json['address1'],
72
75
  'address2': json['address2'],
@@ -94,6 +97,7 @@ export function ListShipments200ResponseDataInnerAddressToJSONTyped(value, ignor
94
97
  return {
95
98
  'id': value['id'],
96
99
  'name': value['name'],
100
+ 'description': value['description'],
97
101
  'attContact': value['attContact'],
98
102
  'address1': value['address1'],
99
103
  'address2': value['address2'],
@@ -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',
@@ -16,17 +16,23 @@
16
16
  */
17
17
  export interface UpdateAddressRequest {
18
18
  /**
19
- * Name of the address
19
+ * Company or person the parcel is sent from, printed on labels
20
20
  * @type {string}
21
21
  * @memberof UpdateAddressRequest
22
22
  */
23
23
  name?: string;
24
24
  /**
25
- * Attention contact person
25
+ * Internal label for this address; send null or an empty string to clear it
26
26
  * @type {string}
27
27
  * @memberof UpdateAddressRequest
28
28
  */
29
- attContact?: string;
29
+ description?: string | null;
30
+ /**
31
+ * Contact person at this address; send null or an empty string to clear it
32
+ * @type {string}
33
+ * @memberof UpdateAddressRequest
34
+ */
35
+ attContact?: string | null;
30
36
  /**
31
37
  * Address line 1
32
38
  * @type {string}
@@ -34,11 +40,11 @@ export interface UpdateAddressRequest {
34
40
  */
35
41
  address1?: string;
36
42
  /**
37
- * Address line 2
43
+ * Address line 2; send null or an empty string to clear it
38
44
  * @type {string}
39
45
  * @memberof UpdateAddressRequest
40
46
  */
41
- address2?: string;
47
+ address2?: string | null;
42
48
  /**
43
49
  * Postal/ZIP code
44
50
  * @type {string}
@@ -64,11 +70,11 @@ export interface UpdateAddressRequest {
64
70
  */
65
71
  countryCode?: string;
66
72
  /**
67
- * State/Province
73
+ * State/Province; send null or an empty string to clear it
68
74
  * @type {string}
69
75
  * @memberof UpdateAddressRequest
70
76
  */
71
- state?: string;
77
+ state?: string | null;
72
78
  /**
73
79
  * Email address
74
80
  * @type {string}
@@ -34,14 +34,15 @@ export function UpdateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
34
34
  }
35
35
  return {
36
36
  'name': json['name'] == null ? undefined : json['name'],
37
- 'attContact': json['attContact'] == null ? undefined : json['attContact'],
37
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
38
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
38
39
  'address1': json['address1'] == null ? undefined : json['address1'],
39
- 'address2': json['address2'] == null ? undefined : json['address2'],
40
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
40
41
  'zipcode': json['zipcode'] == null ? undefined : json['zipcode'],
41
42
  'city': json['city'] == null ? undefined : json['city'],
42
43
  'phone': json['phone'] == null ? undefined : json['phone'],
43
44
  'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
44
- 'state': json['state'] == null ? undefined : json['state'],
45
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
45
46
  'email': json['email'] == null ? undefined : json['email'],
46
47
  'customs': json['customs'] == null ? undefined : json['customs'],
47
48
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -57,6 +58,7 @@ export function UpdateAddressRequestToJSONTyped(value, ignoreDiscriminator = fal
57
58
  }
58
59
  return {
59
60
  'name': value['name'],
61
+ 'description': value['description'],
60
62
  'attContact': value['attContact'],
61
63
  'address1': value['address1'],
62
64
  'address2': value['address2'],
@@ -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',
@@ -16,17 +16,23 @@
16
16
  */
17
17
  export interface CreateAddressRequest {
18
18
  /**
19
- * Name of the address
19
+ * Company or person the parcel is sent from, printed on labels
20
20
  * @type {string}
21
21
  * @memberof CreateAddressRequest
22
22
  */
23
23
  name: string;
24
24
  /**
25
- * Attention contact person
25
+ * Internal label for this address; never printed or sent to a carrier
26
26
  * @type {string}
27
27
  * @memberof CreateAddressRequest
28
28
  */
29
- attContact: string;
29
+ description?: string | null;
30
+ /**
31
+ * Contact person at this address, printed as the att. line
32
+ * @type {string}
33
+ * @memberof CreateAddressRequest
34
+ */
35
+ attContact?: string | null;
30
36
  /**
31
37
  * Address line 1
32
38
  * @type {string}
@@ -38,7 +44,7 @@ export interface CreateAddressRequest {
38
44
  * @type {string}
39
45
  * @memberof CreateAddressRequest
40
46
  */
41
- address2?: string;
47
+ address2?: string | null;
42
48
  /**
43
49
  * Postal/ZIP code
44
50
  * @type {string}
@@ -68,7 +74,7 @@ export interface CreateAddressRequest {
68
74
  * @type {string}
69
75
  * @memberof CreateAddressRequest
70
76
  */
71
- state?: string;
77
+ state?: string | null;
72
78
  /**
73
79
  * Email address
74
80
  * @type {string}
@@ -33,8 +33,6 @@ exports.CreateAddressRequestAddressTypesEnum = {
33
33
  function instanceOfCreateAddressRequest(value) {
34
34
  if (!('name' in value) || value['name'] === undefined)
35
35
  return false;
36
- if (!('attContact' in value) || value['attContact'] === undefined)
37
- return false;
38
36
  if (!('address1' in value) || value['address1'] === undefined)
39
37
  return false;
40
38
  if (!('zipcode' in value) || value['zipcode'] === undefined)
@@ -58,14 +56,15 @@ function CreateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
58
56
  }
59
57
  return {
60
58
  'name': json['name'],
61
- 'attContact': json['attContact'],
59
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
60
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
62
61
  'address1': json['address1'],
63
- 'address2': json['address2'] == null ? undefined : json['address2'],
62
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
64
63
  'zipcode': json['zipcode'],
65
64
  'city': json['city'],
66
65
  'phone': json['phone'],
67
66
  'countryCode': json['countryCode'],
68
- 'state': json['state'] == null ? undefined : json['state'],
67
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
69
68
  'email': json['email'],
70
69
  'customs': json['customs'] == null ? undefined : json['customs'],
71
70
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -81,6 +80,7 @@ function CreateAddressRequestToJSONTyped(value, ignoreDiscriminator = false) {
81
80
  }
82
81
  return {
83
82
  'name': value['name'],
83
+ 'description': value['description'],
84
84
  'attContact': value['attContact'],
85
85
  'address1': value['address1'],
86
86
  'address2': value['address2'],