@zippendo/sdk 1.0.0

package/dist/models/ListOrgWebhooks200ResponseDataInner.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 ListOrgWebhooks200ResponseDataInner
+ */
+export interface ListOrgWebhooks200ResponseDataInner {
+    /**
+     * Webhook ID
+     * @type {string}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    id: string;
+    /**
+     * Human-readable webhook name
+     * @type {string}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    name: string;
+    /**
+     * Webhook endpoint URL
+     * @type {string}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    url: string;
+    /**
+     * Events the webhook is subscribed to
+     * @type {Array<string>}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    events: Array<string>;
+    /**
+     * Whether the webhook is active
+     * @type {boolean}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    isActive: boolean;
+    /**
+     * Creation timestamp (ISO 8601)
+     * @type {string}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp (ISO 8601)
+     * @type {string}
+     * @memberof ListOrgWebhooks200ResponseDataInner
+     */
+    updatedAt: string;
+}
+/**
+ * Check if a given object implements the ListOrgWebhooks200ResponseDataInner interface.
+ */
+export declare function instanceOfListOrgWebhooks200ResponseDataInner(value: object): value is ListOrgWebhooks200ResponseDataInner;
+export declare function ListOrgWebhooks200ResponseDataInnerFromJSON(json: any): ListOrgWebhooks200ResponseDataInner;
+export declare function ListOrgWebhooks200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrgWebhooks200ResponseDataInner;
+export declare function ListOrgWebhooks200ResponseDataInnerToJSON(json: any): ListOrgWebhooks200ResponseDataInner;
+export declare function ListOrgWebhooks200ResponseDataInnerToJSONTyped(value?: ListOrgWebhooks200ResponseDataInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListOrgWebhooks200ResponseDataInner.js

@@ -0,0 +1,74 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfListOrgWebhooks200ResponseDataInner = instanceOfListOrgWebhooks200ResponseDataInner;
+exports.ListOrgWebhooks200ResponseDataInnerFromJSON = ListOrgWebhooks200ResponseDataInnerFromJSON;
+exports.ListOrgWebhooks200ResponseDataInnerFromJSONTyped = ListOrgWebhooks200ResponseDataInnerFromJSONTyped;
+exports.ListOrgWebhooks200ResponseDataInnerToJSON = ListOrgWebhooks200ResponseDataInnerToJSON;
+exports.ListOrgWebhooks200ResponseDataInnerToJSONTyped = ListOrgWebhooks200ResponseDataInnerToJSONTyped;
+/**
+ * Check if a given object implements the ListOrgWebhooks200ResponseDataInner interface.
+ */
+function instanceOfListOrgWebhooks200ResponseDataInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('events' in value) || value['events'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function ListOrgWebhooks200ResponseDataInnerFromJSON(json) {
+    return ListOrgWebhooks200ResponseDataInnerFromJSONTyped(json, false);
+}
+function ListOrgWebhooks200ResponseDataInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'url': json['url'],
+        'events': json['events'],
+        'isActive': json['isActive'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+function ListOrgWebhooks200ResponseDataInnerToJSON(json) {
+    return ListOrgWebhooks200ResponseDataInnerToJSONTyped(json, false);
+}
+function ListOrgWebhooks200ResponseDataInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'url': value['url'],
+        'events': value['events'],
+        'isActive': value['isActive'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}

package/dist/models/ListShipments200Response.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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 { ListShipments200ResponseDataInner } from './ListShipments200ResponseDataInner';
+/**
+ *
+ * @export
+ * @interface ListShipments200Response
+ */
+export interface ListShipments200Response {
+    /**
+     * Page of results
+     * @type {Array<ListShipments200ResponseDataInner>}
+     * @memberof ListShipments200Response
+     */
+    data: Array<ListShipments200ResponseDataInner>;
+    /**
+     * Total matching items across all pages
+     * @type {number}
+     * @memberof ListShipments200Response
+     */
+    total: number;
+    /**
+     * Current page number (1-based)
+     * @type {number}
+     * @memberof ListShipments200Response
+     */
+    page: number;
+    /**
+     * Items per page
+     * @type {number}
+     * @memberof ListShipments200Response
+     */
+    limit: number;
+    /**
+     * Total number of pages
+     * @type {number}
+     * @memberof ListShipments200Response
+     */
+    totalPages: number;
+}
+/**
+ * Check if a given object implements the ListShipments200Response interface.
+ */
+export declare function instanceOfListShipments200Response(value: object): value is ListShipments200Response;
+export declare function ListShipments200ResponseFromJSON(json: any): ListShipments200Response;
+export declare function ListShipments200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListShipments200Response;
+export declare function ListShipments200ResponseToJSON(json: any): ListShipments200Response;
+export declare function ListShipments200ResponseToJSONTyped(value?: ListShipments200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListShipments200Response.js

@@ -0,0 +1,67 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfListShipments200Response = instanceOfListShipments200Response;
+exports.ListShipments200ResponseFromJSON = ListShipments200ResponseFromJSON;
+exports.ListShipments200ResponseFromJSONTyped = ListShipments200ResponseFromJSONTyped;
+exports.ListShipments200ResponseToJSON = ListShipments200ResponseToJSON;
+exports.ListShipments200ResponseToJSONTyped = ListShipments200ResponseToJSONTyped;
+const ListShipments200ResponseDataInner_1 = require("./ListShipments200ResponseDataInner");
+/**
+ * Check if a given object implements the ListShipments200Response interface.
+ */
+function instanceOfListShipments200Response(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('limit' in value) || value['limit'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    return true;
+}
+function ListShipments200ResponseFromJSON(json) {
+    return ListShipments200ResponseFromJSONTyped(json, false);
+}
+function ListShipments200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ListShipments200ResponseDataInner_1.ListShipments200ResponseDataInnerFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'limit': json['limit'],
+        'totalPages': json['totalPages'],
+    };
+}
+function ListShipments200ResponseToJSON(json) {
+    return ListShipments200ResponseToJSONTyped(json, false);
+}
+function ListShipments200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ListShipments200ResponseDataInner_1.ListShipments200ResponseDataInnerToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'limit': value['limit'],
+        'totalPages': value['totalPages'],
+    };
+}

package/dist/models/ListShipments200ResponseDataInner.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 { ListShipments200ResponseDataInnerAddress } from './ListShipments200ResponseDataInnerAddress';
+import type { ListShipments200ResponseDataInnerCarrierSettings } from './ListShipments200ResponseDataInnerCarrierSettings';
+/**
+ *
+ * @export
+ * @interface ListShipments200ResponseDataInner
+ */
+export interface ListShipments200ResponseDataInner {
+    /**
+     * Unique shipment identifier.
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    id: string;
+    /**
+     * Customer-facing shipment reference.
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    reference: string;
+    /**
+     * Direction of the shipment relative to the organization.
+     * @type {ListShipments200ResponseDataInnerTypeEnum}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    type: ListShipments200ResponseDataInnerTypeEnum;
+    /**
+     *
+     * @type {ListShipments200ResponseDataInnerCarrierSettings}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    carrierSettings: ListShipments200ResponseDataInnerCarrierSettings;
+    /**
+     * Lifecycle status of the shipment.
+     * @type {ListShipments200ResponseDataInnerStatusEnum}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    status: ListShipments200ResponseDataInnerStatusEnum;
+    /**
+     *
+     * @type {ListShipments200ResponseDataInnerAddress}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    address?: ListShipments200ResponseDataInnerAddress | null;
+    /**
+     * Timestamp when the shipment was created.
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    createdAt: string;
+    /**
+     * Timestamp when the shipment was last updated.
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInner
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const ListShipments200ResponseDataInnerTypeEnum: {
+    readonly Outbound: "outbound";
+    readonly Inbound: "inbound";
+};
+export type ListShipments200ResponseDataInnerTypeEnum = typeof ListShipments200ResponseDataInnerTypeEnum[keyof typeof ListShipments200ResponseDataInnerTypeEnum];
+/**
+ * @export
+ */
+export declare const ListShipments200ResponseDataInnerStatusEnum: {
+    readonly Draft: "draft";
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Dispatched: "dispatched";
+    readonly PartlyDispatched: "partly_dispatched";
+    readonly Error: "error";
+    readonly Cancelled: "cancelled";
+    readonly OnHold: "on_hold";
+};
+export type ListShipments200ResponseDataInnerStatusEnum = typeof ListShipments200ResponseDataInnerStatusEnum[keyof typeof ListShipments200ResponseDataInnerStatusEnum];
+/**
+ * Check if a given object implements the ListShipments200ResponseDataInner interface.
+ */
+export declare function instanceOfListShipments200ResponseDataInner(value: object): value is ListShipments200ResponseDataInner;
+export declare function ListShipments200ResponseDataInnerFromJSON(json: any): ListShipments200ResponseDataInner;
+export declare function ListShipments200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListShipments200ResponseDataInner;
+export declare function ListShipments200ResponseDataInnerToJSON(json: any): ListShipments200ResponseDataInner;
+export declare function ListShipments200ResponseDataInnerToJSONTyped(value?: ListShipments200ResponseDataInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListShipments200ResponseDataInner.js

@@ -0,0 +1,99 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListShipments200ResponseDataInnerStatusEnum = exports.ListShipments200ResponseDataInnerTypeEnum = void 0;
+exports.instanceOfListShipments200ResponseDataInner = instanceOfListShipments200ResponseDataInner;
+exports.ListShipments200ResponseDataInnerFromJSON = ListShipments200ResponseDataInnerFromJSON;
+exports.ListShipments200ResponseDataInnerFromJSONTyped = ListShipments200ResponseDataInnerFromJSONTyped;
+exports.ListShipments200ResponseDataInnerToJSON = ListShipments200ResponseDataInnerToJSON;
+exports.ListShipments200ResponseDataInnerToJSONTyped = ListShipments200ResponseDataInnerToJSONTyped;
+const ListShipments200ResponseDataInnerAddress_1 = require("./ListShipments200ResponseDataInnerAddress");
+const ListShipments200ResponseDataInnerCarrierSettings_1 = require("./ListShipments200ResponseDataInnerCarrierSettings");
+/**
+ * @export
+ */
+exports.ListShipments200ResponseDataInnerTypeEnum = {
+    Outbound: 'outbound',
+    Inbound: 'inbound'
+};
+/**
+ * @export
+ */
+exports.ListShipments200ResponseDataInnerStatusEnum = {
+    Draft: 'draft',
+    Pending: 'pending',
+    Processing: 'processing',
+    Dispatched: 'dispatched',
+    PartlyDispatched: 'partly_dispatched',
+    Error: 'error',
+    Cancelled: 'cancelled',
+    OnHold: 'on_hold'
+};
+/**
+ * Check if a given object implements the ListShipments200ResponseDataInner interface.
+ */
+function instanceOfListShipments200ResponseDataInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('reference' in value) || value['reference'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('carrierSettings' in value) || value['carrierSettings'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function ListShipments200ResponseDataInnerFromJSON(json) {
+    return ListShipments200ResponseDataInnerFromJSONTyped(json, false);
+}
+function ListShipments200ResponseDataInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'reference': json['reference'],
+        'type': json['type'],
+        'carrierSettings': (0, ListShipments200ResponseDataInnerCarrierSettings_1.ListShipments200ResponseDataInnerCarrierSettingsFromJSON)(json['carrierSettings']),
+        'status': json['status'],
+        'address': json['address'] === undefined ? undefined : json['address'] === null ? null : (0, ListShipments200ResponseDataInnerAddress_1.ListShipments200ResponseDataInnerAddressFromJSON)(json['address']),
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+function ListShipments200ResponseDataInnerToJSON(json) {
+    return ListShipments200ResponseDataInnerToJSONTyped(json, false);
+}
+function ListShipments200ResponseDataInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'reference': value['reference'],
+        'type': value['type'],
+        'carrierSettings': (0, ListShipments200ResponseDataInnerCarrierSettings_1.ListShipments200ResponseDataInnerCarrierSettingsToJSON)(value['carrierSettings']),
+        'status': value['status'],
+        'address': (0, ListShipments200ResponseDataInnerAddress_1.ListShipments200ResponseDataInnerAddressToJSON)(value['address']),
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}

package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts

@@ -0,0 +1,133 @@
+/**
+ * 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 ListShipments200ResponseDataInnerAddress
+ */
+export interface ListShipments200ResponseDataInnerAddress {
+    /**
+     * Unique address identifier
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    id: string;
+    /**
+     * Name of the address
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    name: string;
+    /**
+     * Attention contact person
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    attContact: string;
+    /**
+     * Address line 1
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    address1: string;
+    /**
+     * Address line 2
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    address2: string | null;
+    /**
+     * Postal/ZIP code
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    zipcode: string;
+    /**
+     * City
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    city: string;
+    /**
+     * Phone number
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    phone: string;
+    /**
+     * ISO country code
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    countryCode: string;
+    /**
+     * State/Province
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    state: string | null;
+    /**
+     * Email address
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    email: string;
+    /**
+     * Customs identifiers keyed by type
+     * @type {{ [key: string]: string; }}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    customs?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Address types (sender, pickup, return)
+     * @type {Array<ListShipments200ResponseDataInnerAddressAddressTypesEnum>}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    addressTypes: Array<ListShipments200ResponseDataInnerAddressAddressTypesEnum>;
+    /**
+     * Owning organization ID
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    orgId: string;
+    /**
+     * Creation timestamp (ISO 8601)
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp (ISO 8601)
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const ListShipments200ResponseDataInnerAddressAddressTypesEnum: {
+    readonly Sender: "sender";
+    readonly Pickup: "pickup";
+    readonly Return: "return";
+};
+export type ListShipments200ResponseDataInnerAddressAddressTypesEnum = typeof ListShipments200ResponseDataInnerAddressAddressTypesEnum[keyof typeof ListShipments200ResponseDataInnerAddressAddressTypesEnum];
+/**
+ * Check if a given object implements the ListShipments200ResponseDataInnerAddress interface.
+ */
+export declare function instanceOfListShipments200ResponseDataInnerAddress(value: object): value is ListShipments200ResponseDataInnerAddress;
+export declare function ListShipments200ResponseDataInnerAddressFromJSON(json: any): ListShipments200ResponseDataInnerAddress;
+export declare function ListShipments200ResponseDataInnerAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListShipments200ResponseDataInnerAddress;
+export declare function ListShipments200ResponseDataInnerAddressToJSON(json: any): ListShipments200ResponseDataInnerAddress;
+export declare function ListShipments200ResponseDataInnerAddressToJSONTyped(value?: ListShipments200ResponseDataInnerAddress | null, ignoreDiscriminator?: boolean): any;