@zippendo/sdk 1.0.0

package/src/models/SplitShipmentParcel200Response.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 { CreateShipment201Response } from './CreateShipment201Response';
+import {
+    CreateShipment201ResponseFromJSON,
+    CreateShipment201ResponseFromJSONTyped,
+    CreateShipment201ResponseToJSON,
+    CreateShipment201ResponseToJSONTyped,
+} from './CreateShipment201Response';
+
+/**
+ * 
+ * @export
+ * @interface SplitShipmentParcel200Response
+ */
+export interface SplitShipmentParcel200Response {
+    /**
+     * 
+     * @type {CreateShipment201Response}
+     * @memberof SplitShipmentParcel200Response
+     */
+    shipment: CreateShipment201Response;
+}
+
+/**
+ * Check if a given object implements the SplitShipmentParcel200Response interface.
+ */
+export function instanceOfSplitShipmentParcel200Response(value: object): value is SplitShipmentParcel200Response {
+    if (!('shipment' in value) || value['shipment'] === undefined) return false;
+    return true;
+}
+
+export function SplitShipmentParcel200ResponseFromJSON(json: any): SplitShipmentParcel200Response {
+    return SplitShipmentParcel200ResponseFromJSONTyped(json, false);
+}
+
+export function SplitShipmentParcel200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SplitShipmentParcel200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'shipment': CreateShipment201ResponseFromJSON(json['shipment']),
+    };
+}
+
+export function SplitShipmentParcel200ResponseToJSON(json: any): SplitShipmentParcel200Response {
+    return SplitShipmentParcel200ResponseToJSONTyped(json, false);
+}
+
+export function SplitShipmentParcel200ResponseToJSONTyped(value?: SplitShipmentParcel200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'shipment': CreateShipment201ResponseToJSON(value['shipment']),
+    };
+}
+

package/src/models/SplitShipmentParcelRequest.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 { SplitShipmentParcelRequestParcelsInner } from './SplitShipmentParcelRequestParcelsInner';
+import {
+    SplitShipmentParcelRequestParcelsInnerFromJSON,
+    SplitShipmentParcelRequestParcelsInnerFromJSONTyped,
+    SplitShipmentParcelRequestParcelsInnerToJSON,
+    SplitShipmentParcelRequestParcelsInnerToJSONTyped,
+} from './SplitShipmentParcelRequestParcelsInner';
+
+/**
+ * 
+ * @export
+ * @interface SplitShipmentParcelRequest
+ */
+export interface SplitShipmentParcelRequest {
+    /**
+     * Target parcel layout to redistribute order lines into.
+     * @type {Array<SplitShipmentParcelRequestParcelsInner>}
+     * @memberof SplitShipmentParcelRequest
+     */
+    parcels: Array<SplitShipmentParcelRequestParcelsInner>;
+}
+
+/**
+ * Check if a given object implements the SplitShipmentParcelRequest interface.
+ */
+export function instanceOfSplitShipmentParcelRequest(value: object): value is SplitShipmentParcelRequest {
+    if (!('parcels' in value) || value['parcels'] === undefined) return false;
+    return true;
+}
+
+export function SplitShipmentParcelRequestFromJSON(json: any): SplitShipmentParcelRequest {
+    return SplitShipmentParcelRequestFromJSONTyped(json, false);
+}
+
+export function SplitShipmentParcelRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SplitShipmentParcelRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'parcels': ((json['parcels'] as Array<any>).map(SplitShipmentParcelRequestParcelsInnerFromJSON)),
+    };
+}
+
+export function SplitShipmentParcelRequestToJSON(json: any): SplitShipmentParcelRequest {
+    return SplitShipmentParcelRequestToJSONTyped(json, false);
+}
+
+export function SplitShipmentParcelRequestToJSONTyped(value?: SplitShipmentParcelRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'parcels': ((value['parcels'] as Array<any>).map(SplitShipmentParcelRequestParcelsInnerToJSON)),
+    };
+}
+

package/src/models/SplitShipmentParcelRequestParcelsInner.ts

