@zippendo/sdk 1.0.0

package/dist/esm/models/CreateShippingQuoteRequestDestination.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CreateShippingQuoteRequestDestination interface.
+ */
+export function instanceOfCreateShippingQuoteRequestDestination(value) {
+    if (!('country' in value) || value['country'] === undefined)
+        return false;
+    return true;
+}
+export function CreateShippingQuoteRequestDestinationFromJSON(json) {
+    return CreateShippingQuoteRequestDestinationFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function CreateShippingQuoteRequestDestinationToJSON(json) {
+    return CreateShippingQuoteRequestDestinationToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/CreateShippingQuoteRequestItemsInner.js

@@ -0,0 +1,61 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CreateShippingQuoteRequestItemsInner interface.
+ */
+export 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;
+}
+export function CreateShippingQuoteRequestItemsInnerFromJSON(json) {
+    return CreateShippingQuoteRequestItemsInnerFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function CreateShippingQuoteRequestItemsInnerToJSON(json) {
+    return CreateShippingQuoteRequestItemsInnerToJSONTyped(json, false);
+}
+export 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/esm/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;

package/dist/esm/models/CreateShippingRule201Response.js

@@ -0,0 +1,164 @@
+/* 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.
+ */
+import { ListShippingRules200ResponseDataInnerConditionsInnerFromJSON, ListShippingRules200ResponseDataInnerConditionsInnerToJSON, } from './ListShippingRules200ResponseDataInnerConditionsInner';
+import { ListShippingRules200ResponseDataInnerAdditionalParametersInnerFromJSON, ListShippingRules200ResponseDataInnerAdditionalParametersInnerToJSON, } from './ListShippingRules200ResponseDataInnerAdditionalParametersInner';
+/**
+ * @export
+ */
+export const CreateShippingRule201ResponseDirectionEnum = {
+    Outbound: 'outbound',
+    Inbound: 'inbound'
+};
+/**
+ * Check if a given object implements the CreateShippingRule201Response interface.
+ */
+export function instanceOfCreateShippingRule201Response(value) {
+    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 (!('direction' in value) || value['direction'] === 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 (!('additionalParameters' in value) || value['additionalParameters'] === undefined)
+        return false;
+    if (!('addressId' in value) || value['addressId'] === undefined)
+        return false;
+    if (!('receivingCountries' in value) || value['receivingCountries'] === undefined)
+        return false;
+    if (!('emailNotification' in value) || value['emailNotification'] === undefined)
+        return false;
+    if (!('phoneNotification' in value) || value['phoneNotification'] === undefined)
+        return false;
+    if (!('minWeight' in value) || value['minWeight'] === undefined)
+        return false;
+    if (!('maxWeight' in value) || value['maxWeight'] === undefined)
+        return false;
+    if (!('minOrderValue' in value) || value['minOrderValue'] === undefined)
+        return false;
+    if (!('maxOrderValue' in value) || value['maxOrderValue'] === undefined)
+        return false;
+    if (!('conditions' in value) || value['conditions'] === undefined)
+        return false;
+    if (!('generateProformaInvoice' in value) || value['generateProformaInvoice'] === undefined)
+        return false;
+    if (!('generateCommercialInvoice' in value) || value['generateCommercialInvoice'] === undefined)
+        return false;
+    if (!('generatePackingList' in value) || value['generatePackingList'] === undefined)
+        return false;
+    if (!('autoPrintLabels' in value) || value['autoPrintLabels'] === undefined)
+        return false;
+    if (!('autoPrintDocuments' in value) || value['autoPrintDocuments'] === undefined)
+        return false;
+    if (!('labelPrinterId' in value) || value['labelPrinterId'] === undefined)
+        return false;
+    if (!('documentPrinterId' in value) || value['documentPrinterId'] === undefined)
+        return false;
+    if (!('returnShippingRuleId' in value) || value['returnShippingRuleId'] === undefined)
+        return false;
+    if (!('autoCreateReturnShipment' in value) || value['autoCreateReturnShipment'] === undefined)
+        return false;
+    if (!('orgId' in value) || value['orgId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function CreateShippingRule201ResponseFromJSON(json) {
+    return CreateShippingRule201ResponseFromJSONTyped(json, false);
+}
+export function CreateShippingRule201ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'direction': json['direction'],
+        'carrierId': json['carrierId'],
+        'productId': json['productId'],
+        'services': json['services'],
+        'additionalParameters': (json['additionalParameters'].map(ListShippingRules200ResponseDataInnerAdditionalParametersInnerFromJSON)),
+        'addressId': json['addressId'],
+        'receivingCountries': json['receivingCountries'],
+        'emailNotification': json['emailNotification'],
+        'phoneNotification': json['phoneNotification'],
+        'minWeight': json['minWeight'],
+        'maxWeight': json['maxWeight'],
+        'minOrderValue': json['minOrderValue'],
+        'maxOrderValue': json['maxOrderValue'],
+        'conditions': (json['conditions'].map(ListShippingRules200ResponseDataInnerConditionsInnerFromJSON)),
+        'generateProformaInvoice': json['generateProformaInvoice'],
+        'generateCommercialInvoice': json['generateCommercialInvoice'],
+        'generatePackingList': json['generatePackingList'],
+        'autoPrintLabels': json['autoPrintLabels'],
+        'autoPrintDocuments': json['autoPrintDocuments'],
+        'labelPrinterId': json['labelPrinterId'],
+        'documentPrinterId': json['documentPrinterId'],
+        'returnShippingRuleId': json['returnShippingRuleId'],
+        'autoCreateReturnShipment': json['autoCreateReturnShipment'],
+        'orgId': json['orgId'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+export function CreateShippingRule201ResponseToJSON(json) {
+    return CreateShippingRule201ResponseToJSONTyped(json, false);
+}
+export function CreateShippingRule201ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'direction': value['direction'],
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'additionalParameters': (value['additionalParameters'].map(ListShippingRules200ResponseDataInnerAdditionalParametersInnerToJSON)),
+        'addressId': value['addressId'],
+        'receivingCountries': value['receivingCountries'],
+        'emailNotification': value['emailNotification'],
+        'phoneNotification': value['phoneNotification'],
+        'minWeight': value['minWeight'],
+        'maxWeight': value['maxWeight'],
+        'minOrderValue': value['minOrderValue'],
+        'maxOrderValue': value['maxOrderValue'],
+        'conditions': (value['conditions'].map(ListShippingRules200ResponseDataInnerConditionsInnerToJSON)),
+        'generateProformaInvoice': value['generateProformaInvoice'],
+        'generateCommercialInvoice': value['generateCommercialInvoice'],
+        'generatePackingList': value['generatePackingList'],
+        'autoPrintLabels': value['autoPrintLabels'],
+        'autoPrintDocuments': value['autoPrintDocuments'],
+        'labelPrinterId': value['labelPrinterId'],
+        'documentPrinterId': value['documentPrinterId'],
+        'returnShippingRuleId': value['returnShippingRuleId'],
+        'autoCreateReturnShipment': value['autoCreateReturnShipment'],
+        'orgId': value['orgId'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}