@zippendo/sdk 1.2.4 → 1.2.5

package/dist/models/GetOrderChannelWebhookStatus200Response.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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 { GetOrderChannelWebhookStatus200ResponseWebhooksInner } from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
+/**
+ *
+ * @export
+ * @interface GetOrderChannelWebhookStatus200Response
+ */
+export interface GetOrderChannelWebhookStatus200Response {
+    /**
+     * Whether webhooks are enabled for the channel.
+     * @type {boolean}
+     * @memberof GetOrderChannelWebhookStatus200Response
+     */
+    enabled: boolean;
+    /**
+     * Expected callback URL for this channel.
+     * @type {string}
+     * @memberof GetOrderChannelWebhookStatus200Response
+     */
+    webhookUrl: string;
+    /**
+     * Webhooks registered for this channel's callback URL.
+     * @type {Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>}
+     * @memberof GetOrderChannelWebhookStatus200Response
+     */
+    webhooks: Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>;
+}
+/**
+ * Check if a given object implements the GetOrderChannelWebhookStatus200Response interface.
+ */
+export declare function instanceOfGetOrderChannelWebhookStatus200Response(value: object): value is GetOrderChannelWebhookStatus200Response;
+export declare function GetOrderChannelWebhookStatus200ResponseFromJSON(json: any): GetOrderChannelWebhookStatus200Response;
+export declare function GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrderChannelWebhookStatus200Response;
+export declare function GetOrderChannelWebhookStatus200ResponseToJSON(json: any): GetOrderChannelWebhookStatus200Response;
+export declare function GetOrderChannelWebhookStatus200ResponseToJSONTyped(value?: GetOrderChannelWebhookStatus200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetOrderChannelWebhookStatus200Response.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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.instanceOfGetOrderChannelWebhookStatus200Response = instanceOfGetOrderChannelWebhookStatus200Response;
+exports.GetOrderChannelWebhookStatus200ResponseFromJSON = GetOrderChannelWebhookStatus200ResponseFromJSON;
+exports.GetOrderChannelWebhookStatus200ResponseFromJSONTyped = GetOrderChannelWebhookStatus200ResponseFromJSONTyped;
+exports.GetOrderChannelWebhookStatus200ResponseToJSON = GetOrderChannelWebhookStatus200ResponseToJSON;
+exports.GetOrderChannelWebhookStatus200ResponseToJSONTyped = GetOrderChannelWebhookStatus200ResponseToJSONTyped;
+const GetOrderChannelWebhookStatus200ResponseWebhooksInner_1 = require("./GetOrderChannelWebhookStatus200ResponseWebhooksInner");
+/**
+ * Check if a given object implements the GetOrderChannelWebhookStatus200Response interface.
+ */
+function instanceOfGetOrderChannelWebhookStatus200Response(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('webhookUrl' in value) || value['webhookUrl'] === undefined)
+        return false;
+    if (!('webhooks' in value) || value['webhooks'] === undefined)
+        return false;
+    return true;
+}
+function GetOrderChannelWebhookStatus200ResponseFromJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json, false);
+}
+function GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'],
+        'webhookUrl': json['webhookUrl'],
+        'webhooks': (json['webhooks'].map(GetOrderChannelWebhookStatus200ResponseWebhooksInner_1.GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON)),
+    };
+}
+function GetOrderChannelWebhookStatus200ResponseToJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseToJSONTyped(json, false);
+}
+function GetOrderChannelWebhookStatus200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'webhookUrl': value['webhookUrl'],
+        'webhooks': (value['webhooks'].map(GetOrderChannelWebhookStatus200ResponseWebhooksInner_1.GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON)),
+    };
+}

