@zippendo/sdk 1.0.0

package/src/models/CreateShipmentRequestParcelsInnerOrderLinesInner.ts

@@ -0,0 +1,139 @@
+/* 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 CreateShipmentRequestParcelsInnerOrderLinesInner
+ */
+export interface CreateShipmentRequestParcelsInnerOrderLinesInner {
+    /**
+     * Unique order line identifier.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    id?: string;
+    /**
+     * Stock keeping unit of the product.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    sku: string;
+    /**
+     * Number of units in this order line.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    quantity: number;
+    /**
+     * Human-readable product description.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    description?: string | null;
+    /**
+     * Price per unit in the order line currency.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    unitPrice?: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    currency?: string | null;
+    /**
+     * VAT percentage applied to the unit price.
+     * @type {number}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    vatPercent?: number | null;
+    /**
+     * Warehouse picking location.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    location?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country of origin.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    countryOfOrigin?: string;
+    /**
+     * Customs tariff (HS) code.
+     * @type {string}
+     * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
+     */
+    tarrifNumber?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreateShipmentRequestParcelsInnerOrderLinesInner interface.
+ */
+export function instanceOfCreateShipmentRequestParcelsInnerOrderLinesInner(value: object): value is CreateShipmentRequestParcelsInnerOrderLinesInner {
+    if (!('sku' in value) || value['sku'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    return true;
+}
+
+export function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSON(json: any): CreateShipmentRequestParcelsInnerOrderLinesInner {
+    return CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestParcelsInnerOrderLinesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestParcelsInnerOrderLinesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'sku': json['sku'],
+        'quantity': json['quantity'],
+        'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
+        'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],
+        'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
+        'vatPercent': json['vatPercent'] === undefined ? undefined : json['vatPercent'] === null ? null : json['vatPercent'],
+        'location': json['location'] === undefined ? undefined : json['location'] === null ? null : json['location'],
+        'countryOfOrigin': json['countryOfOrigin'] == null ? undefined : json['countryOfOrigin'],
+        'tarrifNumber': json['tarrifNumber'] === undefined ? undefined : json['tarrifNumber'] === null ? null : json['tarrifNumber'],
+    };
+}
+
+export function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSON(json: any): CreateShipmentRequestParcelsInnerOrderLinesInner {
+    return CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestParcelsInnerOrderLinesInnerToJSONTyped(value?: CreateShipmentRequestParcelsInnerOrderLinesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'sku': value['sku'],
+        'quantity': value['quantity'],
+        'description': value['description'],
+        'unitPrice': value['unitPrice'],
+        'currency': value['currency'],
+        'vatPercent': value['vatPercent'],
+        'location': value['location'],
+        'countryOfOrigin': value['countryOfOrigin'],
+        'tarrifNumber': value['tarrifNumber'],
+    };
+}
+

package/src/models/CreateShipmentRequestPartiesInner.ts

@@ -0,0 +1,175 @@
+/* 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 { CreateShipmentRequestPartiesInnerAttributesInner } from './CreateShipmentRequestPartiesInnerAttributesInner';
+import {
+    CreateShipmentRequestPartiesInnerAttributesInnerFromJSON,
+    CreateShipmentRequestPartiesInnerAttributesInnerFromJSONTyped,
+    CreateShipmentRequestPartiesInnerAttributesInnerToJSON,
+    CreateShipmentRequestPartiesInnerAttributesInnerToJSONTyped,
+} from './CreateShipmentRequestPartiesInnerAttributesInner';
+
+/**
+ * 
+ * @export
+ * @interface CreateShipmentRequestPartiesInner
+ */
+export interface CreateShipmentRequestPartiesInner {
+    /**
+     * Role of the party in the shipment.
+     * @type {CreateShipmentRequestPartiesInnerTypeEnum}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    type: CreateShipmentRequestPartiesInnerTypeEnum;
+    /**
+     * Full name or company name of the party.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    name: string;
+    /**
+     * Attention contact at the party.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    attention?: string | null;
+    /**
+     * Primary street address line.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    address1: string;
+    /**
+     * Secondary address line.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    address2?: string | null;
+    /**
+     * Postal code of the party address.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    postalCode: string;
+    /**
+     * City of the party address.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    city: string;
+    /**
+     * ISO 3166-1 alpha-2 country code.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    countryCode: string;
+    /**
+     * Email address of the party.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    email?: string | null;
+    /**
+     * Phone number of the party in E.164 format.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    phone?: string | null;
+    /**
+     * Additional carrier-specific attributes for the party.
+     * @type {Array<CreateShipmentRequestPartiesInnerAttributesInner>}
+     * @memberof CreateShipmentRequestPartiesInner
+     */
+    attributes?: Array<CreateShipmentRequestPartiesInnerAttributesInner>;
+}
+
+
+/**
+ * @export
+ */
+export const CreateShipmentRequestPartiesInnerTypeEnum = {
+    Sender: 'sender',
+    Receiver: 'receiver',
+    Pickup: 'pickup',
+    Billing: 'billing',
+    FreightPayer: 'freight_payer',
+    ServicePoint: 'service_point',
+    Return: 'return'
+} as const;
+export type CreateShipmentRequestPartiesInnerTypeEnum = typeof CreateShipmentRequestPartiesInnerTypeEnum[keyof typeof CreateShipmentRequestPartiesInnerTypeEnum];
+
+
+/**
+ * Check if a given object implements the CreateShipmentRequestPartiesInner interface.
+ */
+export function instanceOfCreateShipmentRequestPartiesInner(value: object): value is CreateShipmentRequestPartiesInner {
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('address1' in value) || value['address1'] === undefined) return false;
+    if (!('postalCode' in value) || value['postalCode'] === undefined) return false;
+    if (!('city' in value) || value['city'] === undefined) return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
+    return true;
+}
+
+export function CreateShipmentRequestPartiesInnerFromJSON(json: any): CreateShipmentRequestPartiesInner {
+    return CreateShipmentRequestPartiesInnerFromJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestPartiesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestPartiesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'type': json['type'],
+        'name': json['name'],
+        'attention': json['attention'] === undefined ? undefined : json['attention'] === null ? null : json['attention'],
+        'address1': json['address1'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
+        'postalCode': json['postalCode'],
+        'city': json['city'],
+        'countryCode': json['countryCode'],
+        'email': json['email'] === undefined ? undefined : json['email'] === null ? null : json['email'],
+        'phone': json['phone'] === undefined ? undefined : json['phone'] === null ? null : json['phone'],
+        'attributes': json['attributes'] == null ? undefined : ((json['attributes'] as Array<any>).map(CreateShipmentRequestPartiesInnerAttributesInnerFromJSON)),
+    };
+}
+
+export function CreateShipmentRequestPartiesInnerToJSON(json: any): CreateShipmentRequestPartiesInner {
+    return CreateShipmentRequestPartiesInnerToJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestPartiesInnerToJSONTyped(value?: CreateShipmentRequestPartiesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'type': value['type'],
+        'name': value['name'],
+        'attention': value['attention'],
+        'address1': value['address1'],
+        'address2': value['address2'],
+        'postalCode': value['postalCode'],
+        'city': value['city'],
+        'countryCode': value['countryCode'],
+        'email': value['email'],
+        'phone': value['phone'],
+        'attributes': value['attributes'] == null ? undefined : ((value['attributes'] as Array<any>).map(CreateShipmentRequestPartiesInnerAttributesInnerToJSON)),
+    };
+}
+

package/src/models/CreateShipmentRequestPartiesInnerAttributesInner.ts

@@ -0,0 +1,75 @@
+/* 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 CreateShipmentRequestPartiesInnerAttributesInner
+ */
+export interface CreateShipmentRequestPartiesInnerAttributesInner {
+    /**
+     * Name of the party attribute.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInnerAttributesInner
+     */
+    name: string;
+    /**
+     * Value of the party attribute.
+     * @type {string}
+     * @memberof CreateShipmentRequestPartiesInnerAttributesInner
+     */
+    value: string;
+}
+
+/**
+ * Check if a given object implements the CreateShipmentRequestPartiesInnerAttributesInner interface.
+ */
+export function instanceOfCreateShipmentRequestPartiesInnerAttributesInner(value: object): value is CreateShipmentRequestPartiesInnerAttributesInner {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function CreateShipmentRequestPartiesInnerAttributesInnerFromJSON(json: any): CreateShipmentRequestPartiesInnerAttributesInner {
+    return CreateShipmentRequestPartiesInnerAttributesInnerFromJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestPartiesInnerAttributesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestPartiesInnerAttributesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'value': json['value'],
+    };
+}
+
+export function CreateShipmentRequestPartiesInnerAttributesInnerToJSON(json: any): CreateShipmentRequestPartiesInnerAttributesInner {
+    return CreateShipmentRequestPartiesInnerAttributesInnerToJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestPartiesInnerAttributesInnerToJSONTyped(value?: CreateShipmentRequestPartiesInnerAttributesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'value': value['value'],
+    };
+}
+

package/src/models/CreateShipmentRequestPickupDetails.ts

@@ -0,0 +1,92 @@
+/* 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 CreateShipmentRequestPickupDetails
+ */
+export interface CreateShipmentRequestPickupDetails {
+    /**
+     * Requested pickup date (YYYY-MM-DD).
+     * @type {string}
+     * @memberof CreateShipmentRequestPickupDetails
+     */
+    date: string;
+    /**
+     * Requested earliest pickup time (HH:MM:SS).
+     * @type {string}
+     * @memberof CreateShipmentRequestPickupDetails
+     */
+    from: string;
+    /**
+     * Requested latest pickup time (HH:MM:SS).
+     * @type {string}
+     * @memberof CreateShipmentRequestPickupDetails
+     */
+    to: string;
+    /**
+     * Pickup instruction to the carrier.
+     * @type {string}
+     * @memberof CreateShipmentRequestPickupDetails
+     */
+    instruction?: string;
+}
+
+/**
+ * Check if a given object implements the CreateShipmentRequestPickupDetails interface.
+ */
+export function instanceOfCreateShipmentRequestPickupDetails(value: object): value is CreateShipmentRequestPickupDetails {
+    if (!('date' in value) || value['date'] === undefined) return false;
+    if (!('from' in value) || value['from'] === undefined) return false;
+    if (!('to' in value) || value['to'] === undefined) return false;
+    return true;
+}
+
+export function CreateShipmentRequestPickupDetailsFromJSON(json: any): CreateShipmentRequestPickupDetails {
+    return CreateShipmentRequestPickupDetailsFromJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestPickupDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestPickupDetails {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'date': json['date'],
+        'from': json['from'],
+        'to': json['to'],
+        'instruction': json['instruction'] == null ? undefined : json['instruction'],
+    };
+}
+
+export function CreateShipmentRequestPickupDetailsToJSON(json: any): CreateShipmentRequestPickupDetails {
+    return CreateShipmentRequestPickupDetailsToJSONTyped(json, false);
+}
+
+export function CreateShipmentRequestPickupDetailsToJSONTyped(value?: CreateShipmentRequestPickupDetails | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'date': value['date'],
+        'from': value['from'],
+        'to': value['to'],
+        'instruction': value['instruction'],
+    };
+}
+

