@zippendo/sdk 1.0.0

package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { BatchSplitShipmentRequestShipmentsInnerOrderLinesInner } from './BatchSplitShipmentRequestShipmentsInnerOrderLinesInner';
+/**
+ *
+ * @export
+ * @interface SplitShipmentParcelRequestParcelsInner
+ */
+export interface SplitShipmentParcelRequestParcelsInner {
+    /**
+     * Existing parcel ID to update. Omit to create a new parcel.
+     * @type {string}
+     * @memberof SplitShipmentParcelRequestParcelsInner
+     */
+    id?: string;
+    /**
+     * Order lines and quantities to place in this parcel.
+     * @type {Array<BatchSplitShipmentRequestShipmentsInnerOrderLinesInner>}
+     * @memberof SplitShipmentParcelRequestParcelsInner
+     */
+    orderLines: Array<BatchSplitShipmentRequestShipmentsInnerOrderLinesInner>;
+}
+/**
+ * Check if a given object implements the SplitShipmentParcelRequestParcelsInner interface.
+ */
+export declare function instanceOfSplitShipmentParcelRequestParcelsInner(value: object): value is SplitShipmentParcelRequestParcelsInner;
+export declare function SplitShipmentParcelRequestParcelsInnerFromJSON(json: any): SplitShipmentParcelRequestParcelsInner;
+export declare function SplitShipmentParcelRequestParcelsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SplitShipmentParcelRequestParcelsInner;
+export declare function SplitShipmentParcelRequestParcelsInnerToJSON(json: any): SplitShipmentParcelRequestParcelsInner;
+export declare function SplitShipmentParcelRequestParcelsInnerToJSONTyped(value?: SplitShipmentParcelRequestParcelsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.js

@@ -0,0 +1,46 @@
+/* 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 { BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSON, BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSON, } from './BatchSplitShipmentRequestShipmentsInnerOrderLinesInner';
+/**
+ * Check if a given object implements the SplitShipmentParcelRequestParcelsInner interface.
+ */
+export function instanceOfSplitShipmentParcelRequestParcelsInner(value) {
+    if (!('orderLines' in value) || value['orderLines'] === undefined)
+        return false;
+    return true;
+}
+export function SplitShipmentParcelRequestParcelsInnerFromJSON(json) {
+    return SplitShipmentParcelRequestParcelsInnerFromJSONTyped(json, false);
+}
+export function SplitShipmentParcelRequestParcelsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'orderLines': (json['orderLines'].map(BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSON)),
+    };
+}
+export function SplitShipmentParcelRequestParcelsInnerToJSON(json) {
+    return SplitShipmentParcelRequestParcelsInnerToJSONTyped(json, false);
+}
+export function SplitShipmentParcelRequestParcelsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'orderLines': (value['orderLines'].map(BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSON)),
+    };
+}