package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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 GetOrderChannelWebhookStatus200ResponseWebhooksInner
+ */
+export interface GetOrderChannelWebhookStatus200ResponseWebhooksInner {
+    /**
+     * Platform webhook ID.
+     * @type {number}
+     * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
+     */
+    id: number;
+    /**
+     * Webhook event topic.
+     * @type {string}
+     * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
+     */
+    topic: string;
+    /**
+     * Registered callback address.
+     * @type {string}
+     * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
+     */
+    address: string;
+    /**
+     * Webhook creation timestamp.
+     * @type {string}
+     * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
+     */
+    createdAt: string;
+    /**
+     * WooCommerce delivery URL (same as `address`; present for WooCommerce channels).
+     * @type {string}
+     * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
+     */
+    deliveryUrl?: string;
+    /**
+     * WooCommerce webhook status. A value other than `active` means WooCommerce disabled the webhook (e.g. after repeated delivery failures).
+     * @type {string}
+     * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
+     */
+    status?: string;
+}
+/**
+ * Check if a given object implements the GetOrderChannelWebhookStatus200ResponseWebhooksInner interface.
+ */
+export declare function instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner(value: object): value is GetOrderChannelWebhookStatus200ResponseWebhooksInner;
+export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON(json: any): GetOrderChannelWebhookStatus200ResponseWebhooksInner;
+export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrderChannelWebhookStatus200ResponseWebhooksInner;
+export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON(json: any): GetOrderChannelWebhookStatus200ResponseWebhooksInner;
+export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(value?: GetOrderChannelWebhookStatus200ResponseWebhooksInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js

@@ -0,0 +1,66 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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.instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner = instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner;
+exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON = GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON;
+exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped = GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped;
+exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON = GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON;
+exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped = GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped;
+/**
+ * Check if a given object implements the GetOrderChannelWebhookStatus200ResponseWebhooksInner interface.
+ */
+function instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('topic' in value) || value['topic'] === undefined)
+        return false;
+    if (!('address' in value) || value['address'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json, false);
+}
+function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'topic': json['topic'],
+        'address': json['address'],
+        'createdAt': json['createdAt'],
+        'deliveryUrl': json['deliveryUrl'] == null ? undefined : json['deliveryUrl'],
+        'status': json['status'] == null ? undefined : json['status'],
+    };
+}
+function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(json, false);
+}
+function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'topic': value['topic'],
+        'address': value['address'],
+        'createdAt': value['createdAt'],
+        'deliveryUrl': value['deliveryUrl'],
+        'status': value['status'],
+    };
+}

package/dist/models/ListApiTokens401Response.d.ts

@@ -133,6 +133,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     readonly ShippingRuleInvalid: "SHIPPING_RULE_INVALID";
     readonly AddressNotFound: "ADDRESS_NOT_FOUND";
     readonly OrderNotFound: "ORDER_NOT_FOUND";
+    readonly OrderExists: "ORDER_EXISTS";
     readonly OrderChannelNotFound: "ORDER_CHANNEL_NOT_FOUND";
     readonly OrderChannelConfigInvalid: "ORDER_CHANNEL_CONFIG_INVALID";
     readonly IntegrationNotConfigured: "INTEGRATION_NOT_CONFIGURED";

package/dist/models/ListApiTokens401Response.js

@@ -118,6 +118,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
     ShippingRuleInvalid: 'SHIPPING_RULE_INVALID',
     AddressNotFound: 'ADDRESS_NOT_FOUND',
     OrderNotFound: 'ORDER_NOT_FOUND',
+    OrderExists: 'ORDER_EXISTS',
     OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
     OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
     IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',