package/src/models/CreateShippingQuote200Response.ts

@@ -0,0 +1,74 @@
+/* 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 { CreateShippingQuote200ResponseRatesInner } from './CreateShippingQuote200ResponseRatesInner';
+import {
+    CreateShippingQuote200ResponseRatesInnerFromJSON,
+    CreateShippingQuote200ResponseRatesInnerFromJSONTyped,
+    CreateShippingQuote200ResponseRatesInnerToJSON,
+    CreateShippingQuote200ResponseRatesInnerToJSONTyped,
+} from './CreateShippingQuote200ResponseRatesInner';
+
+/**
+ * 
+ * @export
+ * @interface CreateShippingQuote200Response
+ */
+export interface CreateShippingQuote200Response {
+    /**
+     * Available shipping rates
+     * @type {Array<CreateShippingQuote200ResponseRatesInner>}
+     * @memberof CreateShippingQuote200Response
+     */
+    rates: Array<CreateShippingQuote200ResponseRatesInner>;
+}
+
+/**
+ * Check if a given object implements the CreateShippingQuote200Response interface.
+ */
+export function instanceOfCreateShippingQuote200Response(value: object): value is CreateShippingQuote200Response {
+    if (!('rates' in value) || value['rates'] === undefined) return false;
+    return true;
+}
+
+export function CreateShippingQuote200ResponseFromJSON(json: any): CreateShippingQuote200Response {
+    return CreateShippingQuote200ResponseFromJSONTyped(json, false);
+}
+
+export function CreateShippingQuote200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShippingQuote200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rates': ((json['rates'] as Array<any>).map(CreateShippingQuote200ResponseRatesInnerFromJSON)),
+    };
+}
+
+export function CreateShippingQuote200ResponseToJSON(json: any): CreateShippingQuote200Response {
+    return CreateShippingQuote200ResponseToJSONTyped(json, false);
+}
+
+export function CreateShippingQuote200ResponseToJSONTyped(value?: CreateShippingQuote200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'rates': ((value['rates'] as Array<any>).map(CreateShippingQuote200ResponseRatesInnerToJSON)),
+    };
+}
+