@zippendo/sdk 1.0.0

package/dist/models/CreateShipment201ResponseShippingRule.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 CreateShipment201ResponseShippingRule
+ */
+export interface CreateShipment201ResponseShippingRule {
+    /**
+     * Unique shipping rule identifier.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    id: string;
+    /**
+     * Display name of the shipping rule.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    name: string;
+    /**
+     * Carrier applied by the rule.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    carrierId: string;
+    /**
+     * Carrier product applied by the rule.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    productId: string;
+    /**
+     * Additional service codes applied by the rule.
+     * @type {Array<string>}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    services: Array<string>;
+    /**
+     * Sender address applied by the rule.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    addressId: string;
+    /**
+     * Shipping rule used for return shipments.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    returnShippingRuleId?: string | null;
+    /**
+     * Whether a return shipment is created automatically.
+     * @type {boolean}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    autoCreateReturnShipment?: boolean;
+    /**
+     * Whether labels are printed automatically on send.
+     * @type {boolean}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    autoPrintLabels?: boolean;
+    /**
+     * Whether documents are printed automatically on send.
+     * @type {boolean}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    autoPrintDocuments?: boolean;
+    /**
+     * Printer used for labels.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    labelPrinterId?: string | null;
+    /**
+     * Printer used for documents.
+     * @type {string}
+     * @memberof CreateShipment201ResponseShippingRule
+     */
+    documentPrinterId?: string | null;
+}
+/**
+ * Check if a given object implements the CreateShipment201ResponseShippingRule interface.
+ */
+export declare function instanceOfCreateShipment201ResponseShippingRule(value: object): value is CreateShipment201ResponseShippingRule;
+export declare function CreateShipment201ResponseShippingRuleFromJSON(json: any): CreateShipment201ResponseShippingRule;
+export declare function CreateShipment201ResponseShippingRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipment201ResponseShippingRule;
+export declare function CreateShipment201ResponseShippingRuleToJSON(json: any): CreateShipment201ResponseShippingRule;
+export declare function CreateShipment201ResponseShippingRuleToJSONTyped(value?: CreateShipment201ResponseShippingRule | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipment201ResponseShippingRule.js

@@ -0,0 +1,82 @@
+"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.instanceOfCreateShipment201ResponseShippingRule = instanceOfCreateShipment201ResponseShippingRule;
+exports.CreateShipment201ResponseShippingRuleFromJSON = CreateShipment201ResponseShippingRuleFromJSON;
+exports.CreateShipment201ResponseShippingRuleFromJSONTyped = CreateShipment201ResponseShippingRuleFromJSONTyped;
+exports.CreateShipment201ResponseShippingRuleToJSON = CreateShipment201ResponseShippingRuleToJSON;
+exports.CreateShipment201ResponseShippingRuleToJSONTyped = CreateShipment201ResponseShippingRuleToJSONTyped;
+/**
+ * Check if a given object implements the CreateShipment201ResponseShippingRule interface.
+ */
+function instanceOfCreateShipment201ResponseShippingRule(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('carrierId' in value) || value['carrierId'] === undefined)
+        return false;
+    if (!('productId' in value) || value['productId'] === undefined)
+        return false;
+    if (!('services' in value) || value['services'] === undefined)
+        return false;
+    if (!('addressId' in value) || value['addressId'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipment201ResponseShippingRuleFromJSON(json) {
+    return CreateShipment201ResponseShippingRuleFromJSONTyped(json, false);
+}
+function CreateShipment201ResponseShippingRuleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'carrierId': json['carrierId'],
+        'productId': json['productId'],
+        'services': json['services'],
+        'addressId': json['addressId'],
+        'returnShippingRuleId': json['returnShippingRuleId'] === undefined ? undefined : json['returnShippingRuleId'] === null ? null : json['returnShippingRuleId'],
+        'autoCreateReturnShipment': json['autoCreateReturnShipment'] == null ? undefined : json['autoCreateReturnShipment'],
+        'autoPrintLabels': json['autoPrintLabels'] == null ? undefined : json['autoPrintLabels'],
+        'autoPrintDocuments': json['autoPrintDocuments'] == null ? undefined : json['autoPrintDocuments'],
+        'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
+        'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
+    };
+}
+function CreateShipment201ResponseShippingRuleToJSON(json) {
+    return CreateShipment201ResponseShippingRuleToJSONTyped(json, false);
+}
+function CreateShipment201ResponseShippingRuleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'addressId': value['addressId'],
+        'returnShippingRuleId': value['returnShippingRuleId'],
+        'autoCreateReturnShipment': value['autoCreateReturnShipment'],
+        'autoPrintLabels': value['autoPrintLabels'],
+        'autoPrintDocuments': value['autoPrintDocuments'],
+        'labelPrinterId': value['labelPrinterId'],
+        'documentPrinterId': value['documentPrinterId'],
+    };
+}

