@zippendo/sdk 1.2.4 → 1.2.6

package/dist/models/RevokeOrderChannelWebhookSecret200Response.js

@@ -0,0 +1,50 @@
+"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.instanceOfRevokeOrderChannelWebhookSecret200Response = instanceOfRevokeOrderChannelWebhookSecret200Response;
+exports.RevokeOrderChannelWebhookSecret200ResponseFromJSON = RevokeOrderChannelWebhookSecret200ResponseFromJSON;
+exports.RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped = RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped;
+exports.RevokeOrderChannelWebhookSecret200ResponseToJSON = RevokeOrderChannelWebhookSecret200ResponseToJSON;
+exports.RevokeOrderChannelWebhookSecret200ResponseToJSONTyped = RevokeOrderChannelWebhookSecret200ResponseToJSONTyped;
+/**
+ * Check if a given object implements the RevokeOrderChannelWebhookSecret200Response interface.
+ */
+function instanceOfRevokeOrderChannelWebhookSecret200Response(value) {
+    if (!('revoked' in value) || value['revoked'] === undefined)
+        return false;
+    return true;
+}
+function RevokeOrderChannelWebhookSecret200ResponseFromJSON(json) {
+    return RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped(json, false);
+}
+function RevokeOrderChannelWebhookSecret200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'revoked': json['revoked'],
+    };
+}
+function RevokeOrderChannelWebhookSecret200ResponseToJSON(json) {
+    return RevokeOrderChannelWebhookSecret200ResponseToJSONTyped(json, false);
+}
+function RevokeOrderChannelWebhookSecret200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'revoked': value['revoked'],
+    };
+}

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

@@ -47,6 +47,9 @@ exports.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',
@@ -119,6 +122,7 @@ exports.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/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/models/UpdateOrderChannelRequest.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.instanceOfUpdateOrderChannelRequest = instanceOfUpdateOrderChannelRequest;
+exports.UpdateOrderChannelRequestFromJSON = UpdateOrderChannelRequestFromJSON;
+exports.UpdateOrderChannelRequestFromJSONTyped = UpdateOrderChannelRequestFromJSONTyped;
+exports.UpdateOrderChannelRequestToJSON = UpdateOrderChannelRequestToJSON;
+exports.UpdateOrderChannelRequestToJSONTyped = UpdateOrderChannelRequestToJSONTyped;
+const UpdateOrderChannelRequestSettings_1 = require("./UpdateOrderChannelRequestSettings");
+/**
+ * Check if a given object implements the UpdateOrderChannelRequest interface.
+ */
+function instanceOfUpdateOrderChannelRequest(value) {
+    return true;
+}
+function UpdateOrderChannelRequestFromJSON(json) {
+    return UpdateOrderChannelRequestFromJSONTyped(json, false);
+}
+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 : (0, UpdateOrderChannelRequestSettings_1.UpdateOrderChannelRequestSettingsFromJSON)(json['settings']),
+        'shippingRuleIds': json['shippingRuleIds'] == null ? undefined : json['shippingRuleIds'],
+    };
+}
+function UpdateOrderChannelRequestToJSON(json) {
+    return UpdateOrderChannelRequestToJSONTyped(json, false);
+}
+function UpdateOrderChannelRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'brandId': value['brandId'],
+        'name': value['name'],
+        'enabled': value['enabled'],
+        'credentials': value['credentials'],
+        'settings': (0, UpdateOrderChannelRequestSettings_1.UpdateOrderChannelRequestSettingsToJSON)(value['settings']),
+        'shippingRuleIds': value['shippingRuleIds'],
+    };
+}

package/dist/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;

package/dist/models/UpdateOrderChannelRequestSettings.js

