@zippendo/sdk 1.2.3 → 1.2.5

package/dist/esm/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetOrderChannelWebhookStatus200ResponseWebhooksInner interface.
+ */
+export 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;
+}
+export function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/ListApiTokens401Response.js

@@ -110,6 +110,7 @@ export const 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/esm/models/ListAvailableCarriers200ResponseInner.d.ts

@@ -82,6 +82,18 @@ export interface ListAvailableCarriers200ResponseInner {
      * @memberof ListAvailableCarriers200ResponseInner
      */
     deprecationMessage?: string;
+    /**
+     * Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label.
+     * @type {boolean}
+     * @memberof ListAvailableCarriers200ResponseInner
+     */
+    generatesCustomsDocuments?: boolean;
+    /**
+     * Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents.
+     * @type {boolean}
+     * @memberof ListAvailableCarriers200ResponseInner
+     */
+    generatesCommercialInvoice?: boolean;
 }
 /**
  * Check if a given object implements the ListAvailableCarriers200ResponseInner interface.

package/dist/esm/models/ListAvailableCarriers200ResponseInner.js

@@ -41,6 +41,8 @@ export function ListAvailableCarriers200ResponseInnerFromJSONTyped(json, ignoreD
         'optionalFields': json['optionalFields'] == null ? undefined : (json['optionalFields'].map(ListAvailableCarriers200ResponseInnerRequiredFieldsInnerFromJSON)),
         'deprecated': json['deprecated'] == null ? undefined : json['deprecated'],
         'deprecationMessage': json['deprecationMessage'] == null ? undefined : json['deprecationMessage'],
+        'generatesCustomsDocuments': json['generatesCustomsDocuments'] == null ? undefined : json['generatesCustomsDocuments'],
+        'generatesCommercialInvoice': json['generatesCommercialInvoice'] == null ? undefined : json['generatesCommercialInvoice'],
     };
 }
 export function ListAvailableCarriers200ResponseInnerToJSON(json) {
@@ -62,5 +64,7 @@ export function ListAvailableCarriers200ResponseInnerToJSONTyped(value, ignoreDi
         'optionalFields': value['optionalFields'] == null ? undefined : (value['optionalFields'].map(ListAvailableCarriers200ResponseInnerRequiredFieldsInnerToJSON)),
         'deprecated': value['deprecated'],
         'deprecationMessage': value['deprecationMessage'],
+        'generatesCustomsDocuments': value['generatesCustomsDocuments'],
+        'generatesCommercialInvoice': value['generatesCommercialInvoice'],
     };
 }

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

@@ -90,6 +90,18 @@ export interface ListCarriers200ResponseDataInner {
      * @memberof ListCarriers200ResponseDataInner
      */
     deprecationMessage?: string;
+    /**
+     * Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label.
+     * @type {boolean}
+     * @memberof ListCarriers200ResponseDataInner
+     */
+    generatesCustomsDocuments?: boolean;
+    /**
+     * Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents.
+     * @type {boolean}
+     * @memberof ListCarriers200ResponseDataInner
+     */
+    generatesCommercialInvoice?: boolean;
 }
 /**
  * Check if a given object implements the ListCarriers200ResponseDataInner interface.

package/dist/esm/models/ListCarriers200ResponseDataInner.js

@@ -55,6 +55,8 @@ export function ListCarriers200ResponseDataInnerFromJSONTyped(json, ignoreDiscri
         'brandColor': json['brandColor'] == null ? undefined : json['brandColor'],
         'deprecated': json['deprecated'] == null ? undefined : json['deprecated'],
         'deprecationMessage': json['deprecationMessage'] == null ? undefined : json['deprecationMessage'],
+        'generatesCustomsDocuments': json['generatesCustomsDocuments'] == null ? undefined : json['generatesCustomsDocuments'],
+        'generatesCommercialInvoice': json['generatesCommercialInvoice'] == null ? undefined : json['generatesCommercialInvoice'],
     };
 }
 export function ListCarriers200ResponseDataInnerToJSON(json) {
@@ -77,5 +79,7 @@ export function ListCarriers200ResponseDataInnerToJSONTyped(value, ignoreDiscrim
         'brandColor': value['brandColor'],
         'deprecated': value['deprecated'],
         'deprecationMessage': value['deprecationMessage'],
+        'generatesCustomsDocuments': value['generatesCustomsDocuments'],
+        'generatesCommercialInvoice': value['generatesCommercialInvoice'],
     };
 }

package/dist/esm/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/esm/models/ListOrderChannels200Response.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_).  **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 { ListOrderChannels200ResponseDataInnerFromJSON, ListOrderChannels200ResponseDataInnerToJSON, } from './ListOrderChannels200ResponseDataInner';
+/**
+ * Check if a given object implements the ListOrderChannels200Response interface.
+ */
+export 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;
+}
+export function ListOrderChannels200ResponseFromJSON(json) {
+    return ListOrderChannels200ResponseFromJSONTyped(json, false);
+}
+export function ListOrderChannels200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ListOrderChannels200ResponseDataInnerFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'limit': json['limit'],
+        'totalPages': json['totalPages'],
+    };
+}
+export function ListOrderChannels200ResponseToJSON(json) {
+    return ListOrderChannels200ResponseToJSONTyped(json, false);
+}
+export function ListOrderChannels200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ListOrderChannels200ResponseDataInnerToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'limit': value['limit'],
+        'totalPages': value['totalPages'],
+    };
+}

