@zippendo/sdk 1.3.3 → 1.3.4

package/dist/esm/models/CreateAddressRequest.d.ts

@@ -16,17 +16,23 @@
  */
 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}
@@ -38,7 +44,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    address2?: string;
+    address2?: string | null;
     /**
      * Postal/ZIP code
      * @type {string}
@@ -68,7 +74,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    state?: string;
+    state?: string | null;
     /**
      * Email address
      * @type {string}

package/dist/esm/models/CreateAddressRequest.js

@@ -25,8 +25,6 @@ export const CreateAddressRequestAddressTypesEnum = {
 export function instanceOfCreateAddressRequest(value) {
     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)
@@ -50,14 +48,15 @@ export function CreateAddressRequestFromJSONTyped(json, 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'],
@@ -73,6 +72,7 @@ export function CreateAddressRequestToJSONTyped(value, ignoreDiscriminator = fal
     }
     return {
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts

@@ -22,17 +22,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}

package/dist/esm/models/ListAddresses200ResponseDataInner.js

@@ -27,6 +27,8 @@ export function instanceOfListAddresses200ResponseDataInner(value) {
         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)
@@ -67,6 +69,7 @@ export function ListAddresses200ResponseDataInnerFromJSONTyped(json, ignoreDiscr
     return {
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -94,6 +97,7 @@ export function ListAddresses200ResponseDataInnerToJSONTyped(value, ignoreDiscri
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts

@@ -22,17 +22,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}

package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js

@@ -27,6 +27,8 @@ export function instanceOfListShipments200ResponseDataInnerAddress(value) {
         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)
@@ -67,6 +69,7 @@ export function ListShipments200ResponseDataInnerAddressFromJSONTyped(json, igno
     return {
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -94,6 +97,7 @@ export function ListShipments200ResponseDataInnerAddressToJSONTyped(value, ignor
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/esm/models/UpdateAddressRequest.d.ts

@@ -16,17 +16,23 @@
  */
 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}
@@ -34,11 +40,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}
@@ -64,11 +70,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}

package/dist/esm/models/UpdateAddressRequest.js

@@ -34,14 +34,15 @@ export function UpdateAddressRequestFromJSONTyped(json, 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'],
@@ -57,6 +58,7 @@ export function UpdateAddressRequestToJSONTyped(value, ignoreDiscriminator = fal
     }
     return {
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/models/CreateAddressRequest.d.ts

@@ -16,17 +16,23 @@
  */
 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}
@@ -38,7 +44,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    address2?: string;
+    address2?: string | null;
     /**
      * Postal/ZIP code
      * @type {string}
@@ -68,7 +74,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    state?: string;
+    state?: string | null;
     /**
      * Email address
      * @type {string}

package/dist/models/CreateAddressRequest.js

@@ -33,8 +33,6 @@ exports.CreateAddressRequestAddressTypesEnum = {
 function instanceOfCreateAddressRequest(value) {
     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)
@@ -58,14 +56,15 @@ function CreateAddressRequestFromJSONTyped(json, 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'],
@@ -81,6 +80,7 @@ function CreateAddressRequestToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/models/ListAddresses200ResponseDataInner.d.ts

@@ -22,17 +22,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}

package/dist/models/ListAddresses200ResponseDataInner.js

@@ -35,6 +35,8 @@ function instanceOfListAddresses200ResponseDataInner(value) {
         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)
@@ -75,6 +77,7 @@ function ListAddresses200ResponseDataInnerFromJSONTyped(json, ignoreDiscriminato
     return {
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -102,6 +105,7 @@ function ListAddresses200ResponseDataInnerToJSONTyped(value, ignoreDiscriminator
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts

@@ -22,17 +22,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}

package/dist/models/ListShipments200ResponseDataInnerAddress.js

@@ -35,6 +35,8 @@ function instanceOfListShipments200ResponseDataInnerAddress(value) {
         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)
@@ -75,6 +77,7 @@ function ListShipments200ResponseDataInnerAddressFromJSONTyped(json, ignoreDiscr
     return {
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -102,6 +105,7 @@ function ListShipments200ResponseDataInnerAddressToJSONTyped(value, ignoreDiscri
     return {
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/dist/models/UpdateAddressRequest.d.ts

@@ -16,17 +16,23 @@
  */
 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}