@@ -0,0 +1,73 @@
+"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.instanceOfUpdateOrderChannelRequestSettings = instanceOfUpdateOrderChannelRequestSettings;
+exports.UpdateOrderChannelRequestSettingsFromJSON = UpdateOrderChannelRequestSettingsFromJSON;
+exports.UpdateOrderChannelRequestSettingsFromJSONTyped = UpdateOrderChannelRequestSettingsFromJSONTyped;
+exports.UpdateOrderChannelRequestSettingsToJSON = UpdateOrderChannelRequestSettingsToJSON;
+exports.UpdateOrderChannelRequestSettingsToJSONTyped = UpdateOrderChannelRequestSettingsToJSONTyped;
+const CreateOrderChannelRequestSettingsShippingMethodMappingsInner_1 = require("./CreateOrderChannelRequestSettingsShippingMethodMappingsInner");
+/**
+ * Check if a given object implements the UpdateOrderChannelRequestSettings interface.
+ */
+function instanceOfUpdateOrderChannelRequestSettings(value) {
+    return true;
+}
+function UpdateOrderChannelRequestSettingsFromJSON(json) {
+    return UpdateOrderChannelRequestSettingsFromJSONTyped(json, false);
+}
+function UpdateOrderChannelRequestSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'useWebhooks': json['useWebhooks'] == null ? undefined : json['useWebhooks'],
+        'siteUrl': json['siteUrl'] == null ? undefined : json['siteUrl'],
+        'autoFulfill': json['autoFulfill'] == null ? undefined : json['autoFulfill'],
+        'autoSync': json['autoSync'] == null ? undefined : json['autoSync'],
+        'syncIntervalMinutes': json['syncIntervalMinutes'] == null ? undefined : json['syncIntervalMinutes'],
+        'autoShipOnCreate': json['autoShipOnCreate'] == null ? undefined : 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(CreateOrderChannelRequestSettingsShippingMethodMappingsInner_1.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON)),
+        'syncOnlyUnfulfilled': json['syncOnlyUnfulfilled'] == null ? undefined : json['syncOnlyUnfulfilled'],
+        'syncOrdersSince': json['syncOrdersSince'] === undefined ? undefined : json['syncOrdersSince'] === null ? null : (new Date(json['syncOrdersSince'])),
+        'servicePointCount': json['servicePointCount'] == null ? undefined : json['servicePointCount'],
+    };
+}
+function UpdateOrderChannelRequestSettingsToJSON(json) {
+    return UpdateOrderChannelRequestSettingsToJSONTyped(json, false);
+}
+function UpdateOrderChannelRequestSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'useWebhooks': value['useWebhooks'],
+        'siteUrl': value['siteUrl'],
+        'autoFulfill': value['autoFulfill'],
+        '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(CreateOrderChannelRequestSettingsShippingMethodMappingsInner_1.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON)),
+        'syncOnlyUnfulfilled': value['syncOnlyUnfulfilled'],
+        'syncOrdersSince': value['syncOrdersSince'] == null ? value['syncOrdersSince'] : value['syncOrdersSince'].toISOString(),
+        'servicePointCount': value['servicePointCount'],
+    };
+}

package/dist/models/UpdateOrgRequest.d.ts

