@zippendo/sdk 1.0.0

package/dist/models/CreateShippingQuoteRequest.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { CreateShippingQuoteRequestDestination } from './CreateShippingQuoteRequestDestination';
+import type { CreateShippingQuoteRequestItemsInner } from './CreateShippingQuoteRequestItemsInner';
+/**
+ *
+ * @export
+ * @interface CreateShippingQuoteRequest
+ */
+export interface CreateShippingQuoteRequest {
+    /**
+     *
+     * @type {CreateShippingQuoteRequestDestination}
+     * @memberof CreateShippingQuoteRequest
+     */
+    destination: CreateShippingQuoteRequestDestination;
+    /**
+     * Cart items
+     * @type {Array<CreateShippingQuoteRequestItemsInner>}
+     * @memberof CreateShippingQuoteRequest
+     */
+    items: Array<CreateShippingQuoteRequestItemsInner>;
+    /**
+     * ISO 4217 currency code
+     * @type {string}
+     * @memberof CreateShippingQuoteRequest
+     */
+    currency: string;
+    /**
+     * Total price in cents after discounts (optional, enables total-based conditions)
+     * @type {number}
+     * @memberof CreateShippingQuoteRequest
+     */
+    totalPriceCents?: number;
+}
+/**
+ * Check if a given object implements the CreateShippingQuoteRequest interface.
+ */
+export declare function instanceOfCreateShippingQuoteRequest(value: object): value is CreateShippingQuoteRequest;
+export declare function CreateShippingQuoteRequestFromJSON(json: any): CreateShippingQuoteRequest;
+export declare function CreateShippingQuoteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShippingQuoteRequest;
+export declare function CreateShippingQuoteRequestToJSON(json: any): CreateShippingQuoteRequest;
+export declare function CreateShippingQuoteRequestToJSONTyped(value?: CreateShippingQuoteRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShippingQuoteRequest.js

@@ -0,0 +1,62 @@
+"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.instanceOfCreateShippingQuoteRequest = instanceOfCreateShippingQuoteRequest;
+exports.CreateShippingQuoteRequestFromJSON = CreateShippingQuoteRequestFromJSON;
+exports.CreateShippingQuoteRequestFromJSONTyped = CreateShippingQuoteRequestFromJSONTyped;
+exports.CreateShippingQuoteRequestToJSON = CreateShippingQuoteRequestToJSON;
+exports.CreateShippingQuoteRequestToJSONTyped = CreateShippingQuoteRequestToJSONTyped;
+const CreateShippingQuoteRequestDestination_1 = require("./CreateShippingQuoteRequestDestination");
+const CreateShippingQuoteRequestItemsInner_1 = require("./CreateShippingQuoteRequestItemsInner");
+/**
+ * Check if a given object implements the CreateShippingQuoteRequest interface.
+ */
+function instanceOfCreateShippingQuoteRequest(value) {
+    if (!('destination' in value) || value['destination'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('currency' in value) || value['currency'] === undefined)
+        return false;
+    return true;
+}
+function CreateShippingQuoteRequestFromJSON(json) {
+    return CreateShippingQuoteRequestFromJSONTyped(json, false);
+}
+function CreateShippingQuoteRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'destination': (0, CreateShippingQuoteRequestDestination_1.CreateShippingQuoteRequestDestinationFromJSON)(json['destination']),
+        'items': (json['items'].map(CreateShippingQuoteRequestItemsInner_1.CreateShippingQuoteRequestItemsInnerFromJSON)),
+        'currency': json['currency'],
+        'totalPriceCents': json['totalPriceCents'] == null ? undefined : json['totalPriceCents'],
+    };
+}
+function CreateShippingQuoteRequestToJSON(json) {
+    return CreateShippingQuoteRequestToJSONTyped(json, false);
+}
+function CreateShippingQuoteRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'destination': (0, CreateShippingQuoteRequestDestination_1.CreateShippingQuoteRequestDestinationToJSON)(value['destination']),
+        'items': (value['items'].map(CreateShippingQuoteRequestItemsInner_1.CreateShippingQuoteRequestItemsInnerToJSON)),
+        'currency': value['currency'],
+        'totalPriceCents': value['totalPriceCents'],
+    };
+}

