@zippendo/sdk 1.0.0

package/src/models/CreateOrder201Response.ts

@@ -0,0 +1,239 @@
+/* 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 { mapValues } from '../runtime';
+import type { CreateOrder201ResponseShippingAddress } from './CreateOrder201ResponseShippingAddress';
+import {
+    CreateOrder201ResponseShippingAddressFromJSON,
+    CreateOrder201ResponseShippingAddressFromJSONTyped,
+    CreateOrder201ResponseShippingAddressToJSON,
+    CreateOrder201ResponseShippingAddressToJSONTyped,
+} from './CreateOrder201ResponseShippingAddress';
+import type { CreateOrder201ResponseOrderLinesInner } from './CreateOrder201ResponseOrderLinesInner';
+import {
+    CreateOrder201ResponseOrderLinesInnerFromJSON,
+    CreateOrder201ResponseOrderLinesInnerFromJSONTyped,
+    CreateOrder201ResponseOrderLinesInnerToJSON,
+    CreateOrder201ResponseOrderLinesInnerToJSONTyped,
+} from './CreateOrder201ResponseOrderLinesInner';
+
+/**
+ * 
+ * @export
+ * @interface CreateOrder201Response
+ */
+export interface CreateOrder201Response {
+    /**
+     * Unique order ID.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    id: string;
+    /**
+     * Human-readable order number.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    orderNumber: string;
+    /**
+     * Identifier of the order in the source platform.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    externalId?: string | null;
+    /**
+     * Customer full name.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    customerName?: string | null;
+    /**
+     * Customer email address.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    customerEmail?: string | null;
+    /**
+     * 
+     * @type {CreateOrder201ResponseShippingAddress}
+     * @memberof CreateOrder201Response
+     */
+    shippingAddress?: CreateOrder201ResponseShippingAddress | null;
+    /**
+     * Line items in the order.
+     * @type {Array<CreateOrder201ResponseOrderLinesInner>}
+     * @memberof CreateOrder201Response
+     */
+    orderLines: Array<CreateOrder201ResponseOrderLinesInner>;
+    /**
+     * Order subtotal before shipping and tax.
+     * @type {number}
+     * @memberof CreateOrder201Response
+     */
+    subtotalAmount?: number | null;
+    /**
+     * Order grand total.
+     * @type {number}
+     * @memberof CreateOrder201Response
+     */
+    totalAmount?: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    currency?: string | null;
+    /**
+     * Order fulfilment status derived from its shipments.
+     * @type {CreateOrder201ResponseStatusEnum}
+     * @memberof CreateOrder201Response
+     */
+    status: CreateOrder201ResponseStatusEnum;
+    /**
+     * ID of the applied shipping rule.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    shippingRuleId?: string | null;
+    /**
+     * Free-form internal notes.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    notes?: string | null;
+    /**
+     * Raw platform-specific payload for reference.
+     * @type {{ [key: string]: any; }}
+     * @memberof CreateOrder201Response
+     */
+    externalData?: { [key: string]: any; } | null;
+    /**
+     * ID of the order channel this order belongs to.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    orderChannelId: string;
+    /**
+     * Owning organization ID.
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    orgId: string;
+    /**
+     * Creation timestamp (ISO 8601).
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp (ISO 8601).
+     * @type {string}
+     * @memberof CreateOrder201Response
+     */
+    updatedAt: string;
+}
+
+
+/**
+ * @export
+ */
+export const CreateOrder201ResponseStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    PartiallyFulfilled: 'partially_fulfilled',
+    Fulfilled: 'fulfilled',
+    Error: 'error',
+    Cancelled: 'cancelled'
+} as const;
+export type CreateOrder201ResponseStatusEnum = typeof CreateOrder201ResponseStatusEnum[keyof typeof CreateOrder201ResponseStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreateOrder201Response interface.
+ */
+export function instanceOfCreateOrder201Response(value: object): value is CreateOrder201Response {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('orderNumber' in value) || value['orderNumber'] === undefined) return false;
+    if (!('orderLines' in value) || value['orderLines'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('orderChannelId' in value) || value['orderChannelId'] === 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 CreateOrder201ResponseFromJSON(json: any): CreateOrder201Response {
+    return CreateOrder201ResponseFromJSONTyped(json, false);
+}
+
+export function CreateOrder201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrder201Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'orderNumber': json['orderNumber'],
+        'externalId': json['externalId'] === undefined ? undefined : json['externalId'] === null ? null : json['externalId'],
+        'customerName': json['customerName'] === undefined ? undefined : json['customerName'] === null ? null : json['customerName'],
+        'customerEmail': json['customerEmail'] === undefined ? undefined : json['customerEmail'] === null ? null : json['customerEmail'],
+        'shippingAddress': json['shippingAddress'] === undefined ? undefined : json['shippingAddress'] === null ? null : CreateOrder201ResponseShippingAddressFromJSON(json['shippingAddress']),
+        'orderLines': ((json['orderLines'] as Array<any>).map(CreateOrder201ResponseOrderLinesInnerFromJSON)),
+        'subtotalAmount': json['subtotalAmount'] === undefined ? undefined : json['subtotalAmount'] === null ? null : json['subtotalAmount'],
+        'totalAmount': json['totalAmount'] === undefined ? undefined : json['totalAmount'] === null ? null : json['totalAmount'],
+        'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
+        'status': json['status'],
+        'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
+        'notes': json['notes'] === undefined ? undefined : json['notes'] === null ? null : json['notes'],
+        'externalData': json['externalData'] === undefined ? undefined : json['externalData'] === null ? null : json['externalData'],
+        'orderChannelId': json['orderChannelId'],
+        'orgId': json['orgId'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+
+export function CreateOrder201ResponseToJSON(json: any): CreateOrder201Response {
+    return CreateOrder201ResponseToJSONTyped(json, false);
+}
+
+export function CreateOrder201ResponseToJSONTyped(value?: CreateOrder201Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'orderNumber': value['orderNumber'],
+        'externalId': value['externalId'],
+        'customerName': value['customerName'],
+        'customerEmail': value['customerEmail'],
+        'shippingAddress': CreateOrder201ResponseShippingAddressToJSON(value['shippingAddress']),
+        'orderLines': ((value['orderLines'] as Array<any>).map(CreateOrder201ResponseOrderLinesInnerToJSON)),
+        'subtotalAmount': value['subtotalAmount'],
+        'totalAmount': value['totalAmount'],
+        'currency': value['currency'],
+        'status': value['status'],
+        'shippingRuleId': value['shippingRuleId'],
+        'notes': value['notes'],
+        'externalData': value['externalData'],
+        'orderChannelId': value['orderChannelId'],
+        'orgId': value['orgId'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}
+

package/src/models/CreateOrder201ResponseOrderLinesInner.ts

@@ -0,0 +1,224 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateOrder201ResponseOrderLinesInner
+ */
+export interface CreateOrder201ResponseOrderLinesInner {
+    /**
+     * Stock keeping unit identifier.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    sku?: string | null;
+    /**
+     * Product name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    name: string;
+    /**
+     * Quantity ordered.
+     * @type {number}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    quantity: number;
+    /**
+     * Price per unit.
+     * @type {number}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    unitPrice?: number | null;
+    /**
+     * Total price for the line.
+     * @type {number}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    totalPrice?: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    currency?: string | null;
+    /**
+     * Item weight in the given unit.
+     * @type {number}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    weight?: number | null;
+    /**
+     * Unit of the weight value.
+     * @type {CreateOrder201ResponseOrderLinesInnerWeightUnitEnum}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    weightUnit?: CreateOrder201ResponseOrderLinesInnerWeightUnitEnum | null;
+    /**
+     * Platform variant identifier.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    variantId?: string | null;
+    /**
+     * Platform product identifier.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    productId?: string | null;
+    /**
+     * Product image URL.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    imageUrl?: string | null;
+    /**
+     * Harmonized System customs code (6-13 digits).
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    hsCode?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country of origin.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    countryOfOrigin?: string | null;
+    /**
+     * ISO 3166-2 province of origin.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    provinceOfOrigin?: string | null;
+    /**
+     * Item barcode (EAN/UPC).
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    barcode?: string | null;
+    /**
+     * Whether the item requires shipping.
+     * @type {boolean}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    requiresShipping?: boolean | null;
+    /**
+     * Whether the item is taxable.
+     * @type {boolean}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    taxable?: boolean | null;
+    /**
+     * Whether the item is a gift card.
+     * @type {boolean}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    giftCard?: boolean | null;
+    /**
+     * Vendor or brand name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseOrderLinesInner
+     */
+    vendor?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const CreateOrder201ResponseOrderLinesInnerWeightUnitEnum = {
+    Kg: 'kg',
+    G: 'g',
+    Lb: 'lb',
+    Oz: 'oz'
+} as const;
+export type CreateOrder201ResponseOrderLinesInnerWeightUnitEnum = typeof CreateOrder201ResponseOrderLinesInnerWeightUnitEnum[keyof typeof CreateOrder201ResponseOrderLinesInnerWeightUnitEnum];
+
+
+/**
+ * Check if a given object implements the CreateOrder201ResponseOrderLinesInner interface.
+ */
+export function instanceOfCreateOrder201ResponseOrderLinesInner(value: object): value is CreateOrder201ResponseOrderLinesInner {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    return true;
+}
+
+export function CreateOrder201ResponseOrderLinesInnerFromJSON(json: any): CreateOrder201ResponseOrderLinesInner {
+    return CreateOrder201ResponseOrderLinesInnerFromJSONTyped(json, false);
+}
+
+export function CreateOrder201ResponseOrderLinesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrder201ResponseOrderLinesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
+        'name': json['name'],
+        'quantity': json['quantity'],
+        'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
+        'totalPrice': json['totalPrice'] === undefined ? undefined : json['totalPrice'] === null ? null : json['totalPrice'],
+        'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
+        'weight': json['weight'] === undefined ? undefined : json['weight'] === null ? null : json['weight'],
+        'weightUnit': json['weightUnit'] === undefined ? undefined : json['weightUnit'] === null ? null : json['weightUnit'],
+        'variantId': json['variantId'] === undefined ? undefined : json['variantId'] === null ? null : json['variantId'],
+        'productId': json['productId'] === undefined ? undefined : json['productId'] === null ? null : json['productId'],
+        'imageUrl': json['imageUrl'] === undefined ? undefined : json['imageUrl'] === null ? null : json['imageUrl'],
+        'hsCode': json['hsCode'] === undefined ? undefined : json['hsCode'] === null ? null : json['hsCode'],
+        'countryOfOrigin': json['countryOfOrigin'] === undefined ? undefined : json['countryOfOrigin'] === null ? null : json['countryOfOrigin'],
+        'provinceOfOrigin': json['provinceOfOrigin'] === undefined ? undefined : json['provinceOfOrigin'] === null ? null : json['provinceOfOrigin'],
+        'barcode': json['barcode'] === undefined ? undefined : json['barcode'] === null ? null : json['barcode'],
+        'requiresShipping': json['requiresShipping'] === undefined ? undefined : json['requiresShipping'] === null ? null : json['requiresShipping'],
+        'taxable': json['taxable'] === undefined ? undefined : json['taxable'] === null ? null : json['taxable'],
+        'giftCard': json['giftCard'] === undefined ? undefined : json['giftCard'] === null ? null : json['giftCard'],
+        'vendor': json['vendor'] === undefined ? undefined : json['vendor'] === null ? null : json['vendor'],
+    };
+}
+
+export function CreateOrder201ResponseOrderLinesInnerToJSON(json: any): CreateOrder201ResponseOrderLinesInner {
+    return CreateOrder201ResponseOrderLinesInnerToJSONTyped(json, false);
+}
+
+export function CreateOrder201ResponseOrderLinesInnerToJSONTyped(value?: CreateOrder201ResponseOrderLinesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sku': value['sku'],
+        'name': value['name'],
+        'quantity': value['quantity'],
+        'unitPrice': value['unitPrice'],
+        'totalPrice': value['totalPrice'],
+        'currency': value['currency'],
+        'weight': value['weight'],
+        'weightUnit': value['weightUnit'],
+        'variantId': value['variantId'],
+        'productId': value['productId'],
+        'imageUrl': value['imageUrl'],
+        'hsCode': value['hsCode'],
+        'countryOfOrigin': value['countryOfOrigin'],
+        'provinceOfOrigin': value['provinceOfOrigin'],
+        'barcode': value['barcode'],
+        'requiresShipping': value['requiresShipping'],
+        'taxable': value['taxable'],
+        'giftCard': value['giftCard'],
+        'vendor': value['vendor'],
+    };
+}
+

package/src/models/CreateOrder201ResponseShippingAddress.ts

@@ -0,0 +1,166 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Destination shipping address.
+ * @export
+ * @interface CreateOrder201ResponseShippingAddress
+ */
+export interface CreateOrder201ResponseShippingAddress {
+    /**
+     * Recipient full name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    name: string;
+    /**
+     * Attention / care-of line.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    attention?: string | null;
+    /**
+     * Company name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    company?: string | null;
+    /**
+     * Street address line 1.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    address1: string;
+    /**
+     * Street address line 2.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    address2?: string | null;
+    /**
+     * City name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    city: string;
+    /**
+     * Province or region name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    province?: string | null;
+    /**
+     * Province or region code.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    provinceCode?: string | null;
+    /**
+     * Postal code.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    postalCode: string;
+    /**
+     * Country name.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    country?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country code.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    countryCode: string;
+    /**
+     * Recipient phone number.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    phone?: string | null;
+    /**
+     * Recipient email address.
+     * @type {string}
+     * @memberof CreateOrder201ResponseShippingAddress
+     */
+    email?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreateOrder201ResponseShippingAddress interface.
+ */
+export function instanceOfCreateOrder201ResponseShippingAddress(value: object): value is CreateOrder201ResponseShippingAddress {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('address1' in value) || value['address1'] === undefined) return false;
+    if (!('city' in value) || value['city'] === undefined) return false;
+    if (!('postalCode' in value) || value['postalCode'] === undefined) return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
+    return true;
+}
+
+export function CreateOrder201ResponseShippingAddressFromJSON(json: any): CreateOrder201ResponseShippingAddress {
+    return CreateOrder201ResponseShippingAddressFromJSONTyped(json, false);
+}
+
+export function CreateOrder201ResponseShippingAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrder201ResponseShippingAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'attention': json['attention'] === undefined ? undefined : json['attention'] === null ? null : json['attention'],
+        'company': json['company'] === undefined ? undefined : json['company'] === null ? null : json['company'],
+        'address1': json['address1'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
+        'city': json['city'],
+        'province': json['province'] === undefined ? undefined : json['province'] === null ? null : json['province'],
+        'provinceCode': json['provinceCode'] === undefined ? undefined : json['provinceCode'] === null ? null : json['provinceCode'],
+        'postalCode': json['postalCode'],
+        'country': json['country'] === undefined ? undefined : json['country'] === null ? null : json['country'],
+        'countryCode': json['countryCode'],
+        'phone': json['phone'] === undefined ? undefined : json['phone'] === null ? null : json['phone'],
+        'email': json['email'] === undefined ? undefined : json['email'] === null ? null : json['email'],
+    };
+}
+
+export function CreateOrder201ResponseShippingAddressToJSON(json: any): CreateOrder201ResponseShippingAddress {
+    return CreateOrder201ResponseShippingAddressToJSONTyped(json, false);
+}
+
+export function CreateOrder201ResponseShippingAddressToJSONTyped(value?: CreateOrder201ResponseShippingAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'attention': value['attention'],
+        'company': value['company'],
+        'address1': value['address1'],
+        'address2': value['address2'],
+        'city': value['city'],
+        'province': value['province'],
+        'provinceCode': value['provinceCode'],
+        'postalCode': value['postalCode'],
+        'country': value['country'],
+        'countryCode': value['countryCode'],
+        'phone': value['phone'],
+        'email': value['email'],
+    };
+}
+