package/dist/models/CreateShipment201ResponseTracking.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 CreateShipment201ResponseTracking
+ */
+export interface CreateShipment201ResponseTracking {
+    /**
+     * Public carrier tracking URL.
+     * @type {string}
+     * @memberof CreateShipment201ResponseTracking
+     */
+    url?: string | null;
+    /**
+     * Carrier tracking number.
+     * @type {string}
+     * @memberof CreateShipment201ResponseTracking
+     */
+    number?: string | null;
+    /**
+     * Label-free drop-off code.
+     * @type {string}
+     * @memberof CreateShipment201ResponseTracking
+     */
+    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 CreateShipment201ResponseTracking
+     */
+    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 CreateShipment201ResponseTracking
+     */
+    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 CreateShipment201ResponseTracking
+     */
+    qrCodeUrl?: string | null;
+}
+/**
+ * Check if a given object implements the CreateShipment201ResponseTracking interface.
+ */
+export declare function instanceOfCreateShipment201ResponseTracking(value: object): value is CreateShipment201ResponseTracking;
+export declare function CreateShipment201ResponseTrackingFromJSON(json: any): CreateShipment201ResponseTracking;
+export declare function CreateShipment201ResponseTrackingFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipment201ResponseTracking;
+export declare function CreateShipment201ResponseTrackingToJSON(json: any): CreateShipment201ResponseTracking;
+export declare function CreateShipment201ResponseTrackingToJSONTyped(value?: CreateShipment201ResponseTracking | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipment201ResponseTracking.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.instanceOfCreateShipment201ResponseTracking = instanceOfCreateShipment201ResponseTracking;
+exports.CreateShipment201ResponseTrackingFromJSON = CreateShipment201ResponseTrackingFromJSON;
+exports.CreateShipment201ResponseTrackingFromJSONTyped = CreateShipment201ResponseTrackingFromJSONTyped;
+exports.CreateShipment201ResponseTrackingToJSON = CreateShipment201ResponseTrackingToJSON;
+exports.CreateShipment201ResponseTrackingToJSONTyped = CreateShipment201ResponseTrackingToJSONTyped;
+/**
+ * Check if a given object implements the CreateShipment201ResponseTracking interface.
+ */
+function instanceOfCreateShipment201ResponseTracking(value) {
+    return true;
+}
+function CreateShipment201ResponseTrackingFromJSON(json) {
+    return CreateShipment201ResponseTrackingFromJSONTyped(json, false);
+}
+function CreateShipment201ResponseTrackingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'url': json['url'] === undefined ? undefined : json['url'] === null ? null : json['url'],
+        'number': json['number'] === undefined ? undefined : json['number'] === null ? null : json['number'],
+        '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 CreateShipment201ResponseTrackingToJSON(json) {
+    return CreateShipment201ResponseTrackingToJSONTyped(json, false);
+}
+function CreateShipment201ResponseTrackingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'url': value['url'],
+        'number': value['number'],
+        'labelFreeCode': value['labelFreeCode'],
+        'qrCodeLink': value['qrCodeLink'],
+        'qrCodeDataUri': value['qrCodeDataUri'],
+        'qrCodeUrl': value['qrCodeUrl'],
+    };
+}