package/dist/models/CreateShippingQuoteRequestDestination.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 CreateShippingQuoteRequestDestination
+ */
+export interface CreateShippingQuoteRequestDestination {
+    /**
+     * ISO 3166-1 alpha-2 country code
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestDestination
+     */
+    country: string;
+    /**
+     * Postal/ZIP code
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestDestination
+     */
+    postalCode?: string;
+    /**
+     * State/province code
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestDestination
+     */
+    province?: string;
+    /**
+     * City name
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestDestination
+     */
+    city?: string;
+    /**
+     * Street address line 1
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestDestination
+     */
+    address1?: string;
+    /**
+     * Street address line 2
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestDestination
+     */
+    address2?: string;
+}
+/**
+ * Check if a given object implements the CreateShippingQuoteRequestDestination interface.
+ */
+export declare function instanceOfCreateShippingQuoteRequestDestination(value: object): value is CreateShippingQuoteRequestDestination;
+export declare function CreateShippingQuoteRequestDestinationFromJSON(json: any): CreateShippingQuoteRequestDestination;
+export declare function CreateShippingQuoteRequestDestinationFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShippingQuoteRequestDestination;
+export declare function CreateShippingQuoteRequestDestinationToJSON(json: any): CreateShippingQuoteRequestDestination;
+export declare function CreateShippingQuoteRequestDestinationToJSONTyped(value?: CreateShippingQuoteRequestDestination | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShippingQuoteRequestDestination.js

@@ -0,0 +1,60 @@
+"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.instanceOfCreateShippingQuoteRequestDestination = instanceOfCreateShippingQuoteRequestDestination;
+exports.CreateShippingQuoteRequestDestinationFromJSON = CreateShippingQuoteRequestDestinationFromJSON;
+exports.CreateShippingQuoteRequestDestinationFromJSONTyped = CreateShippingQuoteRequestDestinationFromJSONTyped;
+exports.CreateShippingQuoteRequestDestinationToJSON = CreateShippingQuoteRequestDestinationToJSON;
+exports.CreateShippingQuoteRequestDestinationToJSONTyped = CreateShippingQuoteRequestDestinationToJSONTyped;
+/**
+ * Check if a given object implements the CreateShippingQuoteRequestDestination interface.
+ */
+function instanceOfCreateShippingQuoteRequestDestination(value) {
+    if (!('country' in value) || value['country'] === undefined)
+        return false;
+    return true;
+}
+function CreateShippingQuoteRequestDestinationFromJSON(json) {
+    return CreateShippingQuoteRequestDestinationFromJSONTyped(json, false);
+}
+function CreateShippingQuoteRequestDestinationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'country': json['country'],
+        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
+        'province': json['province'] == null ? undefined : json['province'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'address1': json['address1'] == null ? undefined : json['address1'],
+        'address2': json['address2'] == null ? undefined : json['address2'],
+    };
+}
+function CreateShippingQuoteRequestDestinationToJSON(json) {
+    return CreateShippingQuoteRequestDestinationToJSONTyped(json, false);
+}
+function CreateShippingQuoteRequestDestinationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'country': value['country'],
+        'postalCode': value['postalCode'],
+        'province': value['province'],
+        'city': value['city'],
+        'address1': value['address1'],
+        'address2': value['address2'],
+    };
+}

