@zippendo/sdk 1.0.0

package/dist/models/CreateShipmentRequestParcelsInner.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CreateShipmentRequestParcelsInnerOrderLinesInner } from './CreateShipmentRequestParcelsInnerOrderLinesInner';
+import type { CreateShipmentRequestParcelsInnerDimensions } from './CreateShipmentRequestParcelsInnerDimensions';
+/**
+ *
+ * @export
+ * @interface CreateShipmentRequestParcelsInner
+ */
+export interface CreateShipmentRequestParcelsInner {
+    /**
+     * Unique parcel identifier.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    id?: string;
+    /**
+     * Parcel weight in the given weight unit.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    weight: number;
+    /**
+     * Unit of measurement for parcel weight.
+     * @type {CreateShipmentRequestParcelsInnerWeightUnitEnum}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    weightUnit: CreateShipmentRequestParcelsInnerWeightUnitEnum;
+    /**
+     *
+     * @type {CreateShipmentRequestParcelsInnerDimensions}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    dimensions: CreateShipmentRequestParcelsInnerDimensions;
+    /**
+     * Order lines contained in this parcel.
+     * @type {Array<CreateShipmentRequestParcelsInnerOrderLinesInner>}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    orderLines: Array<CreateShipmentRequestParcelsInnerOrderLinesInner>;
+    /**
+     * Carrier tracking number for this parcel.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    trackingNumber?: string | null;
+    /**
+     * Public carrier tracking URL for this parcel.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    trackingUrl?: string | null;
+    /**
+     * Label-free drop-off code for the parcel.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    labelFreeCode?: string | null;
+    /**
+     * DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    qrCodeLink?: string | null;
+    /**
+     * Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`).
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    qrCodeDataUri?: string | null;
+    /**
+     * Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`).
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInner
+     */
+    qrCodeUrl?: string | null;
+}
+/**
+ * @export
+ */
+export declare const CreateShipmentRequestParcelsInnerWeightUnitEnum: {
+    readonly Kg: "kg";
+    readonly G: "g";
+    readonly Lb: "lb";
+    readonly Oz: "oz";
+};
+export type CreateShipmentRequestParcelsInnerWeightUnitEnum = typeof CreateShipmentRequestParcelsInnerWeightUnitEnum[keyof typeof CreateShipmentRequestParcelsInnerWeightUnitEnum];
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInner interface.
+ */
+export declare function instanceOfCreateShipmentRequestParcelsInner(value: object): value is CreateShipmentRequestParcelsInner;
+export declare function CreateShipmentRequestParcelsInnerFromJSON(json: any): CreateShipmentRequestParcelsInner;
+export declare function CreateShipmentRequestParcelsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestParcelsInner;
+export declare function CreateShipmentRequestParcelsInnerToJSON(json: any): CreateShipmentRequestParcelsInner;
+export declare function CreateShipmentRequestParcelsInnerToJSONTyped(value?: CreateShipmentRequestParcelsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequestParcelsInner.js

@@ -0,0 +1,88 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateShipmentRequestParcelsInnerWeightUnitEnum = void 0;
+exports.instanceOfCreateShipmentRequestParcelsInner = instanceOfCreateShipmentRequestParcelsInner;
+exports.CreateShipmentRequestParcelsInnerFromJSON = CreateShipmentRequestParcelsInnerFromJSON;
+exports.CreateShipmentRequestParcelsInnerFromJSONTyped = CreateShipmentRequestParcelsInnerFromJSONTyped;
+exports.CreateShipmentRequestParcelsInnerToJSON = CreateShipmentRequestParcelsInnerToJSON;
+exports.CreateShipmentRequestParcelsInnerToJSONTyped = CreateShipmentRequestParcelsInnerToJSONTyped;
+const CreateShipmentRequestParcelsInnerOrderLinesInner_1 = require("./CreateShipmentRequestParcelsInnerOrderLinesInner");
+const CreateShipmentRequestParcelsInnerDimensions_1 = require("./CreateShipmentRequestParcelsInnerDimensions");
+/**
+ * @export
+ */
+exports.CreateShipmentRequestParcelsInnerWeightUnitEnum = {
+    Kg: 'kg',
+    G: 'g',
+    Lb: 'lb',
+    Oz: 'oz'
+};
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInner interface.
+ */
+function instanceOfCreateShipmentRequestParcelsInner(value) {
+    if (!('weight' in value) || value['weight'] === undefined)
+        return false;
+    if (!('weightUnit' in value) || value['weightUnit'] === undefined)
+        return false;
+    if (!('dimensions' in value) || value['dimensions'] === undefined)
+        return false;
+    if (!('orderLines' in value) || value['orderLines'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestParcelsInnerFromJSON(json) {
+    return CreateShipmentRequestParcelsInnerFromJSONTyped(json, false);
+}
+function CreateShipmentRequestParcelsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'weight': json['weight'],
+        'weightUnit': json['weightUnit'],
+        'dimensions': (0, CreateShipmentRequestParcelsInnerDimensions_1.CreateShipmentRequestParcelsInnerDimensionsFromJSON)(json['dimensions']),
+        'orderLines': (json['orderLines'].map(CreateShipmentRequestParcelsInnerOrderLinesInner_1.CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSON)),
+        'trackingNumber': json['trackingNumber'] === undefined ? undefined : json['trackingNumber'] === null ? null : json['trackingNumber'],
+        'trackingUrl': json['trackingUrl'] === undefined ? undefined : json['trackingUrl'] === null ? null : json['trackingUrl'],
+        'labelFreeCode': json['labelFreeCode'] === undefined ? undefined : json['labelFreeCode'] === null ? null : json['labelFreeCode'],
+        'qrCodeLink': json['qrCodeLink'] === undefined ? undefined : json['qrCodeLink'] === null ? null : json['qrCodeLink'],
+        'qrCodeDataUri': json['qrCodeDataUri'] === undefined ? undefined : json['qrCodeDataUri'] === null ? null : json['qrCodeDataUri'],
+        'qrCodeUrl': json['qrCodeUrl'] === undefined ? undefined : json['qrCodeUrl'] === null ? null : json['qrCodeUrl'],
+    };
+}
+function CreateShipmentRequestParcelsInnerToJSON(json) {
+    return CreateShipmentRequestParcelsInnerToJSONTyped(json, false);
+}
+function CreateShipmentRequestParcelsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'weight': value['weight'],
+        'weightUnit': value['weightUnit'],
+        'dimensions': (0, CreateShipmentRequestParcelsInnerDimensions_1.CreateShipmentRequestParcelsInnerDimensionsToJSON)(value['dimensions']),
+        'orderLines': (value['orderLines'].map(CreateShipmentRequestParcelsInnerOrderLinesInner_1.CreateShipmentRequestParcelsInnerOrderLinesInnerToJSON)),
+        'trackingNumber': value['trackingNumber'],
+        'trackingUrl': value['trackingUrl'],
+        'labelFreeCode': value['labelFreeCode'],
+        'qrCodeLink': value['qrCodeLink'],
+        'qrCodeDataUri': value['qrCodeDataUri'],
+        'qrCodeUrl': value['qrCodeUrl'],
+    };
+}

