@zippendo/sdk 1.2.4 → 1.2.6

package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettings.js

@@ -0,0 +1,86 @@
+/* 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 { ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSON, ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSON, } from './ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner';
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInnerSettings interface.
+ */
+export function instanceOfListOrderChannels200ResponseDataInnerSettings(value) {
+    if (!('useWebhooks' in value) || value['useWebhooks'] === undefined)
+        return false;
+    if (!('autoSync' in value) || value['autoSync'] === undefined)
+        return false;
+    if (!('syncIntervalMinutes' in value) || value['syncIntervalMinutes'] === undefined)
+        return false;
+    if (!('autoShipOnCreate' in value) || value['autoShipOnCreate'] === undefined)
+        return false;
+    if (!('syncOnlyUnfulfilled' in value) || value['syncOnlyUnfulfilled'] === undefined)
+        return false;
+    if (!('servicePointCount' in value) || value['servicePointCount'] === undefined)
+        return false;
+    return true;
+}
+export function ListOrderChannels200ResponseDataInnerSettingsFromJSON(json) {
+    return ListOrderChannels200ResponseDataInnerSettingsFromJSONTyped(json, false);
+}
+export function ListOrderChannels200ResponseDataInnerSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'useWebhooks': json['useWebhooks'],
+        'webhookId': json['webhookId'] === undefined ? undefined : json['webhookId'] === null ? null : json['webhookId'],
+        'webhookIds': json['webhookIds'] == null ? undefined : json['webhookIds'],
+        'webhookSecretCreatedAt': json['webhookSecretCreatedAt'] === undefined ? undefined : json['webhookSecretCreatedAt'] === null ? null : (new Date(json['webhookSecretCreatedAt'])),
+        'siteUrl': json['siteUrl'] == null ? undefined : json['siteUrl'],
+        'autoFulfill': json['autoFulfill'] == null ? undefined : json['autoFulfill'],
+        'checkoutTokenCreatedAt': json['checkoutTokenCreatedAt'] === undefined ? undefined : json['checkoutTokenCreatedAt'] === null ? null : (new Date(json['checkoutTokenCreatedAt'])),
+        'autoSync': json['autoSync'],
+        'syncIntervalMinutes': json['syncIntervalMinutes'],
+        'autoShipOnCreate': json['autoShipOnCreate'],
+        'defaultCarrierId': json['defaultCarrierId'] === undefined ? undefined : json['defaultCarrierId'] === null ? null : json['defaultCarrierId'],
+        'defaultProductId': json['defaultProductId'] === undefined ? undefined : json['defaultProductId'] === null ? null : json['defaultProductId'],
+        'defaultAddressId': json['defaultAddressId'] === undefined ? undefined : json['defaultAddressId'] === null ? null : json['defaultAddressId'],
+        'shippingMethodMappings': json['shippingMethodMappings'] == null ? undefined : (json['shippingMethodMappings'].map(ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSON)),
+        'syncOnlyUnfulfilled': json['syncOnlyUnfulfilled'],
+        'syncOrdersSince': json['syncOrdersSince'] === undefined ? undefined : json['syncOrdersSince'] === null ? null : (new Date(json['syncOrdersSince'])),
+        'servicePointCount': json['servicePointCount'],
+    };
+}
+export function ListOrderChannels200ResponseDataInnerSettingsToJSON(json) {
+    return ListOrderChannels200ResponseDataInnerSettingsToJSONTyped(json, false);
+}
+export function ListOrderChannels200ResponseDataInnerSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'useWebhooks': value['useWebhooks'],
+        'webhookId': value['webhookId'],
+        'webhookIds': value['webhookIds'],
+        'webhookSecretCreatedAt': value['webhookSecretCreatedAt'] == null ? value['webhookSecretCreatedAt'] : value['webhookSecretCreatedAt'].toISOString(),
+        'siteUrl': value['siteUrl'],
+        'autoFulfill': value['autoFulfill'],
+        'checkoutTokenCreatedAt': value['checkoutTokenCreatedAt'] == null ? value['checkoutTokenCreatedAt'] : value['checkoutTokenCreatedAt'].toISOString(),
+        'autoSync': value['autoSync'],
+        'syncIntervalMinutes': value['syncIntervalMinutes'],
+        'autoShipOnCreate': value['autoShipOnCreate'],
+        'defaultCarrierId': value['defaultCarrierId'],
+        'defaultProductId': value['defaultProductId'],
+        'defaultAddressId': value['defaultAddressId'],
+        'shippingMethodMappings': value['shippingMethodMappings'] == null ? undefined : (value['shippingMethodMappings'].map(ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSON)),
+        'syncOnlyUnfulfilled': value['syncOnlyUnfulfilled'],
+        'syncOrdersSince': value['syncOrdersSince'] == null ? value['syncOrdersSince'] : value['syncOrdersSince'].toISOString(),
+        'servicePointCount': value['servicePointCount'],
+    };
+}

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