package/dist/esm/models/SplitShipmentRequest.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 SplitShipmentRequest
+ */
+export interface SplitShipmentRequest {
+    /**
+     * Parcel whose order lines are split into a new shipment.
+     * @type {string}
+     * @memberof SplitShipmentRequest
+     */
+    parcelId: string;
+    /**
+     * Order line IDs to move. If omitted, all order lines in the parcel are moved.
+     * @type {Array<string>}
+     * @memberof SplitShipmentRequest
+     */
+    orderLineIds?: Array<string>;
+    /**
+     * Carrier for the new shipment. Copied from the original if omitted.
+     * @type {string}
+     * @memberof SplitShipmentRequest
+     */
+    carrierId?: string;
+    /**
+     * Carrier product for the new shipment. Copied from the original if omitted.
+     * @type {string}
+     * @memberof SplitShipmentRequest
+     */
+    productId?: string;
+    /**
+     * Service codes for the new shipment. Copied from the original if omitted.
+     * @type {Array<string>}
+     * @memberof SplitShipmentRequest
+     */
+    services?: Array<string>;
+    /**
+     * Carrier-specific parameters for the new shipment.
+     * @type {{ [key: string]: any; }}
+     * @memberof SplitShipmentRequest
+     */
+    additionalParameters?: {
+        [key: string]: any;
+    };
+    /**
+     * Reference for the new shipment. Defaults to the original reference with a suffix.
+     * @type {string}
+     * @memberof SplitShipmentRequest
+     */
+    reference?: string;
+}
+/**
+ * Check if a given object implements the SplitShipmentRequest interface.
+ */
+export declare function instanceOfSplitShipmentRequest(value: object): value is SplitShipmentRequest;
+export declare function SplitShipmentRequestFromJSON(json: any): SplitShipmentRequest;
+export declare function SplitShipmentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SplitShipmentRequest;
+export declare function SplitShipmentRequestToJSON(json: any): SplitShipmentRequest;
+export declare function SplitShipmentRequestToJSONTyped(value?: SplitShipmentRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SplitShipmentRequest.js

@@ -0,0 +1,55 @@
+/* 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 SplitShipmentRequest interface.
+ */
+export function instanceOfSplitShipmentRequest(value) {
+    if (!('parcelId' in value) || value['parcelId'] === undefined)
+        return false;
+    return true;
+}
+export function SplitShipmentRequestFromJSON(json) {
+    return SplitShipmentRequestFromJSONTyped(json, false);
+}
+export function SplitShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'parcelId': json['parcelId'],
+        'orderLineIds': json['orderLineIds'] == null ? undefined : json['orderLineIds'],
+        'carrierId': json['carrierId'] == null ? undefined : json['carrierId'],
+        'productId': json['productId'] == null ? undefined : json['productId'],
+        'services': json['services'] == null ? undefined : json['services'],
+        'additionalParameters': json['additionalParameters'] == null ? undefined : json['additionalParameters'],
+        'reference': json['reference'] == null ? undefined : json['reference'],
+    };
+}
+export function SplitShipmentRequestToJSON(json) {
+    return SplitShipmentRequestToJSONTyped(json, false);
+}
+export function SplitShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'parcelId': value['parcelId'],
+        'orderLineIds': value['orderLineIds'],
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'additionalParameters': value['additionalParameters'],
+        'reference': value['reference'],
+    };
+}

package/dist/esm/models/TestOrgWebhook200Response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 TestOrgWebhook200Response
+ */
+export interface TestOrgWebhook200Response {
+    /**
+     * Result message
+     * @type {string}
+     * @memberof TestOrgWebhook200Response
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the TestOrgWebhook200Response interface.
+ */
+export declare function instanceOfTestOrgWebhook200Response(value: object): value is TestOrgWebhook200Response;
+export declare function TestOrgWebhook200ResponseFromJSON(json: any): TestOrgWebhook200Response;
+export declare function TestOrgWebhook200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestOrgWebhook200Response;
+export declare function TestOrgWebhook200ResponseToJSON(json: any): TestOrgWebhook200Response;
+export declare function TestOrgWebhook200ResponseToJSONTyped(value?: TestOrgWebhook200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TestOrgWebhook200Response.js

@@ -0,0 +1,43 @@
+/* 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 TestOrgWebhook200Response interface.
+ */
+export function instanceOfTestOrgWebhook200Response(value) {
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function TestOrgWebhook200ResponseFromJSON(json) {
+    return TestOrgWebhook200ResponseFromJSONTyped(json, false);
+}
+export function TestOrgWebhook200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+    };
+}
+export function TestOrgWebhook200ResponseToJSON(json) {
+    return TestOrgWebhook200ResponseToJSONTyped(json, false);
+}
+export function TestOrgWebhook200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'message': value['message'],
+    };
+}