package/dist/models/CreateShipmentRequestParcelsInnerDimensions.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateShipmentRequestParcelsInnerDimensions
+ */
+export interface CreateShipmentRequestParcelsInnerDimensions {
+    /**
+     * Parcel length in centimetres.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerDimensions
+     */
+    length: number;
+    /**
+     * Parcel width in centimetres.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerDimensions
+     */
+    width: number;
+    /**
+     * Parcel height in centimetres.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerDimensions
+     */
+    height: number;
+}
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInnerDimensions interface.
+ */
+export declare function instanceOfCreateShipmentRequestParcelsInnerDimensions(value: object): value is CreateShipmentRequestParcelsInnerDimensions;
+export declare function CreateShipmentRequestParcelsInnerDimensionsFromJSON(json: any): CreateShipmentRequestParcelsInnerDimensions;
+export declare function CreateShipmentRequestParcelsInnerDimensionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestParcelsInnerDimensions;
+export declare function CreateShipmentRequestParcelsInnerDimensionsToJSON(json: any): CreateShipmentRequestParcelsInnerDimensions;
+export declare function CreateShipmentRequestParcelsInnerDimensionsToJSONTyped(value?: CreateShipmentRequestParcelsInnerDimensions | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequestParcelsInnerDimensions.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateShipmentRequestParcelsInnerDimensions = instanceOfCreateShipmentRequestParcelsInnerDimensions;
+exports.CreateShipmentRequestParcelsInnerDimensionsFromJSON = CreateShipmentRequestParcelsInnerDimensionsFromJSON;
+exports.CreateShipmentRequestParcelsInnerDimensionsFromJSONTyped = CreateShipmentRequestParcelsInnerDimensionsFromJSONTyped;
+exports.CreateShipmentRequestParcelsInnerDimensionsToJSON = CreateShipmentRequestParcelsInnerDimensionsToJSON;
+exports.CreateShipmentRequestParcelsInnerDimensionsToJSONTyped = CreateShipmentRequestParcelsInnerDimensionsToJSONTyped;
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInnerDimensions interface.
+ */
+function instanceOfCreateShipmentRequestParcelsInnerDimensions(value) {
+    if (!('length' in value) || value['length'] === undefined)
+        return false;
+    if (!('width' in value) || value['width'] === undefined)
+        return false;
+    if (!('height' in value) || value['height'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestParcelsInnerDimensionsFromJSON(json) {
+    return CreateShipmentRequestParcelsInnerDimensionsFromJSONTyped(json, false);
+}
+function CreateShipmentRequestParcelsInnerDimensionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'length': json['length'],
+        'width': json['width'],
+        'height': json['height'],
+    };
+}
+function CreateShipmentRequestParcelsInnerDimensionsToJSON(json) {
+    return CreateShipmentRequestParcelsInnerDimensionsToJSONTyped(json, false);
+}
+function CreateShipmentRequestParcelsInnerDimensionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'length': value['length'],
+        'width': value['width'],
+        'height': value['height'],
+    };
+}