package/dist/models/CreateShippingQuoteRequestItemsInner.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 CreateShippingQuoteRequestItemsInner
+ */
+export interface CreateShippingQuoteRequestItemsInner {
+    /**
+     * Item name
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    name: string;
+    /**
+     * SKU identifier
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    sku?: string | null;
+    /**
+     * Quantity
+     * @type {number}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    quantity: number;
+    /**
+     * Weight in grams
+     * @type {number}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    grams: number;
+    /**
+     * Price in cents
+     * @type {number}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    price: number;
+    /**
+     * Product ID
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    productId?: string | null;
+    /**
+     * Variant ID
+     * @type {string}
+     * @memberof CreateShippingQuoteRequestItemsInner
+     */
+    variantId?: string | null;
+}
+/**
+ * Check if a given object implements the CreateShippingQuoteRequestItemsInner interface.
+ */
+export declare function instanceOfCreateShippingQuoteRequestItemsInner(value: object): value is CreateShippingQuoteRequestItemsInner;
+export declare function CreateShippingQuoteRequestItemsInnerFromJSON(json: any): CreateShippingQuoteRequestItemsInner;
+export declare function CreateShippingQuoteRequestItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShippingQuoteRequestItemsInner;
+export declare function CreateShippingQuoteRequestItemsInnerToJSON(json: any): CreateShippingQuoteRequestItemsInner;
+export declare function CreateShippingQuoteRequestItemsInnerToJSONTyped(value?: CreateShippingQuoteRequestItemsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShippingQuoteRequestItemsInner.js

@@ -0,0 +1,68 @@
+"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.instanceOfCreateShippingQuoteRequestItemsInner = instanceOfCreateShippingQuoteRequestItemsInner;
+exports.CreateShippingQuoteRequestItemsInnerFromJSON = CreateShippingQuoteRequestItemsInnerFromJSON;
+exports.CreateShippingQuoteRequestItemsInnerFromJSONTyped = CreateShippingQuoteRequestItemsInnerFromJSONTyped;
+exports.CreateShippingQuoteRequestItemsInnerToJSON = CreateShippingQuoteRequestItemsInnerToJSON;
+exports.CreateShippingQuoteRequestItemsInnerToJSONTyped = CreateShippingQuoteRequestItemsInnerToJSONTyped;
+/**
+ * Check if a given object implements the CreateShippingQuoteRequestItemsInner interface.
+ */
+function instanceOfCreateShippingQuoteRequestItemsInner(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('quantity' in value) || value['quantity'] === undefined)
+        return false;
+    if (!('grams' in value) || value['grams'] === undefined)
+        return false;
+    if (!('price' in value) || value['price'] === undefined)
+        return false;
+    return true;
+}
+function CreateShippingQuoteRequestItemsInnerFromJSON(json) {
+    return CreateShippingQuoteRequestItemsInnerFromJSONTyped(json, false);
+}
+function CreateShippingQuoteRequestItemsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
+        'quantity': json['quantity'],
+        'grams': json['grams'],
+        'price': json['price'],
+        'productId': json['productId'] === undefined ? undefined : json['productId'] === null ? null : json['productId'],
+        'variantId': json['variantId'] === undefined ? undefined : json['variantId'] === null ? null : json['variantId'],
+    };
+}
+function CreateShippingQuoteRequestItemsInnerToJSON(json) {
+    return CreateShippingQuoteRequestItemsInnerToJSONTyped(json, false);
+}
+function CreateShippingQuoteRequestItemsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'sku': value['sku'],
+        'quantity': value['quantity'],
+        'grams': value['grams'],
+        'price': value['price'],
+        'productId': value['productId'],
+        'variantId': value['variantId'],
+    };
+}

package/dist/models/CreateShippingRule201Response.d.ts