package/dist/esm/models/TrackShipment200Response.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 { TrackShipment200ResponseEventsInner } from './TrackShipment200ResponseEventsInner';
+/**
+ *
+ * @export
+ * @interface TrackShipment200Response
+ */
+export interface TrackShipment200Response {
+    /**
+     * Carrier tracking number.
+     * @type {string}
+     * @memberof TrackShipment200Response
+     */
+    trackingNumber: string | null;
+    /**
+     * Public carrier tracking URL.
+     * @type {string}
+     * @memberof TrackShipment200Response
+     */
+    trackingUrl: string | null;
+    /**
+     * Latest normalized tracking status.
+     * @type {TrackShipment200ResponseCurrentStatusEnum}
+     * @memberof TrackShipment200Response
+     */
+    currentStatus: TrackShipment200ResponseCurrentStatusEnum | null;
+    /**
+     * Estimated delivery timestamp.
+     * @type {string}
+     * @memberof TrackShipment200Response
+     */
+    estimatedDelivery?: string | null;
+    /**
+     * Tracking events ordered from newest to oldest.
+     * @type {Array<TrackShipment200ResponseEventsInner>}
+     * @memberof TrackShipment200Response
+     */
+    events: Array<TrackShipment200ResponseEventsInner>;
+}
+/**
+ * @export
+ */
+export declare const TrackShipment200ResponseCurrentStatusEnum: {
+    readonly Created: "created";
+    readonly AwaitingPickup: "awaiting_pickup";
+    readonly PickedUp: "picked_up";
+    readonly InTransit: "in_transit";
+    readonly OutForDelivery: "out_for_delivery";
+    readonly ReadyForPickup: "ready_for_pickup";
+    readonly Delivered: "delivered";
+    readonly Returned: "returned";
+    readonly Exception: "exception";
+};
+export type TrackShipment200ResponseCurrentStatusEnum = typeof TrackShipment200ResponseCurrentStatusEnum[keyof typeof TrackShipment200ResponseCurrentStatusEnum];
+/**
+ * Check if a given object implements the TrackShipment200Response interface.
+ */
+export declare function instanceOfTrackShipment200Response(value: object): value is TrackShipment200Response;
+export declare function TrackShipment200ResponseFromJSON(json: any): TrackShipment200Response;
+export declare function TrackShipment200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrackShipment200Response;
+export declare function TrackShipment200ResponseToJSON(json: any): TrackShipment200Response;
+export declare function TrackShipment200ResponseToJSONTyped(value?: TrackShipment200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TrackShipment200Response.js

@@ -0,0 +1,72 @@
+/* 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 { TrackShipment200ResponseEventsInnerFromJSON, TrackShipment200ResponseEventsInnerToJSON, } from './TrackShipment200ResponseEventsInner';
+/**
+ * @export
+ */
+export const TrackShipment200ResponseCurrentStatusEnum = {
+    Created: 'created',
+    AwaitingPickup: 'awaiting_pickup',
+    PickedUp: 'picked_up',
+    InTransit: 'in_transit',
+    OutForDelivery: 'out_for_delivery',
+    ReadyForPickup: 'ready_for_pickup',
+    Delivered: 'delivered',
+    Returned: 'returned',
+    Exception: 'exception'
+};
+/**
+ * Check if a given object implements the TrackShipment200Response interface.
+ */
+export function instanceOfTrackShipment200Response(value) {
+    if (!('trackingNumber' in value) || value['trackingNumber'] === undefined)
+        return false;
+    if (!('trackingUrl' in value) || value['trackingUrl'] === undefined)
+        return false;
+    if (!('currentStatus' in value) || value['currentStatus'] === undefined)
+        return false;
+    if (!('events' in value) || value['events'] === undefined)
+        return false;
+    return true;
+}
+export function TrackShipment200ResponseFromJSON(json) {
+    return TrackShipment200ResponseFromJSONTyped(json, false);
+}
+export function TrackShipment200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'trackingNumber': json['trackingNumber'],
+        'trackingUrl': json['trackingUrl'],
+        'currentStatus': json['currentStatus'],
+        'estimatedDelivery': json['estimatedDelivery'] === undefined ? undefined : json['estimatedDelivery'] === null ? null : json['estimatedDelivery'],
+        'events': (json['events'].map(TrackShipment200ResponseEventsInnerFromJSON)),
+    };
+}
+export function TrackShipment200ResponseToJSON(json) {
+    return TrackShipment200ResponseToJSONTyped(json, false);
+}
+export function TrackShipment200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'trackingNumber': value['trackingNumber'],
+        'trackingUrl': value['trackingUrl'],
+        'currentStatus': value['currentStatus'],
+        'estimatedDelivery': value['estimatedDelivery'],
+        'events': (value['events'].map(TrackShipment200ResponseEventsInnerToJSON)),
+    };
+}

