@zippendo/sdk 1.0.0

package/src/models/ListOrgWebhooks200ResponseDataInner.ts

@@ -0,0 +1,120 @@
+/* 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 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 function instanceOfListOrgWebhooks200ResponseDataInner(value: object): value is ListOrgWebhooks200ResponseDataInner {
+    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;
+}
+
+export function ListOrgWebhooks200ResponseDataInnerFromJSON(json: any): ListOrgWebhooks200ResponseDataInner {
+    return ListOrgWebhooks200ResponseDataInnerFromJSONTyped(json, false);
+}
+
+export function ListOrgWebhooks200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrgWebhooks200ResponseDataInner {
+    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'],
+    };
+}
+
+export function ListOrgWebhooks200ResponseDataInnerToJSON(json: any): ListOrgWebhooks200ResponseDataInner {
+    return ListOrgWebhooks200ResponseDataInnerToJSONTyped(json, false);
+}
+
+export function ListOrgWebhooks200ResponseDataInnerToJSONTyped(value?: ListOrgWebhooks200ResponseDataInner | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/ListShipments200Response.ts

@@ -0,0 +1,110 @@
+/* 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 { ListShipments200ResponseDataInner } from './ListShipments200ResponseDataInner';
+import {
+    ListShipments200ResponseDataInnerFromJSON,
+    ListShipments200ResponseDataInnerFromJSONTyped,
+    ListShipments200ResponseDataInnerToJSON,
+    ListShipments200ResponseDataInnerToJSONTyped,
+} 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 function instanceOfListShipments200Response(value: object): value is ListShipments200Response {
+    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;
+}
+
+export function ListShipments200ResponseFromJSON(json: any): ListShipments200Response {
+    return ListShipments200ResponseFromJSONTyped(json, false);
+}
+
+export function ListShipments200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListShipments200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(ListShipments200ResponseDataInnerFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'limit': json['limit'],
+        'totalPages': json['totalPages'],
+    };
+}
+
+export function ListShipments200ResponseToJSON(json: any): ListShipments200Response {
+    return ListShipments200ResponseToJSONTyped(json, false);
+}
+
+export function ListShipments200ResponseToJSONTyped(value?: ListShipments200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(ListShipments200ResponseDataInnerToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'limit': value['limit'],
+        'totalPages': value['totalPages'],
+    };
+}
+

package/src/models/ListShipments200ResponseDataInner.ts

@@ -0,0 +1,169 @@
+/* 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 { ListShipments200ResponseDataInnerAddress } from './ListShipments200ResponseDataInnerAddress';
+import {
+    ListShipments200ResponseDataInnerAddressFromJSON,
+    ListShipments200ResponseDataInnerAddressFromJSONTyped,
+    ListShipments200ResponseDataInnerAddressToJSON,
+    ListShipments200ResponseDataInnerAddressToJSONTyped,
+} from './ListShipments200ResponseDataInnerAddress';
+import type { ListShipments200ResponseDataInnerCarrierSettings } from './ListShipments200ResponseDataInnerCarrierSettings';
+import {
+    ListShipments200ResponseDataInnerCarrierSettingsFromJSON,
+    ListShipments200ResponseDataInnerCarrierSettingsFromJSONTyped,
+    ListShipments200ResponseDataInnerCarrierSettingsToJSON,
+    ListShipments200ResponseDataInnerCarrierSettingsToJSONTyped,
+} 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 const ListShipments200ResponseDataInnerTypeEnum = {
+    Outbound: 'outbound',
+    Inbound: 'inbound'
+} as const;
+export type ListShipments200ResponseDataInnerTypeEnum = typeof ListShipments200ResponseDataInnerTypeEnum[keyof typeof ListShipments200ResponseDataInnerTypeEnum];
+
+/**
+ * @export
+ */
+export const ListShipments200ResponseDataInnerStatusEnum = {
+    Draft: 'draft',
+    Pending: 'pending',
+    Processing: 'processing',
+    Dispatched: 'dispatched',
+    PartlyDispatched: 'partly_dispatched',
+    Error: 'error',
+    Cancelled: 'cancelled',
+    OnHold: 'on_hold'
+} as const;
+export type ListShipments200ResponseDataInnerStatusEnum = typeof ListShipments200ResponseDataInnerStatusEnum[keyof typeof ListShipments200ResponseDataInnerStatusEnum];
+
+
+/**
+ * Check if a given object implements the ListShipments200ResponseDataInner interface.
+ */
+export function instanceOfListShipments200ResponseDataInner(value: object): value is ListShipments200ResponseDataInner {
+    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;
+}
+
+export function ListShipments200ResponseDataInnerFromJSON(json: any): ListShipments200ResponseDataInner {
+    return ListShipments200ResponseDataInnerFromJSONTyped(json, false);
+}
+
+export function ListShipments200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListShipments200ResponseDataInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'reference': json['reference'],
+        'type': json['type'],
+        'carrierSettings': ListShipments200ResponseDataInnerCarrierSettingsFromJSON(json['carrierSettings']),
+        'status': json['status'],
+        'address': json['address'] === undefined ? undefined : json['address'] === null ? null : ListShipments200ResponseDataInnerAddressFromJSON(json['address']),
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+
+export function ListShipments200ResponseDataInnerToJSON(json: any): ListShipments200ResponseDataInner {
+    return ListShipments200ResponseDataInnerToJSONTyped(json, false);
+}
+
+export function ListShipments200ResponseDataInnerToJSONTyped(value?: ListShipments200ResponseDataInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'reference': value['reference'],
+        'type': value['type'],
+        'carrierSettings': ListShipments200ResponseDataInnerCarrierSettingsToJSON(value['carrierSettings']),
+        'status': value['status'],
+        'address': ListShipments200ResponseDataInnerAddressToJSON(value['address']),
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}
+