@@ -0,0 +1,52 @@
+/**
+ * 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 ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+ */
+export interface ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner {
+    /**
+     * Shipping-method title to match against imported orders (trimmed, case-insensitive, exact).
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+     */
+    match: string;
+    /**
+     * Shipping rule applied to orders whose shipping-method title matches.
+     * @type {string}
+     * @memberof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+     */
+    shippingRuleId: string;
+    /**
+     * For rules whose product delivers to a service point: 'nearest' auto-selects the closest point to the recipient address; 'manual' keeps the shipment in draft for manual selection.
+     * @type {ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
+     * @memberof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner
+     */
+    servicePointSelection?: ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum;
+}
+/**
+ * @export
+ */
+export declare const ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum: {
+    readonly Nearest: "nearest";
+    readonly Manual: "manual";
+};
+export type ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum = typeof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum[keyof typeof ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum];
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner interface.
+ */
+export declare function instanceOfListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner(value: object): value is ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner;
+export declare function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSON(json: any): ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner;
+export declare function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner;
+export declare function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSON(json: any): ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner;
+export declare function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSONTyped(value?: ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.js

@@ -0,0 +1,56 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerServicePointSelectionEnum = {
+    Nearest: 'nearest',
+    Manual: 'manual'
+};
+/**
+ * Check if a given object implements the ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner interface.
+ */
+export function instanceOfListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner(value) {
+    if (!('match' in value) || value['match'] === undefined)
+        return false;
+    if (!('shippingRuleId' in value) || value['shippingRuleId'] === undefined)
+        return false;
+    return true;
+}
+export function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSON(json) {
+    return ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSONTyped(json, false);
+}
+export function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'match': json['match'],
+        'shippingRuleId': json['shippingRuleId'],
+        'servicePointSelection': json['servicePointSelection'] == null ? undefined : json['servicePointSelection'],
+    };
+}
+export function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSON(json) {
+    return ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSONTyped(json, false);
+}
+export function ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'match': value['match'],
+        'shippingRuleId': value['shippingRuleId'],
+        'servicePointSelection': value['servicePointSelection'],
+    };
+}

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

@@ -41,6 +41,7 @@ export declare const ListOrders200ResponseDataInnerOrderChannelTypeEnum: {
     readonly Shopify: "shopify";
     readonly Woocommerce: "woocommerce";
     readonly Manual: "manual";
+    readonly Custom: "custom";
 };
 export type ListOrders200ResponseDataInnerOrderChannelTypeEnum = typeof ListOrders200ResponseDataInnerOrderChannelTypeEnum[keyof typeof ListOrders200ResponseDataInnerOrderChannelTypeEnum];
 /**

package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.js

@@ -17,7 +17,8 @@
 export const ListOrders200ResponseDataInnerOrderChannelTypeEnum = {
     Shopify: 'shopify',
     Woocommerce: 'woocommerce',
-    Manual: 'manual'
+    Manual: 'manual',
+    Custom: 'custom'
 };
 /**
  * Check if a given object implements the ListOrders200ResponseDataInnerOrderChannel interface.

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

@@ -0,0 +1,32 @@
+/**
+ * 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 RevokeOrderChannelWebhookSecret200Response
+ */
+export interface RevokeOrderChannelWebhookSecret200Response {
+    /**
+     * Whether the signing secret was revoked.
+     * @type {boolean}
+     * @memberof RevokeOrderChannelWebhookSecret200Response
+     */
+    revoked: boolean;
+}
+/**
+ * Check if a given object implements the RevokeOrderChannelWebhookSecret200Response interface.
+ */
+export declare function instanceOfRevokeOrderChannelWebhookSecret200Response(value: object): value is RevokeOrderChannelWebhookSecret200Response;
+export declare function RevokeOrderChannelWebhookSecret200ResponseFromJSON(json: any): RevokeOrderChannelWebhookSecret200Response;
+export declare function RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RevokeOrderChannelWebhookSecret200Response;
+export declare function RevokeOrderChannelWebhookSecret200ResponseToJSON(json: any): RevokeOrderChannelWebhookSecret200Response;
+export declare function RevokeOrderChannelWebhookSecret200ResponseToJSONTyped(value?: RevokeOrderChannelWebhookSecret200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RevokeOrderChannelWebhookSecret200Response.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_).  **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 RevokeOrderChannelWebhookSecret200Response interface.
+ */
+export function instanceOfRevokeOrderChannelWebhookSecret200Response(value) {
+    if (!('revoked' in value) || value['revoked'] === undefined)
+        return false;
+    return true;
+}
+export function RevokeOrderChannelWebhookSecret200ResponseFromJSON(json) {
+    return RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped(json, false);
+}
+export function RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'revoked': json['revoked'],
+    };
+}
+export function RevokeOrderChannelWebhookSecret200ResponseToJSON(json) {
+    return RevokeOrderChannelWebhookSecret200ResponseToJSONTyped(json, false);
+}
+export function RevokeOrderChannelWebhookSecret200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'revoked': value['revoked'],
+    };
+}

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