package/dist/models/CreateShipmentRequest.d.ts

@@ -0,0 +1,130 @@
+/**
+ * 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 { CreateShipmentRequestPickupDetails } from './CreateShipmentRequestPickupDetails';
+import type { CreateShipmentRequestCarrierSettings } from './CreateShipmentRequestCarrierSettings';
+import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
+import type { CreateShipmentRequestParcelsInner } from './CreateShipmentRequestParcelsInner';
+/**
+ *
+ * @export
+ * @interface CreateShipmentRequest
+ */
+export interface CreateShipmentRequest {
+    /**
+     * Customer-facing shipment reference.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    reference?: string;
+    /**
+     * Sender address identifier.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    addressId?: string | null;
+    /**
+     * Selected carrier service point identifier.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    servicePointId?: string | null;
+    /**
+     * Parties involved in the shipment. Optional when orderId is provided.
+     * @type {Array<CreateShipmentRequestPartiesInner>}
+     * @memberof CreateShipmentRequest
+     */
+    parties?: Array<CreateShipmentRequestPartiesInner>;
+    /**
+     * Direction of the shipment relative to the organization.
+     * @type {CreateShipmentRequestTypeEnum}
+     * @memberof CreateShipmentRequest
+     */
+    type: CreateShipmentRequestTypeEnum;
+    /**
+     *
+     * @type {CreateShipmentRequestCarrierSettings}
+     * @memberof CreateShipmentRequest
+     */
+    carrierSettings: CreateShipmentRequestCarrierSettings;
+    /**
+     * Parcels to include. Optional when orderId is provided.
+     * @type {Array<CreateShipmentRequestParcelsInner>}
+     * @memberof CreateShipmentRequest
+     */
+    parcels?: Array<CreateShipmentRequestParcelsInner>;
+    /**
+     *
+     * @type {CreateShipmentRequestPickupDetails}
+     * @memberof CreateShipmentRequest
+     */
+    pickupDetails?: CreateShipmentRequestPickupDetails | null;
+    /**
+     * Incoterm governing the shipment.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    termOfTrade?: string;
+    /**
+     * Lifecycle status of the shipment.
+     * @type {CreateShipmentRequestStatusEnum}
+     * @memberof CreateShipmentRequest
+     */
+    status?: CreateShipmentRequestStatusEnum;
+    /**
+     * Order to derive parties and parcels from.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    orderId?: string | null;
+    /**
+     * Printer to assign for labels.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    labelPrinterId?: string | null;
+    /**
+     * Printer to assign for documents.
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    documentPrinterId?: string | null;
+}
+/**
+ * @export
+ */
+export declare const CreateShipmentRequestTypeEnum: {
+    readonly Outbound: "outbound";
+    readonly Inbound: "inbound";
+};
+export type CreateShipmentRequestTypeEnum = typeof CreateShipmentRequestTypeEnum[keyof typeof CreateShipmentRequestTypeEnum];
+/**
+ * @export
+ */
+export declare const CreateShipmentRequestStatusEnum: {
+    readonly Draft: "draft";
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Dispatched: "dispatched";
+    readonly PartlyDispatched: "partly_dispatched";
+    readonly Error: "error";
+    readonly Cancelled: "cancelled";
+    readonly OnHold: "on_hold";
+};
+export type CreateShipmentRequestStatusEnum = typeof CreateShipmentRequestStatusEnum[keyof typeof CreateShipmentRequestStatusEnum];
+/**
+ * Check if a given object implements the CreateShipmentRequest interface.
+ */
+export declare function instanceOfCreateShipmentRequest(value: object): value is CreateShipmentRequest;
+export declare function CreateShipmentRequestFromJSON(json: any): CreateShipmentRequest;
+export declare function CreateShipmentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequest;
+export declare function CreateShipmentRequestToJSON(json: any): CreateShipmentRequest;
+export declare function CreateShipmentRequestToJSONTyped(value?: CreateShipmentRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequest.js

@@ -0,0 +1,101 @@
+"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.CreateShipmentRequestStatusEnum = exports.CreateShipmentRequestTypeEnum = void 0;
+exports.instanceOfCreateShipmentRequest = instanceOfCreateShipmentRequest;
+exports.CreateShipmentRequestFromJSON = CreateShipmentRequestFromJSON;
+exports.CreateShipmentRequestFromJSONTyped = CreateShipmentRequestFromJSONTyped;
+exports.CreateShipmentRequestToJSON = CreateShipmentRequestToJSON;
+exports.CreateShipmentRequestToJSONTyped = CreateShipmentRequestToJSONTyped;
+const CreateShipmentRequestPickupDetails_1 = require("./CreateShipmentRequestPickupDetails");
+const CreateShipmentRequestCarrierSettings_1 = require("./CreateShipmentRequestCarrierSettings");
+const CreateShipmentRequestPartiesInner_1 = require("./CreateShipmentRequestPartiesInner");
+const CreateShipmentRequestParcelsInner_1 = require("./CreateShipmentRequestParcelsInner");
+/**
+ * @export
+ */
+exports.CreateShipmentRequestTypeEnum = {
+    Outbound: 'outbound',
+    Inbound: 'inbound'
+};
+/**
+ * @export
+ */
+exports.CreateShipmentRequestStatusEnum = {
+    Draft: 'draft',
+    Pending: 'pending',
+    Processing: 'processing',
+    Dispatched: 'dispatched',
+    PartlyDispatched: 'partly_dispatched',
+    Error: 'error',
+    Cancelled: 'cancelled',
+    OnHold: 'on_hold'
+};
+/**
+ * Check if a given object implements the CreateShipmentRequest interface.
+ */
+function instanceOfCreateShipmentRequest(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('carrierSettings' in value) || value['carrierSettings'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestFromJSON(json) {
+    return CreateShipmentRequestFromJSONTyped(json, false);
+}
+function CreateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reference': json['reference'] == null ? undefined : json['reference'],
+        'addressId': json['addressId'] === undefined ? undefined : json['addressId'] === null ? null : json['addressId'],
+        'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
+        'parties': json['parties'] == null ? undefined : (json['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerFromJSON)),
+        'type': json['type'],
+        'carrierSettings': (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
+        'parcels': json['parcels'] == null ? undefined : (json['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerFromJSON)),
+        'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsFromJSON)(json['pickupDetails']),
+        'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'orderId': json['orderId'] === undefined ? undefined : json['orderId'] === null ? null : json['orderId'],
+        'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
+        'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
+    };
+}
+function CreateShipmentRequestToJSON(json) {
+    return CreateShipmentRequestToJSONTyped(json, false);
+}
+function CreateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reference': value['reference'],
+        'addressId': value['addressId'],
+        'servicePointId': value['servicePointId'],
+        'parties': value['parties'] == null ? undefined : (value['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerToJSON)),
+        'type': value['type'],
+        'carrierSettings': (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsToJSON)(value['carrierSettings']),
+        'parcels': value['parcels'] == null ? undefined : (value['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerToJSON)),
+        'pickupDetails': (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsToJSON)(value['pickupDetails']),
+        'termOfTrade': value['termOfTrade'],
+        'status': value['status'],
+        'orderId': value['orderId'],
+        'labelPrinterId': value['labelPrinterId'],
+        'documentPrinterId': value['documentPrinterId'],
+    };
+}

package/dist/models/CreateShipmentRequestCarrierSettings.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 { CreateShippingRuleRequestAdditionalParametersAnyOfValue } from './CreateShippingRuleRequestAdditionalParametersAnyOfValue';
+/**
+ *
+ * @export
+ * @interface CreateShipmentRequestCarrierSettings
+ */
+export interface CreateShipmentRequestCarrierSettings {
+    /**
+     * Identifier of the carrier to use.
+     * @type {string}
+     * @memberof CreateShipmentRequestCarrierSettings
+     */
+    carrierId: string;
+    /**
+     * Identifier of the carrier product/service.
+     * @type {string}
+     * @memberof CreateShipmentRequestCarrierSettings
+     */
+    productId: string;
+    /**
+     * Additional service codes requested from the carrier.
+     * @type {Array<string>}
+     * @memberof CreateShipmentRequestCarrierSettings
+     */
+    services: Array<string>;
+    /**
+     * Carrier-specific extra parameters as key/value pairs.
+     * @type {{ [key: string]: CreateShippingRuleRequestAdditionalParametersAnyOfValue; }}
+     * @memberof CreateShipmentRequestCarrierSettings
+     */
+    additionalParameters: {
+        [key: string]: CreateShippingRuleRequestAdditionalParametersAnyOfValue;
+    };
+}
+/**
+ * Check if a given object implements the CreateShipmentRequestCarrierSettings interface.
+ */
+export declare function instanceOfCreateShipmentRequestCarrierSettings(value: object): value is CreateShipmentRequestCarrierSettings;
+export declare function CreateShipmentRequestCarrierSettingsFromJSON(json: any): CreateShipmentRequestCarrierSettings;
+export declare function CreateShipmentRequestCarrierSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestCarrierSettings;
+export declare function CreateShipmentRequestCarrierSettingsToJSON(json: any): CreateShipmentRequestCarrierSettings;
+export declare function CreateShipmentRequestCarrierSettingsToJSONTyped(value?: CreateShipmentRequestCarrierSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequestCarrierSettings.js

@@ -0,0 +1,64 @@
+"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.instanceOfCreateShipmentRequestCarrierSettings = instanceOfCreateShipmentRequestCarrierSettings;
+exports.CreateShipmentRequestCarrierSettingsFromJSON = CreateShipmentRequestCarrierSettingsFromJSON;
+exports.CreateShipmentRequestCarrierSettingsFromJSONTyped = CreateShipmentRequestCarrierSettingsFromJSONTyped;
+exports.CreateShipmentRequestCarrierSettingsToJSON = CreateShipmentRequestCarrierSettingsToJSON;
+exports.CreateShipmentRequestCarrierSettingsToJSONTyped = CreateShipmentRequestCarrierSettingsToJSONTyped;
+const runtime_1 = require("../runtime");
+const CreateShippingRuleRequestAdditionalParametersAnyOfValue_1 = require("./CreateShippingRuleRequestAdditionalParametersAnyOfValue");
+/**
+ * Check if a given object implements the CreateShipmentRequestCarrierSettings interface.
+ */
+function instanceOfCreateShipmentRequestCarrierSettings(value) {
+    if (!('carrierId' in value) || value['carrierId'] === undefined)
+        return false;
+    if (!('productId' in value) || value['productId'] === undefined)
+        return false;
+    if (!('services' in value) || value['services'] === undefined)
+        return false;
+    if (!('additionalParameters' in value) || value['additionalParameters'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestCarrierSettingsFromJSON(json) {
+    return CreateShipmentRequestCarrierSettingsFromJSONTyped(json, false);
+}
+function CreateShipmentRequestCarrierSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'carrierId': json['carrierId'],
+        'productId': json['productId'],
+        'services': json['services'],
+        'additionalParameters': ((0, runtime_1.mapValues)(json['additionalParameters'], CreateShippingRuleRequestAdditionalParametersAnyOfValue_1.CreateShippingRuleRequestAdditionalParametersAnyOfValueFromJSON)),
+    };
+}
+function CreateShipmentRequestCarrierSettingsToJSON(json) {
+    return CreateShipmentRequestCarrierSettingsToJSONTyped(json, false);
+}
+function CreateShipmentRequestCarrierSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'additionalParameters': ((0, runtime_1.mapValues)(value['additionalParameters'], CreateShippingRuleRequestAdditionalParametersAnyOfValue_1.CreateShippingRuleRequestAdditionalParametersAnyOfValueToJSON)),
+    };
+}