package/dist/models/ListOrderChannels200Response.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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 { ListOrderChannels200ResponseDataInner } from './ListOrderChannels200ResponseDataInner';
+/**
+ *
+ * @export
+ * @interface ListOrderChannels200Response
+ */
+export interface ListOrderChannels200Response {
+    /**
+     * Page of results
+     * @type {Array<ListOrderChannels200ResponseDataInner>}
+     * @memberof ListOrderChannels200Response
+     */
+    data: Array<ListOrderChannels200ResponseDataInner>;
+    /**
+     * Total matching items across all pages
+     * @type {number}
+     * @memberof ListOrderChannels200Response
+     */
+    total: number;
+    /**
+     * Current page number (1-based)
+     * @type {number}
+     * @memberof ListOrderChannels200Response
+     */
+    page: number;
+    /**
+     * Items per page
+     * @type {number}
+     * @memberof ListOrderChannels200Response
+     */
+    limit: number;
+    /**
+     * Total number of pages
+     * @type {number}
+     * @memberof ListOrderChannels200Response
+     */
+    totalPages: number;
+}
+/**
+ * Check if a given object implements the ListOrderChannels200Response interface.
+ */
+export declare function instanceOfListOrderChannels200Response(value: object): value is ListOrderChannels200Response;
+export declare function ListOrderChannels200ResponseFromJSON(json: any): ListOrderChannels200Response;
+export declare function ListOrderChannels200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrderChannels200Response;
+export declare function ListOrderChannels200ResponseToJSON(json: any): ListOrderChannels200Response;
+export declare function ListOrderChannels200ResponseToJSONTyped(value?: ListOrderChannels200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListOrderChannels200Response.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_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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.instanceOfListOrderChannels200Response = instanceOfListOrderChannels200Response;
+exports.ListOrderChannels200ResponseFromJSON = ListOrderChannels200ResponseFromJSON;
+exports.ListOrderChannels200ResponseFromJSONTyped = ListOrderChannels200ResponseFromJSONTyped;
+exports.ListOrderChannels200ResponseToJSON = ListOrderChannels200ResponseToJSON;
+exports.ListOrderChannels200ResponseToJSONTyped = ListOrderChannels200ResponseToJSONTyped;
+const ListOrderChannels200ResponseDataInner_1 = require("./ListOrderChannels200ResponseDataInner");
+/**
+ * Check if a given object implements the ListOrderChannels200Response interface.
+ */
+function instanceOfListOrderChannels200Response(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 ListOrderChannels200ResponseFromJSON(json) {
+    return ListOrderChannels200ResponseFromJSONTyped(json, false);
+}
+function ListOrderChannels200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ListOrderChannels200ResponseDataInner_1.ListOrderChannels200ResponseDataInnerFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'limit': json['limit'],
+        'totalPages': json['totalPages'],
+    };
+}
+function ListOrderChannels200ResponseToJSON(json) {
+    return ListOrderChannels200ResponseToJSONTyped(json, false);
+}
+function ListOrderChannels200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ListOrderChannels200ResponseDataInner_1.ListOrderChannels200ResponseDataInnerToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'limit': value['limit'],
+        'totalPages': value['totalPages'],
+    };
+}