@@ -45,12 +45,6 @@ export interface UpdateOrgRequest {
      * @memberof UpdateOrgRequest
      */
     vatNumber?: string | null;
-    /**
-     * Allow shipments beyond plan limit (overage charges apply)
-     * @type {boolean}
-     * @memberof UpdateOrgRequest
-     */
-    overageEnabled?: boolean;
     /**
      * Billing/contact phone number
      * @type {string}

package/dist/models/UpdateOrgRequest.js

@@ -49,7 +49,6 @@ function UpdateOrgRequestFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'] == null ? undefined : json['description'],
         'currency': json['currency'] == null ? undefined : json['currency'],
         'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
-        'overageEnabled': json['overageEnabled'] == null ? undefined : json['overageEnabled'],
         'phone': json['phone'] === undefined ? undefined : json['phone'] === null ? null : json['phone'],
         'billingEmail': json['billingEmail'] === undefined ? undefined : json['billingEmail'] === null ? null : json['billingEmail'],
         'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
@@ -74,7 +73,6 @@ function UpdateOrgRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'description': value['description'],
         'currency': value['currency'],
         'vatNumber': value['vatNumber'],
-        'overageEnabled': value['overageEnabled'],
         'phone': value['phone'],
         'billingEmail': value['billingEmail'],
         'companyName': value['companyName'],

package/dist/models/index.d.ts

@@ -14,6 +14,10 @@ export * from './CreateApiTokenRequest';
 export * from './CreateOrder201Response';
 export * from './CreateOrder201ResponseOrderLinesInner';
 export * from './CreateOrder201ResponseShippingAddress';
+export * from './CreateOrderChannelRequest';
+export * from './CreateOrderChannelRequestSettings';
+export * from './CreateOrderChannelRequestSettingsShippingMethodMappingsInner';
+export * from './CreateOrderChannelWebhookSecret201Response';
 export * from './CreateOrderRequest';
 export * from './CreateOrderRequestOrderLinesInner';
 export * from './CreateOrderRequestShippingAddress';
@@ -71,6 +75,8 @@ export * from './GetBillingUsage200ResponseZippyMessages';
 export * from './GetOrder200Response';
 export * from './GetOrder200ResponseShipmentsInner';
 export * from './GetOrder200ResponseShippingRule';
+export * from './GetOrderChannelWebhookStatus200Response';
+export * from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
 export * from './GetOrg200Response';
 export * from './GetOrg200ResponseCount';
 export * from './GetOrgBranding200Response';
@@ -94,6 +100,10 @@ export * from './ListCarrierProducts200ResponseInnerWeightLimits';
 export * from './ListCarriers200Response';
 export * from './ListCarriers200ResponseDataInner';
 export * from './ListCarriers200ResponseDataInnerConfigValue';
+export * from './ListOrderChannels200Response';
+export * from './ListOrderChannels200ResponseDataInner';
+export * from './ListOrderChannels200ResponseDataInnerSettings';
+export * from './ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner';
 export * from './ListOrders200Response';
 export * from './ListOrders200ResponseDataInner';
 export * from './ListOrders200ResponseDataInnerOrderChannel';
@@ -122,6 +132,7 @@ export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf4';
 export * from './ListShippingRules200ResponseDataInnerLabelPrinter';
 export * from './ListShippingRules200ResponseDataInnerReturnShippingRule';
 export * from './RevokeApiToken200Response';
+export * from './RevokeOrderChannelWebhookSecret200Response';
 export * from './SendShipment422Response';
 export * from './SendShipment422ResponseErrorsInner';
 export * from './SplitShipment201Response';
@@ -135,6 +146,8 @@ export * from './TrackShipment200ResponseEventsInner';
 export * from './UpdateAddressRequest';
 export * from './UpdateApiTokenRequest';
 export * from './UpdateCarrierRequest';
+export * from './UpdateOrderChannelRequest';
+export * from './UpdateOrderChannelRequestSettings';
 export * from './UpdateOrderRequest';
 export * from './UpdateOrg200Response';
 export * from './UpdateOrgBrandRequest';

package/dist/models/index.js

@@ -32,6 +32,10 @@ __exportStar(require("./CreateApiTokenRequest"), exports);
 __exportStar(require("./CreateOrder201Response"), exports);
 __exportStar(require("./CreateOrder201ResponseOrderLinesInner"), exports);
 __exportStar(require("./CreateOrder201ResponseShippingAddress"), exports);
+__exportStar(require("./CreateOrderChannelRequest"), exports);
+__exportStar(require("./CreateOrderChannelRequestSettings"), exports);
+__exportStar(require("./CreateOrderChannelRequestSettingsShippingMethodMappingsInner"), exports);
+__exportStar(require("./CreateOrderChannelWebhookSecret201Response"), exports);
 __exportStar(require("./CreateOrderRequest"), exports);
 __exportStar(require("./CreateOrderRequestOrderLinesInner"), exports);
 __exportStar(require("./CreateOrderRequestShippingAddress"), exports);
@@ -89,6 +93,8 @@ __exportStar(require("./GetBillingUsage200ResponseZippyMessages"), exports);
 __exportStar(require("./GetOrder200Response"), exports);
 __exportStar(require("./GetOrder200ResponseShipmentsInner"), exports);
 __exportStar(require("./GetOrder200ResponseShippingRule"), exports);
+__exportStar(require("./GetOrderChannelWebhookStatus200Response"), exports);
+__exportStar(require("./GetOrderChannelWebhookStatus200ResponseWebhooksInner"), exports);
 __exportStar(require("./GetOrg200Response"), exports);
 __exportStar(require("./GetOrg200ResponseCount"), exports);
 __exportStar(require("./GetOrgBranding200Response"), exports);
@@ -112,6 +118,10 @@ __exportStar(require("./ListCarrierProducts200ResponseInnerWeightLimits"), expor
 __exportStar(require("./ListCarriers200Response"), exports);
 __exportStar(require("./ListCarriers200ResponseDataInner"), exports);
 __exportStar(require("./ListCarriers200ResponseDataInnerConfigValue"), exports);
+__exportStar(require("./ListOrderChannels200Response"), exports);
+__exportStar(require("./ListOrderChannels200ResponseDataInner"), exports);
+__exportStar(require("./ListOrderChannels200ResponseDataInnerSettings"), exports);
+__exportStar(require("./ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner"), exports);
 __exportStar(require("./ListOrders200Response"), exports);
 __exportStar(require("./ListOrders200ResponseDataInner"), exports);
 __exportStar(require("./ListOrders200ResponseDataInnerOrderChannel"), exports);
@@ -140,6 +150,7 @@ __exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneO
 __exportStar(require("./ListShippingRules200ResponseDataInnerLabelPrinter"), exports);
 __exportStar(require("./ListShippingRules200ResponseDataInnerReturnShippingRule"), exports);
 __exportStar(require("./RevokeApiToken200Response"), exports);
+__exportStar(require("./RevokeOrderChannelWebhookSecret200Response"), exports);
 __exportStar(require("./SendShipment422Response"), exports);
 __exportStar(require("./SendShipment422ResponseErrorsInner"), exports);
 __exportStar(require("./SplitShipment201Response"), exports);
@@ -153,6 +164,8 @@ __exportStar(require("./TrackShipment200ResponseEventsInner"), exports);
 __exportStar(require("./UpdateAddressRequest"), exports);
 __exportStar(require("./UpdateApiTokenRequest"), exports);
 __exportStar(require("./UpdateCarrierRequest"), exports);
+__exportStar(require("./UpdateOrderChannelRequest"), exports);
+__exportStar(require("./UpdateOrderChannelRequestSettings"), exports);
 __exportStar(require("./UpdateOrderRequest"), exports);
 __exportStar(require("./UpdateOrg200Response"), exports);
 __exportStar(require("./UpdateOrgBrandRequest"), exports);

package/docs/CreateOrderChannelRequest.md

@@ -0,0 +1,42 @@
+
+# CreateOrderChannelRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`type` | string
+`brandId` | string
+`enabled` | boolean
+`settings` | [CreateOrderChannelRequestSettings](CreateOrderChannelRequestSettings.md)
+
+## Example
+
+```typescript
+import type { CreateOrderChannelRequest } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Anna's webshop,
+  "type": custom,
+  "brandId": brnd_8f3kd92ld0,
+  "enabled": true,
+  "settings": null,
+} satisfies CreateOrderChannelRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateOrderChannelRequestSettings.md

@@ -0,0 +1,58 @@
+
+# CreateOrderChannelRequestSettings
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`useWebhooks` | boolean
+`siteUrl` | string
+`autoFulfill` | boolean
+`autoSync` | boolean
+`syncIntervalMinutes` | number
+`autoShipOnCreate` | boolean
+`defaultCarrierId` | string
+`defaultProductId` | string
+`defaultAddressId` | string
+`shippingMethodMappings` | [Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>](CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md)
+`syncOnlyUnfulfilled` | boolean
+`syncOrdersSince` | Date
+`servicePointCount` | number
+
+## Example
+
+```typescript
+import type { CreateOrderChannelRequestSettings } from '@zippendo/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "useWebhooks": true,
+  "siteUrl": https://butik.dk,
+  "autoFulfill": true,
+  "autoSync": false,
+  "syncIntervalMinutes": 15,
+  "autoShipOnCreate": false,
+  "defaultCarrierId": clz9k2f0a0006abcd1357yzab,
+  "defaultProductId": postnord-home-delivery,
+  "defaultAddressId": clz9k2f0a0005abcd7890uvwx,
+  "shippingMethodMappings": [{"match":"GLS Hjemmelevering","shippingRuleId":"clz9k2f0a0007abcd2468qrst"}],
+  "syncOnlyUnfulfilled": true,
+  "syncOrdersSince": 2026-05-22T00:00Z,
+  "servicePointCount": 6,
+} satisfies CreateOrderChannelRequestSettings
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateOrderChannelRequestSettings
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+