@@ -0,0 +1,210 @@
+/**
+ * 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 { ListShippingRules200ResponseDataInnerConditionsInner } from './ListShippingRules200ResponseDataInnerConditionsInner';
+import type { ListShippingRules200ResponseDataInnerAdditionalParametersInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersInner';
+/**
+ *
+ * @export
+ * @interface CreateShippingRule201Response
+ */
+export interface CreateShippingRule201Response {
+    /**
+     * Unique shipping rule identifier
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    id: string;
+    /**
+     * Shipping rule name
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    name: string;
+    /**
+     * Optional description
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    description: string | null;
+    /**
+     * Whether this rule is for outbound or inbound (return) shipments
+     * @type {CreateShippingRule201ResponseDirectionEnum}
+     * @memberof CreateShippingRule201Response
+     */
+    direction: CreateShippingRule201ResponseDirectionEnum;
+    /**
+     * Carrier ID
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    carrierId: string;
+    /**
+     * Product ID from carrier
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    productId: string;
+    /**
+     * List of selected services
+     * @type {Array<string>}
+     * @memberof CreateShippingRule201Response
+     */
+    services: Array<string>;
+    /**
+     * Carrier-specific extra parameters. DEPRECATED array form `[{ name, val }]` where `name` is the carrier parameter `key` (from the product's `additionalParameters[].key`, e.g. `returnFunctionality`) and `val` is the stringified value. This will change to a `{ key: value }` object in a future version — writes already accept either shape.
+     * @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersInner>}
+     * @memberof CreateShippingRule201Response
+     */
+    additionalParameters: Array<ListShippingRules200ResponseDataInnerAdditionalParametersInner>;
+    /**
+     * Sender address ID
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    addressId: string;
+    /**
+     * List of supported country codes
+     * @type {Array<string>}
+     * @memberof CreateShippingRule201Response
+     */
+    receivingCountries: Array<string>;
+    /**
+     * Send email notification to recipient
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    emailNotification: boolean;
+    /**
+     * Send SMS notification to recipient
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    phoneNotification: boolean;
+    /**
+     * Minimum required weight in kg. Orders below this are excluded from the rule.
+     * @type {number}
+     * @memberof CreateShippingRule201Response
+     */
+    minWeight: number | null;
+    /**
+     * Maximum allowed weight in kg. Orders exceeding this are excluded from the rule.
+     * @type {number}
+     * @memberof CreateShippingRule201Response
+     */
+    maxWeight: number | null;
+    /**
+     * Minimum required order value in currency units. Orders below this are excluded from the rule.
+     * @type {number}
+     * @memberof CreateShippingRule201Response
+     */
+    minOrderValue: number | null;
+    /**
+     * Maximum allowed order value in currency units. Orders exceeding this are excluded from the rule.
+     * @type {number}
+     * @memberof CreateShippingRule201Response
+     */
+    maxOrderValue: number | null;
+    /**
+     * Rule conditions (weight/price/quantity)
+     * @type {Array<ListShippingRules200ResponseDataInnerConditionsInner>}
+     * @memberof CreateShippingRule201Response
+     */
+    conditions: Array<ListShippingRules200ResponseDataInnerConditionsInner>;
+    /**
+     * Generate proforma invoice for shipments
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    generateProformaInvoice: boolean;
+    /**
+     * Generate commercial invoice for international shipments
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    generateCommercialInvoice: boolean;
+    /**
+     * Generate packing slip with package and item details
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    generatePackingList: boolean;
+    /**
+     * Automatically print labels when shipment is sent
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    autoPrintLabels: boolean;
+    /**
+     * Automatically print documents when shipment is sent
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    autoPrintDocuments: boolean;
+    /**
+     * ID of the label printer
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    labelPrinterId: string | null;
+    /**
+     * ID of the document printer
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    documentPrinterId: string | null;
+    /**
+     * ID of the return shipping rule
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    returnShippingRuleId: string | null;
+    /**
+     * Automatically create and send a return shipment on dispatch
+     * @type {boolean}
+     * @memberof CreateShippingRule201Response
+     */
+    autoCreateReturnShipment: boolean;
+    /**
+     * Owning organization ID
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    orgId: string;
+    /**
+     * Creation timestamp (ISO 8601)
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp (ISO 8601)
+     * @type {string}
+     * @memberof CreateShippingRule201Response
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const CreateShippingRule201ResponseDirectionEnum: {
+    readonly Outbound: "outbound";
+    readonly Inbound: "inbound";
+};
+export type CreateShippingRule201ResponseDirectionEnum = typeof CreateShippingRule201ResponseDirectionEnum[keyof typeof CreateShippingRule201ResponseDirectionEnum];
+/**
+ * Check if a given object implements the CreateShippingRule201Response interface.
+ */
+export declare function instanceOfCreateShippingRule201Response(value: object): value is CreateShippingRule201Response;
+export declare function CreateShippingRule201ResponseFromJSON(json: any): CreateShippingRule201Response;
+export declare function CreateShippingRule201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShippingRule201Response;
+export declare function CreateShippingRule201ResponseToJSON(json: any): CreateShippingRule201Response;
+export declare function CreateShippingRule201ResponseToJSONTyped(value?: CreateShippingRule201Response | null, ignoreDiscriminator?: boolean): any;