package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CreateShipmentRequestParcelsInnerOrderLinesInner
+ */
+export interface CreateShipmentRequestParcelsInnerOrderLinesInner {
+    /**
+     * Unique order line identifier.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    id?: string;
+    /**
+     * Stock keeping unit of the product.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    sku: string;
+    /**
+     * Number of units in this order line.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    quantity: number;
+    /**
+     * Human-readable product description.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    description?: string | null;
+    /**
+     * Price per unit in the order line currency.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    unitPrice?: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    currency?: string | null;
+    /**
+     * VAT percentage applied to the unit price.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    vatPercent?: number | null;
+    /**
+     * Warehouse picking location.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    location?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country of origin.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    countryOfOrigin?: string;
+    /**
+     * Customs tariff (HS) code.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    tarrifNumber?: string | null;
+}
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInnerOrderLinesInner interface.
+ */
+export declare function instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner(value: object): value is CreateShipmentRequestParcelsInnerOrderLinesInner;
+export declare function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSON(json: any): CreateShipmentRequestParcelsInnerOrderLinesInner;
+export declare function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestParcelsInnerOrderLinesInner;
+export declare function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSON(json: any): CreateShipmentRequestParcelsInnerOrderLinesInner;
+export declare function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(value?: CreateShipmentRequestParcelsInnerOrderLinesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js

@@ -0,0 +1,70 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner = instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner;
+exports.CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSON = CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSON;
+exports.CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped = CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped;
+exports.CreateShipmentRequestParcelsInnerOrderLinesInnerToJSON = CreateShipmentRequestParcelsInnerOrderLinesInnerToJSON;
+exports.CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped = CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped;
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInnerOrderLinesInner interface.
+ */
+function instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner(value) {
+    if (!('sku' in value) || value['sku'] === undefined)
+        return false;
+    if (!('quantity' in value) || value['quantity'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSON(json) {
+    return CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json, false);
+}
+function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'sku': json['sku'],
+        'quantity': json['quantity'],
+        'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
+        'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
+        'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
+        'vatPercent': json['vatPercent'] === undefined ? undefined : json['vatPercent'] === null ? null : json['vatPercent'],
+        'location': json['location'] === undefined ? undefined : json['location'] === null ? null : json['location'],
+        'countryOfOrigin': json['countryOfOrigin'] == null ? undefined : json['countryOfOrigin'],
+        'tarrifNumber': json['tarrifNumber'] === undefined ? undefined : json['tarrifNumber'] === null ? null : json['tarrifNumber'],
+    };
+}
+function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSON(json) {
+    return CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(json, false);
+}
+function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'sku': value['sku'],
+        'quantity': value['quantity'],
+        'description': value['description'],
+        'unitPrice': value['unitPrice'],
+        'currency': value['currency'],
+        'vatPercent': value['vatPercent'],
+        'location': value['location'],
+        'countryOfOrigin': value['countryOfOrigin'],
+        'tarrifNumber': value['tarrifNumber'],
+    };
+}

