@zippendo/sdk 1.0.0

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

@@ -0,0 +1,109 @@
+/**
+ * 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 UpdateAddressRequest
+ */
+export interface UpdateAddressRequest {
+    /**
+     * Name of the address
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    name?: string;
+    /**
+     * Attention contact person
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    attContact?: string;
+    /**
+     * Address line 1
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    address1?: string;
+    /**
+     * Address line 2
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    address2?: string;
+    /**
+     * Postal/ZIP code
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    zipcode?: string;
+    /**
+     * City
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    city?: string;
+    /**
+     * Phone number
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    phone?: string;
+    /**
+     * ISO country code
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    countryCode?: string;
+    /**
+     * State/Province
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    state?: string;
+    /**
+     * Email address
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    email?: string;
+    /**
+     * Customs identifiers
+     * @type {{ [key: string]: string; }}
+     * @memberof UpdateAddressRequest
+     */
+    customs?: {
+        [key: string]: string;
+    };
+    /**
+     * Address types (sender, pickup, return)
+     * @type {Array<UpdateAddressRequestAddressTypesEnum>}
+     * @memberof UpdateAddressRequest
+     */
+    addressTypes?: Array<UpdateAddressRequestAddressTypesEnum>;
+}
+/**
+ * @export
+ */
+export declare const UpdateAddressRequestAddressTypesEnum: {
+    readonly Sender: "sender";
+    readonly Pickup: "pickup";
+    readonly Return: "return";
+};
+export type UpdateAddressRequestAddressTypesEnum = typeof UpdateAddressRequestAddressTypesEnum[keyof typeof UpdateAddressRequestAddressTypesEnum];
+/**
+ * Check if a given object implements the UpdateAddressRequest interface.
+ */
+export declare function instanceOfUpdateAddressRequest(value: object): value is UpdateAddressRequest;
+export declare function UpdateAddressRequestFromJSON(json: any): UpdateAddressRequest;
+export declare function UpdateAddressRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateAddressRequest;
+export declare function UpdateAddressRequestToJSON(json: any): UpdateAddressRequest;
+export declare function UpdateAddressRequestToJSONTyped(value?: UpdateAddressRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateAddressRequest.js

@@ -0,0 +1,71 @@
+/* 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 UpdateAddressRequestAddressTypesEnum = {
+    Sender: 'sender',
+    Pickup: 'pickup',
+    Return: 'return'
+};
+/**
+ * Check if a given object implements the UpdateAddressRequest interface.
+ */
+export function instanceOfUpdateAddressRequest(value) {
+    return true;
+}
+export function UpdateAddressRequestFromJSON(json) {
+    return UpdateAddressRequestFromJSONTyped(json, false);
+}
+export function UpdateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'attContact': json['attContact'] == null ? undefined : json['attContact'],
+        'address1': json['address1'] == null ? undefined : json['address1'],
+        'address2': json['address2'] == null ? undefined : json['address2'],
+        'zipcode': json['zipcode'] == null ? undefined : json['zipcode'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'phone': json['phone'] == null ? undefined : json['phone'],
+        'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'customs': json['customs'] == null ? undefined : json['customs'],
+        'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
+    };
+}
+export function UpdateAddressRequestToJSON(json) {
+    return UpdateAddressRequestToJSONTyped(json, false);
+}
+export function UpdateAddressRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        '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'],
+    };
+}

package/dist/esm/models/UpdateApiTokenRequest.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 UpdateApiTokenRequest
+ */
+export interface UpdateApiTokenRequest {
+    /**
+     * New token name
+     * @type {string}
+     * @memberof UpdateApiTokenRequest
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the UpdateApiTokenRequest interface.
+ */
+export declare function instanceOfUpdateApiTokenRequest(value: object): value is UpdateApiTokenRequest;
+export declare function UpdateApiTokenRequestFromJSON(json: any): UpdateApiTokenRequest;
+export declare function UpdateApiTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateApiTokenRequest;
+export declare function UpdateApiTokenRequestToJSON(json: any): UpdateApiTokenRequest;
+export declare function UpdateApiTokenRequestToJSONTyped(value?: UpdateApiTokenRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateApiTokenRequest.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 UpdateApiTokenRequest interface.
+ */
+export function instanceOfUpdateApiTokenRequest(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function UpdateApiTokenRequestFromJSON(json) {
+    return UpdateApiTokenRequestFromJSONTyped(json, false);
+}
+export function UpdateApiTokenRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+    };
+}
+export function UpdateApiTokenRequestToJSON(json) {
+    return UpdateApiTokenRequestToJSONTyped(json, false);
+}
+export function UpdateApiTokenRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+    };
+}

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