package/dist/esm/models/TrackShipment200ResponseEventsInner.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 TrackShipment200ResponseEventsInner
+ */
+export interface TrackShipment200ResponseEventsInner {
+    /**
+     * Unique tracking event identifier.
+     * @type {string}
+     * @memberof TrackShipment200ResponseEventsInner
+     */
+    id: string;
+    /**
+     * Normalized tracking status for the event.
+     * @type {TrackShipment200ResponseEventsInnerStatusEnum}
+     * @memberof TrackShipment200ResponseEventsInner
+     */
+    status: TrackShipment200ResponseEventsInnerStatusEnum;
+    /**
+     * Raw status string reported by the carrier.
+     * @type {string}
+     * @memberof TrackShipment200ResponseEventsInner
+     */
+    carrierStatus: string;
+    /**
+     * Human-readable description of the event.
+     * @type {string}
+     * @memberof TrackShipment200ResponseEventsInner
+     */
+    description: string | null;
+    /**
+     * Location where the event was registered.
+     * @type {string}
+     * @memberof TrackShipment200ResponseEventsInner
+     */
+    location: string | null;
+    /**
+     * Timestamp when the event occurred.
+     * @type {string}
+     * @memberof TrackShipment200ResponseEventsInner
+     */
+    occurredAt: string;
+}
+/**
+ * @export
+ */
+export declare const TrackShipment200ResponseEventsInnerStatusEnum: {
+    readonly Created: "created";
+    readonly AwaitingPickup: "awaiting_pickup";
+    readonly PickedUp: "picked_up";
+    readonly InTransit: "in_transit";
+    readonly OutForDelivery: "out_for_delivery";
+    readonly ReadyForPickup: "ready_for_pickup";
+    readonly Delivered: "delivered";
+    readonly Returned: "returned";
+    readonly Exception: "exception";
+};
+export type TrackShipment200ResponseEventsInnerStatusEnum = typeof TrackShipment200ResponseEventsInnerStatusEnum[keyof typeof TrackShipment200ResponseEventsInnerStatusEnum];
+/**
+ * Check if a given object implements the TrackShipment200ResponseEventsInner interface.
+ */
+export declare function instanceOfTrackShipment200ResponseEventsInner(value: object): value is TrackShipment200ResponseEventsInner;
+export declare function TrackShipment200ResponseEventsInnerFromJSON(json: any): TrackShipment200ResponseEventsInner;
+export declare function TrackShipment200ResponseEventsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrackShipment200ResponseEventsInner;
+export declare function TrackShipment200ResponseEventsInnerToJSON(json: any): TrackShipment200ResponseEventsInner;
+export declare function TrackShipment200ResponseEventsInnerToJSONTyped(value?: TrackShipment200ResponseEventsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TrackShipment200ResponseEventsInner.js

@@ -0,0 +1,77 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const TrackShipment200ResponseEventsInnerStatusEnum = {
+    Created: 'created',
+    AwaitingPickup: 'awaiting_pickup',
+    PickedUp: 'picked_up',
+    InTransit: 'in_transit',
+    OutForDelivery: 'out_for_delivery',
+    ReadyForPickup: 'ready_for_pickup',
+    Delivered: 'delivered',
+    Returned: 'returned',
+    Exception: 'exception'
+};
+/**
+ * Check if a given object implements the TrackShipment200ResponseEventsInner interface.
+ */
+export function instanceOfTrackShipment200ResponseEventsInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('carrierStatus' in value) || value['carrierStatus'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('location' in value) || value['location'] === undefined)
+        return false;
+    if (!('occurredAt' in value) || value['occurredAt'] === undefined)
+        return false;
+    return true;
+}
+export function TrackShipment200ResponseEventsInnerFromJSON(json) {
+    return TrackShipment200ResponseEventsInnerFromJSONTyped(json, false);
+}
+export function TrackShipment200ResponseEventsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'carrierStatus': json['carrierStatus'],
+        'description': json['description'],
+        'location': json['location'],
+        'occurredAt': json['occurredAt'],
+    };
+}
+export function TrackShipment200ResponseEventsInnerToJSON(json) {
+    return TrackShipment200ResponseEventsInnerToJSONTyped(json, false);
+}
+export function TrackShipment200ResponseEventsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'carrierStatus': value['carrierStatus'],
+        'description': value['description'],
+        'location': value['location'],
+        'occurredAt': value['occurredAt'],
+    };
+}