@@ -34,11 +40,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}
@@ -64,11 +70,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}

package/dist/models/UpdateAddressRequest.js

@@ -42,14 +42,15 @@ function UpdateAddressRequestFromJSONTyped(json, 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'],
@@ -65,6 +66,7 @@ function UpdateAddressRequestToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/docs/AddressesApi.md

@@ -277,7 +277,7 @@ async function example() {
     type: sender,
     // string | Filter by ISO 3166-1 alpha-2 country code. (optional)
     countryCode: DK,
-    // string | Search by address name, contact or city. (optional)
+    // string | Search by company name, description, contact or city. (optional)
     search: Copenhagen,
     // string | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. (optional)
     brandId: brnd_8f3kd92ld0,
@@ -307,7 +307,7 @@ example().catch(console.error);
 | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
 | **type** | `sender`, `pickup`, `return` | Filter by address type (sender, pickup, return) | [Optional] [Defaults to `undefined`] [Enum: sender, pickup, return] |
 | **countryCode** | `string` | Filter by ISO 3166-1 alpha-2 country code. | [Optional] [Defaults to `undefined`] |
-| **search** | `string` | Search by address name, contact or city. | [Optional] [Defaults to `undefined`] |
+| **search** | `string` | Search by company name, description, contact or city. | [Optional] [Defaults to `undefined`] |
 | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
 | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
 

package/docs/CreateAddressRequest.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `name` | string
+`description` | string
 `attContact` | string
 `address1` | string
 `address2` | string
@@ -27,7 +28,8 @@ import type { CreateAddressRequest } from '@zippendo/sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "name": Hovedlager,
+  "name": Zippendo ApS,
+  "description": Main warehouse, Copenhagen,
   "attContact": Mette Hansen,
   "address1": Vesterbrogade 1,
   "address2": 2. sal,
@@ -35,7 +37,7 @@ const example = {
   "city": København,
   "phone": +4533123456,
   "countryCode": DK,
-  "state": ,
+  "state": Hovedstaden,
   "email": lager@example.dk,
   "customs": {"eori":"DK12345678"},
   "addressTypes": ["sender"],

package/docs/ListAddresses200ResponseDataInner.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `name` | string
+`description` | string
 `attContact` | string
 `address1` | string
 `address2` | string
@@ -32,7 +33,8 @@ import type { ListAddresses200ResponseDataInner } from '@zippendo/sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": addr_01HZX9K2QF,
-  "name": Hovedlager,
+  "name": Zippendo ApS,
+  "description": Main warehouse, Copenhagen,
   "attContact": Mette Hansen,
   "address1": Vesterbrogade 1,
   "address2": 2. sal,

package/docs/ListShipments200ResponseDataInnerAddress.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `name` | string
+`description` | string
 `attContact` | string
 `address1` | string
 `address2` | string
@@ -32,7 +33,8 @@ import type { ListShipments200ResponseDataInnerAddress } from '@zippendo/sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": addr_01HZX9K2QF,
-  "name": Hovedlager,
+  "name": Zippendo ApS,
+  "description": Main warehouse, Copenhagen,
   "attContact": Mette Hansen,
   "address1": Vesterbrogade 1,
   "address2": 2. sal,

package/docs/UpdateAddressRequest.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `name` | string
+`description` | string
 `attContact` | string
 `address1` | string
 `address2` | string
@@ -27,7 +28,8 @@ import type { UpdateAddressRequest } from '@zippendo/sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "name": Hovedlager,
+  "name": Zippendo ApS,
+  "description": Main warehouse, Copenhagen,
   "attContact": Mette Hansen,
   "address1": Vesterbrogade 1,
   "address2": 2. sal,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zippendo/sdk",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "OpenAPI client for @zippendo/sdk",
   "author": "OpenAPI-Generator",
   "repository": {

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/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/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/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'],