@@ -0,0 +1,47 @@
+/**
+ * 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 { ListCarriers200ResponseDataInnerConfigValue } from './ListCarriers200ResponseDataInnerConfigValue';
+/**
+ *
+ * @export
+ * @interface UpdateCarrierRequest
+ */
+export interface UpdateCarrierRequest {
+    /**
+     * Carrier display name
+     * @type {string}
+     * @memberof UpdateCarrierRequest
+     */
+    name?: string;
+    /**
+     * Carrier slug identifier
+     * @type {string}
+     * @memberof UpdateCarrierRequest
+     */
+    carrierSlug?: string;
+    /**
+     * Carrier configuration (required and optional fields)
+     * @type {{ [key: string]: ListCarriers200ResponseDataInnerConfigValue; }}
+     * @memberof UpdateCarrierRequest
+     */
+    config?: {
+        [key: string]: ListCarriers200ResponseDataInnerConfigValue;
+    };
+}
+/**
+ * Check if a given object implements the UpdateCarrierRequest interface.
+ */
+export declare function instanceOfUpdateCarrierRequest(value: object): value is UpdateCarrierRequest;
+export declare function UpdateCarrierRequestFromJSON(json: any): UpdateCarrierRequest;
+export declare function UpdateCarrierRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateCarrierRequest;
+export declare function UpdateCarrierRequestToJSON(json: any): UpdateCarrierRequest;
+export declare function UpdateCarrierRequestToJSONTyped(value?: UpdateCarrierRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateCarrierRequest.js

@@ -0,0 +1,47 @@
+/* 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 { ListCarriers200ResponseDataInnerConfigValueFromJSON, ListCarriers200ResponseDataInnerConfigValueToJSON, } from './ListCarriers200ResponseDataInnerConfigValue';
+/**
+ * Check if a given object implements the UpdateCarrierRequest interface.
+ */
+export function instanceOfUpdateCarrierRequest(value) {
+    return true;
+}
+export function UpdateCarrierRequestFromJSON(json) {
+    return UpdateCarrierRequestFromJSONTyped(json, false);
+}
+export function UpdateCarrierRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'carrierSlug': json['carrierSlug'] == null ? undefined : json['carrierSlug'],
+        'config': json['config'] == null ? undefined : (mapValues(json['config'], ListCarriers200ResponseDataInnerConfigValueFromJSON)),
+    };
+}
+export function UpdateCarrierRequestToJSON(json) {
+    return UpdateCarrierRequestToJSONTyped(json, false);
+}
+export function UpdateCarrierRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'carrierSlug': value['carrierSlug'],
+        'config': value['config'] == null ? undefined : (mapValues(value['config'], ListCarriers200ResponseDataInnerConfigValueToJSON)),
+    };
+}

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

