@zippendo/sdk 1.0.0

package/dist/esm/models/GetOrg200Response.js

@@ -0,0 +1,90 @@
+/* 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 { GetOrg200ResponseCountFromJSON, GetOrg200ResponseCountToJSON, } from './GetOrg200ResponseCount';
+/**
+ * Check if a given object implements the GetOrg200Response interface.
+ */
+export function instanceOfGetOrg200Response(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('currency' in value) || value['currency'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    if ((!('count' in value) && !('_count' in value)) || (value['count'] === undefined && value['_count'] === undefined))
+        return false;
+    return true;
+}
+export function GetOrg200ResponseFromJSON(json) {
+    return GetOrg200ResponseFromJSONTyped(json, false);
+}
+export function GetOrg200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'description': json['description'],
+        'currency': json['currency'],
+        'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
+        'billingEmail': json['billingEmail'] === undefined ? undefined : json['billingEmail'] === null ? null : json['billingEmail'],
+        'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
+        'addressLine1': json['addressLine1'] === undefined ? undefined : json['addressLine1'] === null ? null : json['addressLine1'],
+        'addressLine2': json['addressLine2'] === undefined ? undefined : json['addressLine2'] === null ? null : json['addressLine2'],
+        'city': json['city'] === undefined ? undefined : json['city'] === null ? null : json['city'],
+        'postalCode': json['postalCode'] === undefined ? undefined : json['postalCode'] === null ? null : json['postalCode'],
+        'country': json['country'] === undefined ? undefined : json['country'] === null ? null : json['country'],
+        'customs': json['customs'] === undefined ? undefined : json['customs'] === null ? null : json['customs'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+        'count': GetOrg200ResponseCountFromJSON(json['_count']),
+    };
+}
+export function GetOrg200ResponseToJSON(json) {
+    return GetOrg200ResponseToJSONTyped(json, false);
+}
+export function GetOrg200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'slug': value['slug'],
+        'description': value['description'],
+        'currency': value['currency'],
+        'vatNumber': value['vatNumber'],
+        'billingEmail': value['billingEmail'],
+        'companyName': value['companyName'],
+        'addressLine1': value['addressLine1'],
+        'addressLine2': value['addressLine2'],
+        'city': value['city'],
+        'postalCode': value['postalCode'],
+        'country': value['country'],
+        'customs': value['customs'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        '_count': GetOrg200ResponseCountToJSON(value['count']),
+    };
+}

package/dist/esm/models/GetOrg200ResponseCount.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 GetOrg200ResponseCount
+ */
+export interface GetOrg200ResponseCount {
+    /**
+     * Number of members in the organization
+     * @type {number}
+     * @memberof GetOrg200ResponseCount
+     */
+    members: number;
+}
+/**
+ * Check if a given object implements the GetOrg200ResponseCount interface.
+ */
+export declare function instanceOfGetOrg200ResponseCount(value: object): value is GetOrg200ResponseCount;
+export declare function GetOrg200ResponseCountFromJSON(json: any): GetOrg200ResponseCount;
+export declare function GetOrg200ResponseCountFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrg200ResponseCount;
+export declare function GetOrg200ResponseCountToJSON(json: any): GetOrg200ResponseCount;
+export declare function GetOrg200ResponseCountToJSONTyped(value?: GetOrg200ResponseCount | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetOrg200ResponseCount.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 GetOrg200ResponseCount interface.
+ */
+export function instanceOfGetOrg200ResponseCount(value) {
+    if (!('members' in value) || value['members'] === undefined)
+        return false;
+    return true;
+}
+export function GetOrg200ResponseCountFromJSON(json) {
+    return GetOrg200ResponseCountFromJSONTyped(json, false);
+}
+export function GetOrg200ResponseCountFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'members': json['members'],
+    };
+}
+export function GetOrg200ResponseCountToJSON(json) {
+    return GetOrg200ResponseCountToJSONTyped(json, false);
+}
+export function GetOrg200ResponseCountToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'members': value['members'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 GetOrgBranding200Response
+ */
+export interface GetOrgBranding200Response {
+    /**
+     * Primary brand color (hex)
+     * @type {string}
+     * @memberof GetOrgBranding200Response
+     */
+    primaryColor: string | null;
+    /**
+     * Secondary brand color (hex)
+     * @type {string}
+     * @memberof GetOrgBranding200Response
+     */
+    secondaryColor: string | null;
+    /**
+     * Authenticated URL to download the org logo image, or null if no logo is set
+     * @type {string}
+     * @memberof GetOrgBranding200Response
+     */
+    logoUrl: string | null;
+}
+/**
+ * Check if a given object implements the GetOrgBranding200Response interface.
+ */
+export declare function instanceOfGetOrgBranding200Response(value: object): value is GetOrgBranding200Response;
+export declare function GetOrgBranding200ResponseFromJSON(json: any): GetOrgBranding200Response;
+export declare function GetOrgBranding200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrgBranding200Response;
+export declare function GetOrgBranding200ResponseToJSON(json: any): GetOrgBranding200Response;
+export declare function GetOrgBranding200ResponseToJSONTyped(value?: GetOrgBranding200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetOrgBranding200Response.js

@@ -0,0 +1,51 @@
+/* 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 GetOrgBranding200Response interface.
+ */
+export function instanceOfGetOrgBranding200Response(value) {
+    if (!('primaryColor' in value) || value['primaryColor'] === undefined)
+        return false;
+    if (!('secondaryColor' in value) || value['secondaryColor'] === undefined)
+        return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined)
+        return false;
+    return true;
+}
+export function GetOrgBranding200ResponseFromJSON(json) {
+    return GetOrgBranding200ResponseFromJSONTyped(json, false);
+}
+export function GetOrgBranding200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'primaryColor': json['primaryColor'],
+        'secondaryColor': json['secondaryColor'],
+        'logoUrl': json['logoUrl'],
+    };
+}
+export function GetOrgBranding200ResponseToJSON(json) {
+    return GetOrgBranding200ResponseToJSONTyped(json, false);
+}
+export function GetOrgBranding200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'primaryColor': value['primaryColor'],
+        'secondaryColor': value['secondaryColor'],
+        'logoUrl': value['logoUrl'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 HealthCheck200Response
+ */
+export interface HealthCheck200Response {
+    /**
+     * Service status
+     * @type {string}
+     * @memberof HealthCheck200Response
+     */
+    status: string;
+    /**
+     * Current server time (ISO 8601)
+     * @type {string}
+     * @memberof HealthCheck200Response
+     */
+    timestamp: string;
+    /**
+     * API version
+     * @type {string}
+     * @memberof HealthCheck200Response
+     */
+    version: string;
+}
+/**
+ * Check if a given object implements the HealthCheck200Response interface.
+ */
+export declare function instanceOfHealthCheck200Response(value: object): value is HealthCheck200Response;
+export declare function HealthCheck200ResponseFromJSON(json: any): HealthCheck200Response;
+export declare function HealthCheck200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HealthCheck200Response;
+export declare function HealthCheck200ResponseToJSON(json: any): HealthCheck200Response;
+export declare function HealthCheck200ResponseToJSONTyped(value?: HealthCheck200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/HealthCheck200Response.js

@@ -0,0 +1,51 @@
+/* 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 HealthCheck200Response interface.
+ */
+export function instanceOfHealthCheck200Response(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined)
+        return false;
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    return true;
+}
+export function HealthCheck200ResponseFromJSON(json) {
+    return HealthCheck200ResponseFromJSONTyped(json, false);
+}
+export function HealthCheck200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'timestamp': json['timestamp'],
+        'version': json['version'],
+    };
+}
+export function HealthCheck200ResponseToJSON(json) {
+    return HealthCheck200ResponseToJSONTyped(json, false);
+}
+export function HealthCheck200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'timestamp': value['timestamp'],
+        'version': value['version'],
+    };
+}