package/src/models/ListShipments200ResponseDataInnerAddress.ts

@@ -0,0 +1,212 @@
+/* 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 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 const ListShipments200ResponseDataInnerAddressAddressTypesEnum = {
+    Sender: 'sender',
+    Pickup: 'pickup',
+    Return: 'return'
+} as const;
+export type ListShipments200ResponseDataInnerAddressAddressTypesEnum = typeof ListShipments200ResponseDataInnerAddressAddressTypesEnum[keyof typeof ListShipments200ResponseDataInnerAddressAddressTypesEnum];
+
+
+/**
+ * Check if a given object implements the ListShipments200ResponseDataInnerAddress interface.
+ */
+export function instanceOfListShipments200ResponseDataInnerAddress(value: object): value is ListShipments200ResponseDataInnerAddress {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('attContact' in value) || value['attContact'] === undefined) return false;
+    if (!('address1' in value) || value['address1'] === undefined) return false;
+    if (!('address2' in value) || value['address2'] === undefined) return false;
+    if (!('zipcode' in value) || value['zipcode'] === undefined) return false;
+    if (!('city' in value) || value['city'] === undefined) return false;
+    if (!('phone' in value) || value['phone'] === undefined) return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
+    if (!('state' in value) || value['state'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('addressTypes' in value) || value['addressTypes'] === 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 ListShipments200ResponseDataInnerAddressFromJSON(json: any): ListShipments200ResponseDataInnerAddress {
+    return ListShipments200ResponseDataInnerAddressFromJSONTyped(json, false);
+}
+
+export function ListShipments200ResponseDataInnerAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListShipments200ResponseDataInnerAddress {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'attContact': json['attContact'],
+        'address1': json['address1'],
+        'address2': json['address2'],
+        'zipcode': json['zipcode'],
+        'city': json['city'],
+        'phone': json['phone'],
+        'countryCode': json['countryCode'],
+        'state': json['state'],
+        'email': json['email'],
+        'customs': json['customs'] === undefined ? undefined : json['customs'] === null ? null : json['customs'],
+        'addressTypes': json['addressTypes'],
+        'orgId': json['orgId'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+
+export function ListShipments200ResponseDataInnerAddressToJSON(json: any): ListShipments200ResponseDataInnerAddress {
+    return ListShipments200ResponseDataInnerAddressToJSONTyped(json, false);
+}
+
+export function ListShipments200ResponseDataInnerAddressToJSONTyped(value?: ListShipments200ResponseDataInnerAddress | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'attContact': value['attContact'],
+        'address1': value['address1'],
+        'address2': value['address2'],
+        'zipcode': value['zipcode'],
+        'city': value['city'],
+        'phone': value['phone'],
+        'countryCode': value['countryCode'],
+        'state': value['state'],
+        'email': value['email'],
+        'customs': value['customs'],
+        'addressTypes': value['addressTypes'],
+        'orgId': value['orgId'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}
+