@@ -0,0 +1,106 @@
+/**
+ * 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 { CreateOrderRequestOrderLinesInner } from './CreateOrderRequestOrderLinesInner';
+import type { CreateOrderRequestShippingAddress } from './CreateOrderRequestShippingAddress';
+/**
+ *
+ * @export
+ * @interface UpdateOrderRequest
+ */
+export interface UpdateOrderRequest {
+    /**
+     * Human-readable order number.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    orderNumber?: string;
+    /**
+     * Customer full name.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    customerName?: string | null;
+    /**
+     * Customer email address.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    customerEmail?: string | null;
+    /**
+     *
+     * @type {CreateOrderRequestShippingAddress}
+     * @memberof UpdateOrderRequest
+     */
+    shippingAddress?: CreateOrderRequestShippingAddress | null;
+    /**
+     * Line items in the order.
+     * @type {Array<CreateOrderRequestOrderLinesInner>}
+     * @memberof UpdateOrderRequest
+     */
+    orderLines?: Array<CreateOrderRequestOrderLinesInner>;
+    /**
+     * Order subtotal before shipping and tax.
+     * @type {number}
+     * @memberof UpdateOrderRequest
+     */
+    subtotalAmount?: number | null;
+    /**
+     * Order grand total.
+     * @type {number}
+     * @memberof UpdateOrderRequest
+     */
+    totalAmount?: number | null;
+    /**
+     * ISO 4217 currency code.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    currency?: string | null;
+    /**
+     * Free-form internal notes.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    notes?: string | null;
+    /**
+     * Order fulfilment status derived from its shipments.
+     * @type {UpdateOrderRequestStatusEnum}
+     * @memberof UpdateOrderRequest
+     */
+    status?: UpdateOrderRequestStatusEnum;
+    /**
+     * ID of the shipping rule to apply.
+     * @type {string}
+     * @memberof UpdateOrderRequest
+     */
+    shippingRuleId?: string | null;
+}
+/**
+ * @export
+ */
+export declare const UpdateOrderRequestStatusEnum: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly PartiallyFulfilled: "partially_fulfilled";
+    readonly Fulfilled: "fulfilled";
+    readonly Error: "error";
+    readonly Cancelled: "cancelled";
+};
+export type UpdateOrderRequestStatusEnum = typeof UpdateOrderRequestStatusEnum[keyof typeof UpdateOrderRequestStatusEnum];
+/**
+ * Check if a given object implements the UpdateOrderRequest interface.
+ */
+export declare function instanceOfUpdateOrderRequest(value: object): value is UpdateOrderRequest;
+export declare function UpdateOrderRequestFromJSON(json: any): UpdateOrderRequest;
+export declare function UpdateOrderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrderRequest;
+export declare function UpdateOrderRequestToJSON(json: any): UpdateOrderRequest;
+export declare function UpdateOrderRequestToJSONTyped(value?: UpdateOrderRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateOrderRequest.js

@@ -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 { CreateOrderRequestOrderLinesInnerFromJSON, CreateOrderRequestOrderLinesInnerToJSON, } from './CreateOrderRequestOrderLinesInner';
+import { CreateOrderRequestShippingAddressFromJSON, CreateOrderRequestShippingAddressToJSON, } from './CreateOrderRequestShippingAddress';
+/**
+ * @export
+ */
+export const UpdateOrderRequestStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    PartiallyFulfilled: 'partially_fulfilled',
+    Fulfilled: 'fulfilled',
+    Error: 'error',
+    Cancelled: 'cancelled'
+};
+/**
+ * Check if a given object implements the UpdateOrderRequest interface.
+ */
+export function instanceOfUpdateOrderRequest(value) {
+    return true;
+}
+export function UpdateOrderRequestFromJSON(json) {
+    return UpdateOrderRequestFromJSONTyped(json, false);
+}
+export function UpdateOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'orderNumber': json['orderNumber'] == null ? undefined : json['orderNumber'],
+        'customerName': json['customerName'] === undefined ? undefined : json['customerName'] === null ? null : json['customerName'],
+        'customerEmail': json['customerEmail'] === undefined ? undefined : json['customerEmail'] === null ? null : json['customerEmail'],
+        'shippingAddress': json['shippingAddress'] === undefined ? undefined : json['shippingAddress'] === null ? null : CreateOrderRequestShippingAddressFromJSON(json['shippingAddress']),
+        'orderLines': json['orderLines'] == null ? undefined : (json['orderLines'].map(CreateOrderRequestOrderLinesInnerFromJSON)),
+        'subtotalAmount': json['subtotalAmount'] === undefined ? undefined : json['subtotalAmount'] === null ? null : json['subtotalAmount'],
+        'totalAmount': json['totalAmount'] === undefined ? undefined : json['totalAmount'] === null ? null : json['totalAmount'],
+        'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
+        'notes': json['notes'] === undefined ? undefined : json['notes'] === null ? null : json['notes'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
+    };
+}
+export function UpdateOrderRequestToJSON(json) {
+    return UpdateOrderRequestToJSONTyped(json, false);
+}
+export function UpdateOrderRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'orderNumber': value['orderNumber'],
+        'customerName': value['customerName'],
+        'customerEmail': value['customerEmail'],
+        'shippingAddress': CreateOrderRequestShippingAddressToJSON(value['shippingAddress']),
+        'orderLines': value['orderLines'] == null ? undefined : (value['orderLines'].map(CreateOrderRequestOrderLinesInnerToJSON)),
+        'subtotalAmount': value['subtotalAmount'],
+        'totalAmount': value['totalAmount'],
+        'currency': value['currency'],
+        'notes': value['notes'],
+        'status': value['status'],
+        'shippingRuleId': value['shippingRuleId'],
+    };
+}

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

@@ -0,0 +1,124 @@
+/**
+ * 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 UpdateOrg200Response
+ */
+export interface UpdateOrg200Response {
+    /**
+     * Unique organization identifier
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    id: string;
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    name: string;
+    /**
+     * Organization URL slug (unique identifier)
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    slug: string;
+    /**
+     * Organization description
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    description: string | null;
+    /**
+     * Billing currency (ISO 4217 code)
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    currency: string;
+    /**
+     * Company VAT/tax ID for invoices
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    vatNumber?: string | null;
+    /**
+     * Billing email for invoices
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    billingEmail?: string | null;
+    /**
+     * Legal company name
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    companyName?: string | null;
+    /**
+     * Address line 1
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    addressLine1?: string | null;
+    /**
+     * Address line 2
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    addressLine2?: string | null;
+    /**
+     * City
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    city?: string | null;
+    /**
+     * Postal code
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    postalCode?: string | null;
+    /**
+     * Country (ISO 3166-1 alpha-2 code)
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    country?: string | null;
+    /**
+     * Customs identifiers keyed by type
+     * @type {{ [key: string]: string; }}
+     * @memberof UpdateOrg200Response
+     */
+    customs?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * Creation timestamp (ISO 8601)
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp (ISO 8601)
+     * @type {string}
+     * @memberof UpdateOrg200Response
+     */
+    updatedAt: string;
+}
+/**
+ * Check if a given object implements the UpdateOrg200Response interface.
+ */
+export declare function instanceOfUpdateOrg200Response(value: object): value is UpdateOrg200Response;
+export declare function UpdateOrg200ResponseFromJSON(json: any): UpdateOrg200Response;
+export declare function UpdateOrg200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrg200Response;
+export declare function UpdateOrg200ResponseToJSON(json: any): UpdateOrg200Response;
+export declare function UpdateOrg200ResponseToJSONTyped(value?: UpdateOrg200Response | null, ignoreDiscriminator?: boolean): any;