package/dist/esm/models/ListAddresses200Response.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 { ListAddresses200ResponseDataInner } from './ListAddresses200ResponseDataInner';
+/**
+ *
+ * @export
+ * @interface ListAddresses200Response
+ */
+export interface ListAddresses200Response {
+    /**
+     * Page of results
+     * @type {Array<ListAddresses200ResponseDataInner>}
+     * @memberof ListAddresses200Response
+     */
+    data: Array<ListAddresses200ResponseDataInner>;
+    /**
+     * Total matching items across all pages
+     * @type {number}
+     * @memberof ListAddresses200Response
+     */
+    total: number;
+    /**
+     * Current page number (1-based)
+     * @type {number}
+     * @memberof ListAddresses200Response
+     */
+    page: number;
+    /**
+     * Items per page
+     * @type {number}
+     * @memberof ListAddresses200Response
+     */
+    limit: number;
+    /**
+     * Total number of pages
+     * @type {number}
+     * @memberof ListAddresses200Response
+     */
+    totalPages: number;
+}
+/**
+ * Check if a given object implements the ListAddresses200Response interface.
+ */
+export declare function instanceOfListAddresses200Response(value: object): value is ListAddresses200Response;
+export declare function ListAddresses200ResponseFromJSON(json: any): ListAddresses200Response;
+export declare function ListAddresses200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListAddresses200Response;
+export declare function ListAddresses200ResponseToJSON(json: any): ListAddresses200Response;
+export declare function ListAddresses200ResponseToJSONTyped(value?: ListAddresses200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ListAddresses200Response.js

@@ -0,0 +1,60 @@
+/* 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 { ListAddresses200ResponseDataInnerFromJSON, ListAddresses200ResponseDataInnerToJSON, } from './ListAddresses200ResponseDataInner';
+/**
+ * Check if a given object implements the ListAddresses200Response interface.
+ */
+export function instanceOfListAddresses200Response(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;
+}
+export function ListAddresses200ResponseFromJSON(json) {
+    return ListAddresses200ResponseFromJSONTyped(json, false);
+}
+export function ListAddresses200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ListAddresses200ResponseDataInnerFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'limit': json['limit'],
+        'totalPages': json['totalPages'],
+    };
+}
+export function ListAddresses200ResponseToJSON(json) {
+    return ListAddresses200ResponseToJSONTyped(json, false);
+}
+export function ListAddresses200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ListAddresses200ResponseDataInnerToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'limit': value['limit'],
+        'totalPages': value['totalPages'],
+    };
+}

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