package/dist/models/ListOrderChannels200ResponseDataInner.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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 { ListOrderChannels200ResponseDataInnerSettings } from './ListOrderChannels200ResponseDataInnerSettings';
+/**
+ *
+ * @export
+ * @interface ListOrderChannels200ResponseDataInner
+ */
+export interface ListOrderChannels200ResponseDataInner {
+    /**
+     * Unique order channel ID.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    id: string;
+    /**
+     * Display name of the channel.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    name: string;
+    /**
+     * Type of the order channel (sales platform).
+     * @type {ListOrderChannels200ResponseDataInnerTypeEnum}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    type: ListOrderChannels200ResponseDataInnerTypeEnum;
+    /**
+     * Whether the channel is active.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    enabled: boolean;
+    /**
+     * Brand this channel belongs to, or null for organization-wide. Orders synced from this channel inherit it, and so do the shipments and documents made from them.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    brandId: string | null;
+    /**
+     * Whether credentials are configured (values are never exposed).
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    hasCredentials: boolean;
+    /**
+     *
+     * @type {ListOrderChannels200ResponseDataInnerSettings}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    settings: ListOrderChannels200ResponseDataInnerSettings;
+    /**
+     * Whether real-time webhooks are enabled.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    webhooksEnabled?: boolean;
+    /**
+     * Timestamp of the last successful sync.
+     * @type {Date}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    lastSyncAt?: Date | null;
+    /**
+     * Error message from the last failed sync.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    lastSyncError?: string | null;
+    /**
+     * IDs of shipping rules linked to this channel.
+     * @type {Array<string>}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    shippingRuleIds?: Array<string>;
+    /**
+     * Owning organization ID.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    orgId: string;
+    /**
+     * Creation timestamp (ISO 8601).
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp (ISO 8601).
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInner
+     */
+    updatedAt: string;
+}
+/**
+ * @export
+ */
+export declare const ListOrderChannels200ResponseDataInnerTypeEnum: {
+    readonly Shopify: "shopify";
+    readonly Woocommerce: "woocommerce";
+    readonly Manual: "manual";
+    readonly Custom: "custom";
+};
+export type ListOrderChannels200ResponseDataInnerTypeEnum = typeof ListOrderChannels200ResponseDataInnerTypeEnum[keyof typeof ListOrderChannels200ResponseDataInnerTypeEnum];
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
+ */
+export declare function instanceOfListOrderChannels200ResponseDataInner(value: object): value is ListOrderChannels200ResponseDataInner;
+export declare function ListOrderChannels200ResponseDataInnerFromJSON(json: any): ListOrderChannels200ResponseDataInner;
+export declare function ListOrderChannels200ResponseDataInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrderChannels200ResponseDataInner;
+export declare function ListOrderChannels200ResponseDataInnerToJSON(json: any): ListOrderChannels200ResponseDataInner;
+export declare function ListOrderChannels200ResponseDataInnerToJSONTyped(value?: ListOrderChannels200ResponseDataInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ListOrderChannels200ResponseDataInner.js

@@ -0,0 +1,105 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * 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.ListOrderChannels200ResponseDataInnerTypeEnum = void 0;
+exports.instanceOfListOrderChannels200ResponseDataInner = instanceOfListOrderChannels200ResponseDataInner;
+exports.ListOrderChannels200ResponseDataInnerFromJSON = ListOrderChannels200ResponseDataInnerFromJSON;
+exports.ListOrderChannels200ResponseDataInnerFromJSONTyped = ListOrderChannels200ResponseDataInnerFromJSONTyped;
+exports.ListOrderChannels200ResponseDataInnerToJSON = ListOrderChannels200ResponseDataInnerToJSON;
+exports.ListOrderChannels200ResponseDataInnerToJSONTyped = ListOrderChannels200ResponseDataInnerToJSONTyped;
+const ListOrderChannels200ResponseDataInnerSettings_1 = require("./ListOrderChannels200ResponseDataInnerSettings");
+/**
+ * @export
+ */
+exports.ListOrderChannels200ResponseDataInnerTypeEnum = {
+    Shopify: 'shopify',
+    Woocommerce: 'woocommerce',
+    Manual: 'manual',
+    Custom: 'custom'
+};
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
+ */
+function instanceOfListOrderChannels200ResponseDataInner(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('brandId' in value) || value['brandId'] === undefined)
+        return false;
+    if (!('hasCredentials' in value) || value['hasCredentials'] === undefined)
+        return false;
+    if (!('settings' in value) || value['settings'] === 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;
+}
+function ListOrderChannels200ResponseDataInnerFromJSON(json) {
+    return ListOrderChannels200ResponseDataInnerFromJSONTyped(json, false);
+}
+function ListOrderChannels200ResponseDataInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'type': json['type'],
+        'enabled': json['enabled'],
+        'brandId': json['brandId'],
+        'hasCredentials': json['hasCredentials'],
+        'settings': (0, ListOrderChannels200ResponseDataInnerSettings_1.ListOrderChannels200ResponseDataInnerSettingsFromJSON)(json['settings']),
+        'webhooksEnabled': json['webhooksEnabled'] == null ? undefined : json['webhooksEnabled'],
+        'lastSyncAt': json['lastSyncAt'] === undefined ? undefined : json['lastSyncAt'] === null ? null : (new Date(json['lastSyncAt'])),
+        'lastSyncError': json['lastSyncError'] === undefined ? undefined : json['lastSyncError'] === null ? null : json['lastSyncError'],
+        'shippingRuleIds': json['shippingRuleIds'] == null ? undefined : json['shippingRuleIds'],
+        'orgId': json['orgId'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+    };
+}
+function ListOrderChannels200ResponseDataInnerToJSON(json) {
+    return ListOrderChannels200ResponseDataInnerToJSONTyped(json, false);
+}
+function ListOrderChannels200ResponseDataInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'type': value['type'],
+        'enabled': value['enabled'],
+        'brandId': value['brandId'],
+        'hasCredentials': value['hasCredentials'],
+        'settings': (0, ListOrderChannels200ResponseDataInnerSettings_1.ListOrderChannels200ResponseDataInnerSettingsToJSON)(value['settings']),
+        'webhooksEnabled': value['webhooksEnabled'],
+        'lastSyncAt': value['lastSyncAt'] == null ? value['lastSyncAt'] : value['lastSyncAt'].toISOString(),
+        'lastSyncError': value['lastSyncError'],
+        'shippingRuleIds': value['shippingRuleIds'],
+        'orgId': value['orgId'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+    };
+}