package/dist/models/CreateShipmentRequestPartiesInner.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CreateShipmentRequestPartiesInnerAttributesInner } from './CreateShipmentRequestPartiesInnerAttributesInner';
+/**
+ *
+ * @export
+ * @interface CreateShipmentRequestPartiesInner
+ */
+export interface CreateShipmentRequestPartiesInner {
+    /**
+     * Role of the party in the shipment.
+     * @type {CreateShipmentRequestPartiesInnerTypeEnum}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    type: CreateShipmentRequestPartiesInnerTypeEnum;
+    /**
+     * Full name or company name of the party.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    name: string;
+    /**
+     * Attention contact at the party.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    attention?: string | null;
+    /**
+     * Primary street address line.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    address1: string;
+    /**
+     * Secondary address line.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    address2?: string | null;
+    /**
+     * Postal code of the party address.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    postalCode: string;
+    /**
+     * City of the party address.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    city: string;
+    /**
+     * ISO 3166-1 alpha-2 country code.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    countryCode: string;
+    /**
+     * Email address of the party.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    email?: string | null;
+    /**
+     * Phone number of the party in E.164 format.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    phone?: string | null;
+    /**
+     * Additional carrier-specific attributes for the party.
+     * @type {Array<CreateShipmentRequestPartiesInnerAttributesInner>}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    attributes?: Array<CreateShipmentRequestPartiesInnerAttributesInner>;
+}
+/**
+ * @export
+ */
+export declare const CreateShipmentRequestPartiesInnerTypeEnum: {
+    readonly Sender: "sender";
+    readonly Receiver: "receiver";
+    readonly Pickup: "pickup";
+    readonly Billing: "billing";
+    readonly FreightPayer: "freight_payer";
+    readonly ServicePoint: "service_point";
+    readonly Return: "return";
+};
+export type CreateShipmentRequestPartiesInnerTypeEnum = typeof CreateShipmentRequestPartiesInnerTypeEnum[keyof typeof CreateShipmentRequestPartiesInnerTypeEnum];
+/**
+ * Check if a given object implements the CreateShipmentRequestPartiesInner interface.
+ */
+export declare function instanceOfCreateShipmentRequestPartiesInner(value: object): value is CreateShipmentRequestPartiesInner;
+export declare function CreateShipmentRequestPartiesInnerFromJSON(json: any): CreateShipmentRequestPartiesInner;
+export declare function CreateShipmentRequestPartiesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestPartiesInner;
+export declare function CreateShipmentRequestPartiesInnerToJSON(json: any): CreateShipmentRequestPartiesInner;
+export declare function CreateShipmentRequestPartiesInnerToJSONTyped(value?: CreateShipmentRequestPartiesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequestPartiesInner.js

@@ -0,0 +1,94 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateShipmentRequestPartiesInnerTypeEnum = void 0;
+exports.instanceOfCreateShipmentRequestPartiesInner = instanceOfCreateShipmentRequestPartiesInner;
+exports.CreateShipmentRequestPartiesInnerFromJSON = CreateShipmentRequestPartiesInnerFromJSON;
+exports.CreateShipmentRequestPartiesInnerFromJSONTyped = CreateShipmentRequestPartiesInnerFromJSONTyped;
+exports.CreateShipmentRequestPartiesInnerToJSON = CreateShipmentRequestPartiesInnerToJSON;
+exports.CreateShipmentRequestPartiesInnerToJSONTyped = CreateShipmentRequestPartiesInnerToJSONTyped;
+const CreateShipmentRequestPartiesInnerAttributesInner_1 = require("./CreateShipmentRequestPartiesInnerAttributesInner");
+/**
+ * @export
+ */
+exports.CreateShipmentRequestPartiesInnerTypeEnum = {
+    Sender: 'sender',
+    Receiver: 'receiver',
+    Pickup: 'pickup',
+    Billing: 'billing',
+    FreightPayer: 'freight_payer',
+    ServicePoint: 'service_point',
+    Return: 'return'
+};
+/**
+ * Check if a given object implements the CreateShipmentRequestPartiesInner interface.
+ */
+function instanceOfCreateShipmentRequestPartiesInner(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('address1' in value) || value['address1'] === undefined)
+        return false;
+    if (!('postalCode' in value) || value['postalCode'] === undefined)
+        return false;
+    if (!('city' in value) || value['city'] === undefined)
+        return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestPartiesInnerFromJSON(json) {
+    return CreateShipmentRequestPartiesInnerFromJSONTyped(json, false);
+}
+function CreateShipmentRequestPartiesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'name': json['name'],
+        'attention': json['attention'] === undefined ? undefined : json['attention'] === null ? null : json['attention'],
+        'address1': json['address1'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
+        'postalCode': json['postalCode'],
+        'city': json['city'],
+        'countryCode': json['countryCode'],
+        'email': json['email'] === undefined ? undefined : json['email'] === null ? null : json['email'],
+        'phone': json['phone'] === undefined ? undefined : json['phone'] === null ? null : json['phone'],
+        'attributes': json['attributes'] == null ? undefined : (json['attributes'].map(CreateShipmentRequestPartiesInnerAttributesInner_1.CreateShipmentRequestPartiesInnerAttributesInnerFromJSON)),
+    };
+}
+function CreateShipmentRequestPartiesInnerToJSON(json) {
+    return CreateShipmentRequestPartiesInnerToJSONTyped(json, false);
+}
+function CreateShipmentRequestPartiesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'name': value['name'],
+        'attention': value['attention'],
+        'address1': value['address1'],
+        'address2': value['address2'],
+        'postalCode': value['postalCode'],
+        'city': value['city'],
+        'countryCode': value['countryCode'],
+        'email': value['email'],
+        'phone': value['phone'],
+        'attributes': value['attributes'] == null ? undefined : (value['attributes'].map(CreateShipmentRequestPartiesInnerAttributesInner_1.CreateShipmentRequestPartiesInnerAttributesInnerToJSON)),
+    };
+}