package/dist/esm/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/esm/models/ListOrderChannels200ResponseDataInner.js

@@ -0,0 +1,97 @@
+/* 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.
+ */
+import { ListOrderChannels200ResponseDataInnerSettingsFromJSON, ListOrderChannels200ResponseDataInnerSettingsToJSON, } from './ListOrderChannels200ResponseDataInnerSettings';
+/**
+ * @export
+ */
+export const ListOrderChannels200ResponseDataInnerTypeEnum = {
+    Shopify: 'shopify',
+    Woocommerce: 'woocommerce',
+    Manual: 'manual',
+    Custom: 'custom'
+};
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInner interface.
+ */
+export 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;
+}
+export function ListOrderChannels200ResponseDataInnerFromJSON(json) {
+    return ListOrderChannels200ResponseDataInnerFromJSONTyped(json, false);
+}
+export 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': 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'],
+    };
+}
+export function ListOrderChannels200ResponseDataInnerToJSON(json) {
+    return ListOrderChannels200ResponseDataInnerToJSONTyped(json, false);
+}
+export 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': 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'],
+    };
+}

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

@@ -0,0 +1,129 @@
+/**
+ * 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 { ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner } from './ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner';
+/**
+ * Channel settings (webhook secret and checkout token hash omitted).
+ * @export
+ * @interface ListOrderChannels200ResponseDataInnerSettings
+ */
+export interface ListOrderChannels200ResponseDataInnerSettings {
+    /**
+     * Use webhooks for real-time order sync.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    useWebhooks: boolean;
+    /**
+     * External webhook identifier for management.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    webhookId?: string | null;
+    /**
+     * Registered WooCommerce webhook ids.
+     * @type {Array<number>}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    webhookIds?: Array<number>;
+    /**
+     * When the custom channel's webhook signing secret was issued. A non-secret signal so clients can show that a secret exists; the secret itself is never returned after creation.
+     * @type {Date}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    webhookSecretCreatedAt?: Date | null;
+    /**
+     * WooCommerce store URL.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    siteUrl?: string;
+    /**
+     * Push tracking back to the platform when a shipment is dispatched. Enabled by default (opt-out) — set to false to disable write-back; an unset value still syncs.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    autoFulfill?: boolean;
+    /**
+     * When the checkout token was issued (internal; never exposed in API responses).
+     * @type {Date}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    checkoutTokenCreatedAt?: Date | null;
+    /**
+     * Periodically poll the channel for new orders.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    autoSync: boolean;
+    /**
+     * Polling interval in minutes (5-1440).
+     * @type {number}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    syncIntervalMinutes: number;
+    /**
+     * Create a shipment automatically when an order arrives.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    autoShipOnCreate: boolean;
+    /**
+     * Default carrier ID for auto-shipping.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    defaultCarrierId?: string | null;
+    /**
+     * Default carrier product ID for auto-shipping.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    defaultProductId?: string | null;
+    /**
+     * Default sender address ID for auto-shipping.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    defaultAddressId?: string | null;
+    /**
+     * Map imported shipping-method titles to shipping rules, for channels without checkout rate integration.
+     * @type {Array<ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner>}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    shippingMethodMappings?: Array<ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner>;
+    /**
+     * Only import orders that are not yet fulfilled.
+     * @type {boolean}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    syncOnlyUnfulfilled: boolean;
+    /**
+     * Only sync orders placed at or after this timestamp.
+     * @type {Date}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    syncOrdersSince?: Date | null;
+    /**
+     * Number of service points to show at checkout (1-20).
+     * @type {number}
+     * @memberof ListOrderChannels200ResponseDataInnerSettings
+     */
+    servicePointCount: number;
+}
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInnerSettings interface.
+ */
+export declare function instanceOfListOrderChannels200ResponseDataInnerSettings(value: object): value is ListOrderChannels200ResponseDataInnerSettings;
+export declare function ListOrderChannels200ResponseDataInnerSettingsFromJSON(json: any): ListOrderChannels200ResponseDataInnerSettings;
+export declare function ListOrderChannels200ResponseDataInnerSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrderChannels200ResponseDataInnerSettings;
+export declare function ListOrderChannels200ResponseDataInnerSettingsToJSON(json: any): ListOrderChannels200ResponseDataInnerSettings;
+export declare function ListOrderChannels200ResponseDataInnerSettingsToJSONTyped(value?: ListOrderChannels200ResponseDataInnerSettings | null, ignoreDiscriminator?: boolean): any;