@@ -0,0 +1,82 @@
+/* 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 { BatchSplitShipmentRequestShipmentsInnerOrderLinesInner } from './BatchSplitShipmentRequestShipmentsInnerOrderLinesInner';
+import {
+    BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSON,
+    BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSONTyped,
+    BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSON,
+    BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSONTyped,
+} 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 function instanceOfSplitShipmentParcelRequestParcelsInner(value: object): value is SplitShipmentParcelRequestParcelsInner {
+    if (!('orderLines' in value) || value['orderLines'] === undefined) return false;
+    return true;
+}
+
+export function SplitShipmentParcelRequestParcelsInnerFromJSON(json: any): SplitShipmentParcelRequestParcelsInner {
+    return SplitShipmentParcelRequestParcelsInnerFromJSONTyped(json, false);
+}
+
+export function SplitShipmentParcelRequestParcelsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SplitShipmentParcelRequestParcelsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'] == null ? undefined : json['id'],
+        'orderLines': ((json['orderLines'] as Array<any>).map(BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSON)),
+    };
+}
+
+export function SplitShipmentParcelRequestParcelsInnerToJSON(json: any): SplitShipmentParcelRequestParcelsInner {
+    return SplitShipmentParcelRequestParcelsInnerToJSONTyped(json, false);
+}
+
+export function SplitShipmentParcelRequestParcelsInnerToJSONTyped(value?: SplitShipmentParcelRequestParcelsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'orderLines': ((value['orderLines'] as Array<any>).map(BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSON)),
+    };
+}
+

package/src/models/SplitShipmentRequest.ts

@@ -0,0 +1,114 @@
+/* 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 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 function instanceOfSplitShipmentRequest(value: object): value is SplitShipmentRequest {
+    if (!('parcelId' in value) || value['parcelId'] === undefined) return false;
+    return true;
+}
+
+export function SplitShipmentRequestFromJSON(json: any): SplitShipmentRequest {
+    return SplitShipmentRequestFromJSONTyped(json, false);
+}
+
+export function SplitShipmentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SplitShipmentRequest {
+    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: any): SplitShipmentRequest {
+    return SplitShipmentRequestToJSONTyped(json, false);
+}
+
+export function SplitShipmentRequestToJSONTyped(value?: SplitShipmentRequest | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/TestOrgWebhook200Response.ts

@@ -0,0 +1,66 @@
+/* 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 TestOrgWebhook200Response
+ */
+export interface TestOrgWebhook200Response {
+    /**
+     * Result message
+     * @type {string}
+     * @memberof TestOrgWebhook200Response
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the TestOrgWebhook200Response interface.
+ */
+export function instanceOfTestOrgWebhook200Response(value: object): value is TestOrgWebhook200Response {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function TestOrgWebhook200ResponseFromJSON(json: any): TestOrgWebhook200Response {
+    return TestOrgWebhook200ResponseFromJSONTyped(json, false);
+}
+
+export function TestOrgWebhook200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestOrgWebhook200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+    };
+}
+
+export function TestOrgWebhook200ResponseToJSON(json: any): TestOrgWebhook200Response {
+    return TestOrgWebhook200ResponseToJSONTyped(json, false);
+}
+
+export function TestOrgWebhook200ResponseToJSONTyped(value?: TestOrgWebhook200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+    };
+}
+

package/src/models/TrackShipment200Response.ts

@@ -0,0 +1,127 @@
+/* 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 { TrackShipment200ResponseEventsInner } from './TrackShipment200ResponseEventsInner';
+import {
+    TrackShipment200ResponseEventsInnerFromJSON,
+    TrackShipment200ResponseEventsInnerFromJSONTyped,
+    TrackShipment200ResponseEventsInnerToJSON,
+    TrackShipment200ResponseEventsInnerToJSONTyped,
+} 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 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'
+} as const;
+export type TrackShipment200ResponseCurrentStatusEnum = typeof TrackShipment200ResponseCurrentStatusEnum[keyof typeof TrackShipment200ResponseCurrentStatusEnum];
+
+
+/**
+ * Check if a given object implements the TrackShipment200Response interface.
+ */
+export function instanceOfTrackShipment200Response(value: object): value is TrackShipment200Response {
+    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: any): TrackShipment200Response {
+    return TrackShipment200ResponseFromJSONTyped(json, false);
+}
+
+export function TrackShipment200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrackShipment200Response {
+    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'] as Array<any>).map(TrackShipment200ResponseEventsInnerFromJSON)),
+    };
+}
+
+export function TrackShipment200ResponseToJSON(json: any): TrackShipment200Response {
+    return TrackShipment200ResponseToJSONTyped(json, false);
+}
+
+export function TrackShipment200ResponseToJSONTyped(value?: TrackShipment200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'trackingNumber': value['trackingNumber'],
+        'trackingUrl': value['trackingUrl'],
+        'currentStatus': value['currentStatus'],
+        'estimatedDelivery': value['estimatedDelivery'],
+        'events': ((value['events'] as Array<any>).map(TrackShipment200ResponseEventsInnerToJSON)),
+    };
+}
+

package/src/models/TrackShipment200ResponseEventsInner.ts

@@ -0,0 +1,129 @@
+/* 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 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 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'
+} as const;
+export type TrackShipment200ResponseEventsInnerStatusEnum = typeof TrackShipment200ResponseEventsInnerStatusEnum[keyof typeof TrackShipment200ResponseEventsInnerStatusEnum];
+
+
+/**
+ * Check if a given object implements the TrackShipment200ResponseEventsInner interface.
+ */
+export function instanceOfTrackShipment200ResponseEventsInner(value: object): value is TrackShipment200ResponseEventsInner {
+    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: any): TrackShipment200ResponseEventsInner {
+    return TrackShipment200ResponseEventsInnerFromJSONTyped(json, false);
+}
+
+export function TrackShipment200ResponseEventsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrackShipment200ResponseEventsInner {
+    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: any): TrackShipment200ResponseEventsInner {
+    return TrackShipment200ResponseEventsInnerToJSONTyped(json, false);
+}
+
+export function TrackShipment200ResponseEventsInnerToJSONTyped(value?: TrackShipment200ResponseEventsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'carrierStatus': value['carrierStatus'],
+        'description': value['description'],
+        'location': value['location'],
+        'occurredAt': value['occurredAt'],
+    };
+}
+