@@ -68,6 +68,9 @@ export declare const SendShipment422ResponseCodeEnum: {
     readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
     readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
     readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
+    readonly CaptchaFailed: "CAPTCHA_FAILED";
+    readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
+    readonly VatInvalid: "VAT_INVALID";
     readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
     readonly SessionRequired: "SESSION_REQUIRED";
     readonly OrgNotFound: "ORG_NOT_FOUND";
@@ -140,6 +143,7 @@ export declare const SendShipment422ResponseCodeEnum: {
     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/SendShipment422Response.js

@@ -39,6 +39,9 @@ export const SendShipment422ResponseCodeEnum = {
     AuthMfaRequired: 'AUTH_MFA_REQUIRED',
     AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
     AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
+    CaptchaFailed: 'CAPTCHA_FAILED',
+    EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
+    VatInvalid: 'VAT_INVALID',
     AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
     SessionRequired: 'SESSION_REQUIRED',
     OrgNotFound: 'ORG_NOT_FOUND',
@@ -111,6 +114,7 @@ export const SendShipment422ResponseCodeEnum = {
     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/UpdateOrderChannelRequest.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { UpdateOrderChannelRequestSettings } from './UpdateOrderChannelRequestSettings';
+/**
+ *
+ * @export
+ * @interface UpdateOrderChannelRequest
+ */
+export interface UpdateOrderChannelRequest {
+    /**
+     * Brand this channel belongs to; null for organization-wide
+     * @type {string}
+     * @memberof UpdateOrderChannelRequest
+     */
+    brandId?: string | null;
+    /**
+     * Display name for the channel.
+     * @type {string}
+     * @memberof UpdateOrderChannelRequest
+     */
+    name?: string;
+    /**
+     * Whether the channel is active.
+     * @type {boolean}
+     * @memberof UpdateOrderChannelRequest
+     */
+    enabled?: boolean;
+    /**
+     * Type-specific platform credentials.
+     * @type {{ [key: string]: any; }}
+     * @memberof UpdateOrderChannelRequest
+     */
+    credentials?: {
+        [key: string]: any;
+    } | null;
+    /**
+     *
+     * @type {UpdateOrderChannelRequestSettings}
+     * @memberof UpdateOrderChannelRequest
+     */
+    settings?: UpdateOrderChannelRequestSettings;
+    /**
+     * IDs of shipping rules linked to this channel.
+     * @type {Array<string>}
+     * @memberof UpdateOrderChannelRequest
+     */
+    shippingRuleIds?: Array<string>;
+}
+/**
+ * Check if a given object implements the UpdateOrderChannelRequest interface.
+ */
+export declare function instanceOfUpdateOrderChannelRequest(value: object): value is UpdateOrderChannelRequest;
+export declare function UpdateOrderChannelRequestFromJSON(json: any): UpdateOrderChannelRequest;
+export declare function UpdateOrderChannelRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrderChannelRequest;
+export declare function UpdateOrderChannelRequestToJSON(json: any): UpdateOrderChannelRequest;
+export declare function UpdateOrderChannelRequestToJSONTyped(value?: UpdateOrderChannelRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateOrderChannelRequest.js

@@ -0,0 +1,52 @@
+/* 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 { UpdateOrderChannelRequestSettingsFromJSON, UpdateOrderChannelRequestSettingsToJSON, } from './UpdateOrderChannelRequestSettings';
+/**
+ * Check if a given object implements the UpdateOrderChannelRequest interface.
+ */
+export function instanceOfUpdateOrderChannelRequest(value) {
+    return true;
+}
+export function UpdateOrderChannelRequestFromJSON(json) {
+    return UpdateOrderChannelRequestFromJSONTyped(json, false);
+}
+export function UpdateOrderChannelRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'brandId': json['brandId'] === undefined ? undefined : json['brandId'] === null ? null : json['brandId'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'enabled': json['enabled'] == null ? undefined : json['enabled'],
+        'credentials': json['credentials'] === undefined ? undefined : json['credentials'] === null ? null : json['credentials'],
+        'settings': json['settings'] == null ? undefined : UpdateOrderChannelRequestSettingsFromJSON(json['settings']),
+        'shippingRuleIds': json['shippingRuleIds'] == null ? undefined : json['shippingRuleIds'],
+    };
+}
+export function UpdateOrderChannelRequestToJSON(json) {
+    return UpdateOrderChannelRequestToJSONTyped(json, false);
+}
+export function UpdateOrderChannelRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'brandId': value['brandId'],
+        'name': value['name'],
+        'enabled': value['enabled'],
+        'credentials': value['credentials'],
+        'settings': UpdateOrderChannelRequestSettingsToJSON(value['settings']),
+        'shippingRuleIds': value['shippingRuleIds'],
+    };
+}

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

@@ -0,0 +1,105 @@
+/**
+ * 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 { CreateOrderChannelRequestSettingsShippingMethodMappingsInner } from './CreateOrderChannelRequestSettingsShippingMethodMappingsInner';
+/**
+ * Partial channel settings to merge into existing settings. Server-managed fields (webhook secret/ids, checkout token) cannot be set here.
+ * @export
+ * @interface UpdateOrderChannelRequestSettings
+ */
+export interface UpdateOrderChannelRequestSettings {
+    /**
+     * Use webhooks for real-time order sync.
+     * @type {boolean}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    useWebhooks?: boolean;
+    /**
+     * WooCommerce store URL.
+     * @type {string}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    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 UpdateOrderChannelRequestSettings
+     */
+    autoFulfill?: boolean;
+    /**
+     * Periodically poll the channel for new orders.
+     * @type {boolean}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    autoSync?: boolean;
+    /**
+     * Polling interval in minutes (5-1440).
+     * @type {number}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    syncIntervalMinutes?: number;
+    /**
+     * Create a shipment automatically when an order arrives.
+     * @type {boolean}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    autoShipOnCreate?: boolean;
+    /**
+     * Default carrier ID for auto-shipping.
+     * @type {string}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    defaultCarrierId?: string | null;
+    /**
+     * Default carrier product ID for auto-shipping.
+     * @type {string}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    defaultProductId?: string | null;
+    /**
+     * Default sender address ID for auto-shipping.
+     * @type {string}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    defaultAddressId?: string | null;
+    /**
+     * Map imported shipping-method titles to shipping rules, for channels without checkout rate integration.
+     * @type {Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    shippingMethodMappings?: Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>;
+    /**
+     * Only import orders that are not yet fulfilled.
+     * @type {boolean}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    syncOnlyUnfulfilled?: boolean;
+    /**
+     * Only sync orders placed at or after this timestamp.
+     * @type {Date}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    syncOrdersSince?: Date | null;
+    /**
+     * Number of service points to show at checkout (1-20).
+     * @type {number}
+     * @memberof UpdateOrderChannelRequestSettings
+     */
+    servicePointCount?: number;
+}
+/**
+ * Check if a given object implements the UpdateOrderChannelRequestSettings interface.
+ */
+export declare function instanceOfUpdateOrderChannelRequestSettings(value: object): value is UpdateOrderChannelRequestSettings;
+export declare function UpdateOrderChannelRequestSettingsFromJSON(json: any): UpdateOrderChannelRequestSettings;
+export declare function UpdateOrderChannelRequestSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrderChannelRequestSettings;
+export declare function UpdateOrderChannelRequestSettingsToJSON(json: any): UpdateOrderChannelRequestSettings;
+export declare function UpdateOrderChannelRequestSettingsToJSONTyped(value?: UpdateOrderChannelRequestSettings | null, ignoreDiscriminator?: boolean): any;