@zippendo/sdk 1.3.3 → 1.3.5

package/src/models/CreateAddressRequest.ts

@@ -20,17 +20,23 @@ import { mapValues } from '../runtime';
  */
 export interface CreateAddressRequest {
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof CreateAddressRequest
      */
     name: string;
     /**
-     * Attention contact person
+     * Internal label for this address; never printed or sent to a carrier
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    attContact: string;
+    description?: string | null;
+    /**
+     * Contact person at this address, printed as the att. line
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    attContact?: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -42,7 +48,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    address2?: string;
+    address2?: string | null;
     /**
      * Postal/ZIP code
      * @type {string}
@@ -72,7 +78,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    state?: string;
+    state?: string | null;
     /**
      * Email address
      * @type {string}
@@ -116,7 +122,6 @@ export type CreateAddressRequestAddressTypesEnum = typeof CreateAddressRequestAd
  */
 export function instanceOfCreateAddressRequest(value: object): value is CreateAddressRequest {
     if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('attContact' in value) || value['attContact'] === undefined) return false;
     if (!('address1' in value) || value['address1'] === undefined) return false;
     if (!('zipcode' in value) || value['zipcode'] === undefined) return false;
     if (!('city' in value) || value['city'] === undefined) return false;
@@ -137,14 +142,15 @@ export function CreateAddressRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'name': json['name'],
-        'attContact': json['attContact'],
+        'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
+        'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
         'address1': json['address1'],
-        'address2': json['address2'] == null ? undefined : json['address2'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
         'zipcode': json['zipcode'],
         'city': json['city'],
         'phone': json['phone'],
         'countryCode': json['countryCode'],
-        'state': json['state'] == null ? undefined : json['state'],
+        'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
         'email': json['email'],
         'customs': json['customs'] == null ? undefined : json['customs'],
         'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -164,6 +170,7 @@ export function CreateAddressRequestToJSONTyped(value?: CreateAddressRequest | n
     return {
         
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/GetBillingUsage200Response.ts

@@ -13,13 +13,6 @@
  */
 
 import { mapValues } from '../runtime';
-import type { GetBillingUsage200ResponseZippyMessages } from './GetBillingUsage200ResponseZippyMessages';
-import {
-    GetBillingUsage200ResponseZippyMessagesFromJSON,
-    GetBillingUsage200ResponseZippyMessagesFromJSONTyped,
-    GetBillingUsage200ResponseZippyMessagesToJSON,
-    GetBillingUsage200ResponseZippyMessagesToJSONTyped,
-} from './GetBillingUsage200ResponseZippyMessages';
 import type { GetBillingUsage200ResponseAddOnsInner } from './GetBillingUsage200ResponseAddOnsInner';
 import {
     GetBillingUsage200ResponseAddOnsInnerFromJSON,
@@ -34,6 +27,13 @@ import {
     GetBillingUsage200ResponseShipmentsToJSON,
     GetBillingUsage200ResponseShipmentsToJSONTyped,
 } from './GetBillingUsage200ResponseShipments';
+import type { GetBillingUsage200ResponseZippyCredits } from './GetBillingUsage200ResponseZippyCredits';
+import {
+    GetBillingUsage200ResponseZippyCreditsFromJSON,
+    GetBillingUsage200ResponseZippyCreditsFromJSONTyped,
+    GetBillingUsage200ResponseZippyCreditsToJSON,
+    GetBillingUsage200ResponseZippyCreditsToJSONTyped,
+} from './GetBillingUsage200ResponseZippyCredits';
 import type { GetBillingUsage200ResponseCurrentPeriod } from './GetBillingUsage200ResponseCurrentPeriod';
 import {
     GetBillingUsage200ResponseCurrentPeriodFromJSON,
@@ -81,10 +81,10 @@ export interface GetBillingUsage200Response {
     addOns: Array<GetBillingUsage200ResponseAddOnsInner>;
     /**
      * 
-     * @type {GetBillingUsage200ResponseZippyMessages}
+     * @type {GetBillingUsage200ResponseZippyCredits}
      * @memberof GetBillingUsage200Response
      */
-    zippyMessages?: GetBillingUsage200ResponseZippyMessages;
+    zippyCredits?: GetBillingUsage200ResponseZippyCredits;
 }
 
 /**
@@ -112,7 +112,7 @@ export function GetBillingUsage200ResponseFromJSONTyped(json: any, ignoreDiscrim
         'shipments': GetBillingUsage200ResponseShipmentsFromJSON(json['shipments']),
         'limits': GetBillingUsage200ResponseLimitsFromJSON(json['limits']),
         'addOns': ((json['addOns'] as Array<any>).map(GetBillingUsage200ResponseAddOnsInnerFromJSON)),
-        'zippyMessages': json['zippyMessages'] == null ? undefined : GetBillingUsage200ResponseZippyMessagesFromJSON(json['zippyMessages']),
+        'zippyCredits': json['zippyCredits'] == null ? undefined : GetBillingUsage200ResponseZippyCreditsFromJSON(json['zippyCredits']),
     };
 }
 
@@ -131,7 +131,7 @@ export function GetBillingUsage200ResponseToJSONTyped(value?: GetBillingUsage200
         'shipments': GetBillingUsage200ResponseShipmentsToJSON(value['shipments']),
         'limits': GetBillingUsage200ResponseLimitsToJSON(value['limits']),
         'addOns': ((value['addOns'] as Array<any>).map(GetBillingUsage200ResponseAddOnsInnerToJSON)),
-        'zippyMessages': GetBillingUsage200ResponseZippyMessagesToJSON(value['zippyMessages']),
+        'zippyCredits': GetBillingUsage200ResponseZippyCreditsToJSON(value['zippyCredits']),
     };
 }
 

package/src/models/{GetBillingUsage200ResponseZippyMessages.ts → GetBillingUsage200ResponseZippyCredits.ts}

@@ -14,62 +14,78 @@
 
 import { mapValues } from '../runtime';
 /**
- * Zippy AI message usage this period (present when Zippy access is enabled)
+ * Zippy AI credit usage this period (present when the Zippy add-on is enabled)
  * @export
- * @interface GetBillingUsage200ResponseZippyMessages
+ * @interface GetBillingUsage200ResponseZippyCredits
  */
-export interface GetBillingUsage200ResponseZippyMessages {
+export interface GetBillingUsage200ResponseZippyCredits {
     /**
-     * Zippy messages used this period
+     * Zippy credits used this period, included bundle and metered alike
      * @type {number}
-     * @memberof GetBillingUsage200ResponseZippyMessages
+     * @memberof GetBillingUsage200ResponseZippyCredits
      */
     used: number;
     /**
-     * Zippy message charges so far, in øre
+     * Credits included in the add-on bundle this period
      * @type {number}
-     * @memberof GetBillingUsage200ResponseZippyMessages
+     * @memberof GetBillingUsage200ResponseZippyCredits
+     */
+    included: number;
+    /**
+     * Credits beyond the bundle, metered this period
+     * @type {number}
+     * @memberof GetBillingUsage200ResponseZippyCredits
+     */
+    billed: number;
+    /**
+     * Metered credit charges so far, in øre (whole packs)
+     * @type {number}
+     * @memberof GetBillingUsage200ResponseZippyCredits
      */
     charges: number;
     /**
-     * Maximum Zippy messages per month (-1 for unlimited)
+     * Maximum Zippy credits per month (-1 for unlimited)
      * @type {number}
-     * @memberof GetBillingUsage200ResponseZippyMessages
+     * @memberof GetBillingUsage200ResponseZippyCredits
      */
     limit: number;
 }
 
 /**
- * Check if a given object implements the GetBillingUsage200ResponseZippyMessages interface.
+ * Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
  */
-export function instanceOfGetBillingUsage200ResponseZippyMessages(value: object): value is GetBillingUsage200ResponseZippyMessages {
+export function instanceOfGetBillingUsage200ResponseZippyCredits(value: object): value is GetBillingUsage200ResponseZippyCredits {
     if (!('used' in value) || value['used'] === undefined) return false;
+    if (!('included' in value) || value['included'] === undefined) return false;
+    if (!('billed' in value) || value['billed'] === undefined) return false;
     if (!('charges' in value) || value['charges'] === undefined) return false;
     if (!('limit' in value) || value['limit'] === undefined) return false;
     return true;
 }
 
-export function GetBillingUsage200ResponseZippyMessagesFromJSON(json: any): GetBillingUsage200ResponseZippyMessages {
-    return GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json, false);
+export function GetBillingUsage200ResponseZippyCreditsFromJSON(json: any): GetBillingUsage200ResponseZippyCredits {
+    return GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, false);
 }
 
-export function GetBillingUsage200ResponseZippyMessagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyMessages {
+export function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyCredits {
     if (json == null) {
         return json;
     }
     return {
         
         'used': json['used'],
+        'included': json['included'],
+        'billed': json['billed'],
         'charges': json['charges'],
         'limit': json['limit'],
     };
 }
 
-export function GetBillingUsage200ResponseZippyMessagesToJSON(json: any): GetBillingUsage200ResponseZippyMessages {
-    return GetBillingUsage200ResponseZippyMessagesToJSONTyped(json, false);
+export function GetBillingUsage200ResponseZippyCreditsToJSON(json: any): GetBillingUsage200ResponseZippyCredits {
+    return GetBillingUsage200ResponseZippyCreditsToJSONTyped(json, false);
 }
 
-export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBillingUsage200ResponseZippyMessages | null, ignoreDiscriminator: boolean = false): any {
+export function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value?: GetBillingUsage200ResponseZippyCredits | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -77,6 +93,8 @@ export function GetBillingUsage200ResponseZippyMessagesToJSONTyped(value?: GetBi
     return {
         
         'used': value['used'],
+        'included': value['included'],
+        'billed': value['billed'],
         'charges': value['charges'],
         'limit': value['limit'],
     };

package/src/models/ListAddresses200ResponseDataInner.ts

@@ -26,17 +26,23 @@ export interface ListAddresses200ResponseDataInner {
      */
     id: string;
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof ListAddresses200ResponseDataInner
      */
     name: string;
     /**
-     * Attention contact person
+     * Internal label for this address; never printed or sent to a carrier
      * @type {string}
      * @memberof ListAddresses200ResponseDataInner
      */
-    attContact: string;
+    description: string | null;
+    /**
+     * Contact person at this address, printed as the att. line
+     * @type {string}
+     * @memberof ListAddresses200ResponseDataInner
+     */
+    attContact: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -141,6 +147,7 @@ export type ListAddresses200ResponseDataInnerAddressTypesEnum = typeof ListAddre
 export function instanceOfListAddresses200ResponseDataInner(value: object): value is ListAddresses200ResponseDataInner {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
     if (!('attContact' in value) || value['attContact'] === undefined) return false;
     if (!('address1' in value) || value['address1'] === undefined) return false;
     if (!('address2' in value) || value['address2'] === undefined) return false;
@@ -170,6 +177,7 @@ export function ListAddresses200ResponseDataInnerFromJSONTyped(json: any, ignore
         
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -201,6 +209,7 @@ export function ListAddresses200ResponseDataInnerToJSONTyped(value?: ListAddress
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/ListApiTokens401Response.ts

@@ -108,6 +108,9 @@ export const ListApiTokens401ResponseCodeEnum = {
     BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
     ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
     ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
+    ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
+    ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
+    ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
     ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
     ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
     ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',

package/src/models/ListShipments200ResponseDataInnerAddress.ts

@@ -26,17 +26,23 @@ export interface ListShipments200ResponseDataInnerAddress {
      */
     id: string;
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof ListShipments200ResponseDataInnerAddress
      */
     name: string;
     /**
-     * Attention contact person
+     * Internal label for this address; never printed or sent to a carrier
      * @type {string}
      * @memberof ListShipments200ResponseDataInnerAddress
      */
-    attContact: string;
+    description: string | null;
+    /**
+     * Contact person at this address, printed as the att. line
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    attContact: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -141,6 +147,7 @@ export type ListShipments200ResponseDataInnerAddressAddressTypesEnum = typeof Li
 export function instanceOfListShipments200ResponseDataInnerAddress(value: object): value is ListShipments200ResponseDataInnerAddress {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
     if (!('attContact' in value) || value['attContact'] === undefined) return false;
     if (!('address1' in value) || value['address1'] === undefined) return false;
     if (!('address2' in value) || value['address2'] === undefined) return false;
@@ -170,6 +177,7 @@ export function ListShipments200ResponseDataInnerAddressFromJSONTyped(json: any,
         
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -201,6 +209,7 @@ export function ListShipments200ResponseDataInnerAddressToJSONTyped(value?: List
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/SendShipment422Response.ts

@@ -122,6 +122,9 @@ export const SendShipment422ResponseCodeEnum = {
     BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
     ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
     ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
+    ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
+    ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
+    ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
     ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
     ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
     ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',

package/src/models/UpdateAddressRequest.ts

@@ -20,17 +20,23 @@ import { mapValues } from '../runtime';
  */
 export interface UpdateAddressRequest {
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof UpdateAddressRequest
      */
     name?: string;
     /**
-     * Attention contact person
+     * Internal label for this address; send null or an empty string to clear it
      * @type {string}
      * @memberof UpdateAddressRequest
      */
-    attContact?: string;
+    description?: string | null;
+    /**
+     * Contact person at this address; send null or an empty string to clear it
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    attContact?: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -38,11 +44,11 @@ export interface UpdateAddressRequest {
      */
     address1?: string;
     /**
-     * Address line 2
+     * Address line 2; send null or an empty string to clear it
      * @type {string}
      * @memberof UpdateAddressRequest
      */
-    address2?: string;
+    address2?: string | null;
     /**
      * Postal/ZIP code
      * @type {string}
@@ -68,11 +74,11 @@ export interface UpdateAddressRequest {
      */
     countryCode?: string;
     /**
-     * State/Province
+     * State/Province; send null or an empty string to clear it
      * @type {string}
      * @memberof UpdateAddressRequest
      */
-    state?: string;
+    state?: string | null;
     /**
      * Email address
      * @type {string}
@@ -129,14 +135,15 @@ export function UpdateAddressRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'name': json['name'] == null ? undefined : json['name'],
-        'attContact': json['attContact'] == null ? undefined : json['attContact'],
+        'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
+        'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
         'address1': json['address1'] == null ? undefined : json['address1'],
-        'address2': json['address2'] == null ? undefined : json['address2'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
         'zipcode': json['zipcode'] == null ? undefined : json['zipcode'],
         'city': json['city'] == null ? undefined : json['city'],
         'phone': json['phone'] == null ? undefined : json['phone'],
         'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
-        'state': json['state'] == null ? undefined : json['state'],
+        'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
         'email': json['email'] == null ? undefined : json['email'],
         'customs': json['customs'] == null ? undefined : json['customs'],
         'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -156,6 +163,7 @@ export function UpdateAddressRequestToJSONTyped(value?: UpdateAddressRequest | n
     return {
         
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/index.ts

@@ -73,7 +73,7 @@ export * from './GetBillingUsage200ResponseCurrentPeriod';
 export * from './GetBillingUsage200ResponseLimits';
 export * from './GetBillingUsage200ResponseLimitsTeamMembers';
 export * from './GetBillingUsage200ResponseShipments';
-export * from './GetBillingUsage200ResponseZippyMessages';
+export * from './GetBillingUsage200ResponseZippyCredits';
 export * from './GetOrder200Response';
 export * from './GetOrder200ResponseOrderLinesInner';
 export * from './GetOrder200ResponseShipmentsInner';