@zippendo/sdk 1.2.3 → 1.2.5

package/dist/esm/models/CreateOrderChannelRequestSettings.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';
+/**
+ *
+ * @export
+ * @interface CreateOrderChannelRequestSettings
+ */
+export interface CreateOrderChannelRequestSettings {
+    /**
+     * Use webhooks for real-time order sync.
+     * @type {boolean}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    useWebhooks?: boolean;
+    /**
+     * WooCommerce store URL.
+     * @type {string}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    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 CreateOrderChannelRequestSettings
+     */
+    autoFulfill?: boolean;
+    /**
+     * Periodically poll the channel for new orders.
+     * @type {boolean}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    autoSync?: boolean;
+    /**
+     * Polling interval in minutes (5-1440).
+     * @type {number}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    syncIntervalMinutes?: number;
+    /**
+     * Create a shipment automatically when an order arrives.
+     * @type {boolean}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    autoShipOnCreate?: boolean;
+    /**
+     * Default carrier ID for auto-shipping.
+     * @type {string}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    defaultCarrierId?: string | null;
+    /**
+     * Default carrier product ID for auto-shipping.
+     * @type {string}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    defaultProductId?: string | null;
+    /**
+     * Default sender address ID for auto-shipping.
+     * @type {string}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    defaultAddressId?: string | null;
+    /**
+     * Map imported shipping-method titles to shipping rules, for channels without checkout rate integration.
+     * @type {Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    shippingMethodMappings?: Array<CreateOrderChannelRequestSettingsShippingMethodMappingsInner>;
+    /**
+     * Only import orders that are not yet fulfilled.
+     * @type {boolean}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    syncOnlyUnfulfilled?: boolean;
+    /**
+     * Only sync orders placed at or after this timestamp.
+     * @type {Date}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    syncOrdersSince?: Date | null;
+    /**
+     * Number of service points to show at checkout (1-20).
+     * @type {number}
+     * @memberof CreateOrderChannelRequestSettings
+     */
+    servicePointCount?: number;
+}
+/**
+ * Check if a given object implements the CreateOrderChannelRequestSettings interface.
+ */
+export declare function instanceOfCreateOrderChannelRequestSettings(value: object): value is CreateOrderChannelRequestSettings;
+export declare function CreateOrderChannelRequestSettingsFromJSON(json: any): CreateOrderChannelRequestSettings;
+export declare function CreateOrderChannelRequestSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderChannelRequestSettings;
+export declare function CreateOrderChannelRequestSettingsToJSON(json: any): CreateOrderChannelRequestSettings;
+export declare function CreateOrderChannelRequestSettingsToJSONTyped(value?: CreateOrderChannelRequestSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateOrderChannelRequestSettings.js

@@ -0,0 +1,66 @@
+/* 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 { CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON, CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON, } from './CreateOrderChannelRequestSettingsShippingMethodMappingsInner';
+/**
+ * Check if a given object implements the CreateOrderChannelRequestSettings interface.
+ */
+export function instanceOfCreateOrderChannelRequestSettings(value) {
+    return true;
+}
+export function CreateOrderChannelRequestSettingsFromJSON(json) {
+    return CreateOrderChannelRequestSettingsFromJSONTyped(json, false);
+}
+export function CreateOrderChannelRequestSettingsFromJSONTyped(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(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'],
+    };
+}
+export function CreateOrderChannelRequestSettingsToJSON(json) {
+    return CreateOrderChannelRequestSettingsToJSONTyped(json, false);
+}
+export function CreateOrderChannelRequestSettingsToJSONTyped(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(CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON)),
+        'syncOnlyUnfulfilled': value['syncOnlyUnfulfilled'],
+        'syncOrdersSince': value['syncOrdersSince'] == null ? value['syncOrdersSince'] : value['syncOrdersSince'].toISOString(),
+        'servicePointCount': value['servicePointCount'],
+    };
+}

package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.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 CreateOrderChannelRequestSettingsShippingMethodMappingsInner
+ */
+export interface CreateOrderChannelRequestSettingsShippingMethodMappingsInner {
+    /**
+     * Shipping-method title to match against imported orders (trimmed, case-insensitive, exact).
+     * @type {string}
+     * @memberof CreateOrderChannelRequestSettingsShippingMethodMappingsInner
+     */
+    match: string;
+    /**
+     * Shipping rule applied to orders whose shipping-method title matches.
+     * @type {string}
+     * @memberof CreateOrderChannelRequestSettingsShippingMethodMappingsInner
+     */
+    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 {CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum}
+     * @memberof CreateOrderChannelRequestSettingsShippingMethodMappingsInner
+     */
+    servicePointSelection?: CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum;
+}
+/**
+ * @export
+ */
+export declare const CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum: {
+    readonly Nearest: "nearest";
+    readonly Manual: "manual";
+};
+export type CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum = typeof CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum[keyof typeof CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum];
+/**
+ * Check if a given object implements the CreateOrderChannelRequestSettingsShippingMethodMappingsInner interface.
+ */
+export declare function instanceOfCreateOrderChannelRequestSettingsShippingMethodMappingsInner(value: object): value is CreateOrderChannelRequestSettingsShippingMethodMappingsInner;
+export declare function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON(json: any): CreateOrderChannelRequestSettingsShippingMethodMappingsInner;
+export declare function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderChannelRequestSettingsShippingMethodMappingsInner;
+export declare function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON(json: any): CreateOrderChannelRequestSettingsShippingMethodMappingsInner;
+export declare function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped(value?: CreateOrderChannelRequestSettingsShippingMethodMappingsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.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 CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum = {
+    Nearest: 'nearest',
+    Manual: 'manual'
+};
+/**
+ * Check if a given object implements the CreateOrderChannelRequestSettingsShippingMethodMappingsInner interface.
+ */
+export function instanceOfCreateOrderChannelRequestSettingsShippingMethodMappingsInner(value) {
+    if (!('match' in value) || value['match'] === undefined)
+        return false;
+    if (!('shippingRuleId' in value) || value['shippingRuleId'] === undefined)
+        return false;
+    return true;
+}
+export function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON(json) {
+    return CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped(json, false);
+}
+export function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'match': json['match'],
+        'shippingRuleId': json['shippingRuleId'],
+        'servicePointSelection': json['servicePointSelection'] == null ? undefined : json['servicePointSelection'],
+    };
+}
+export function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON(json) {
+    return CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped(json, false);
+}
+export function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'match': value['match'],
+        'shippingRuleId': value['shippingRuleId'],
+        'servicePointSelection': value['servicePointSelection'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 CreateOrderChannelWebhookSecret201Response
+ */
+export interface CreateOrderChannelWebhookSecret201Response {
+    /**
+     * The webhook signing secret. Returned only once — store it in your system; every push to the ingest URL must carry an HMAC-SHA256 hex signature of the raw body computed with it.
+     * @type {string}
+     * @memberof CreateOrderChannelWebhookSecret201Response
+     */
+    secret: string;
+    /**
+     * The ingest URL your system pushes signed order events to.
+     * @type {string}
+     * @memberof CreateOrderChannelWebhookSecret201Response
+     */
+    webhookUrl: string;
+    /**
+     * When this secret was issued (ISO 8601).
+     * @type {Date}
+     * @memberof CreateOrderChannelWebhookSecret201Response
+     */
+    createdAt: Date;
+}
+/**
+ * Check if a given object implements the CreateOrderChannelWebhookSecret201Response interface.
+ */
+export declare function instanceOfCreateOrderChannelWebhookSecret201Response(value: object): value is CreateOrderChannelWebhookSecret201Response;
+export declare function CreateOrderChannelWebhookSecret201ResponseFromJSON(json: any): CreateOrderChannelWebhookSecret201Response;
+export declare function CreateOrderChannelWebhookSecret201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderChannelWebhookSecret201Response;
+export declare function CreateOrderChannelWebhookSecret201ResponseToJSON(json: any): CreateOrderChannelWebhookSecret201Response;
+export declare function CreateOrderChannelWebhookSecret201ResponseToJSONTyped(value?: CreateOrderChannelWebhookSecret201Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateOrderChannelWebhookSecret201Response.js

@@ -0,0 +1,51 @@
+/* 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 CreateOrderChannelWebhookSecret201Response interface.
+ */
+export function instanceOfCreateOrderChannelWebhookSecret201Response(value) {
+    if (!('secret' in value) || value['secret'] === undefined)
+        return false;
+    if (!('webhookUrl' in value) || value['webhookUrl'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function CreateOrderChannelWebhookSecret201ResponseFromJSON(json) {
+    return CreateOrderChannelWebhookSecret201ResponseFromJSONTyped(json, false);
+}
+export function CreateOrderChannelWebhookSecret201ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'secret': json['secret'],
+        'webhookUrl': json['webhookUrl'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function CreateOrderChannelWebhookSecret201ResponseToJSON(json) {
+    return CreateOrderChannelWebhookSecret201ResponseToJSONTyped(json, false);
+}
+export function CreateOrderChannelWebhookSecret201ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'secret': value['secret'],
+        'webhookUrl': value['webhookUrl'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

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

@@ -83,6 +83,18 @@ export interface CreateOrderRequest {
      * @memberof CreateOrderRequest
      */
     notes?: string | null;
+    /**
+     * Shipping rule to ship this order with. When set, a shipment is created immediately (and dispatched if the channel has autoShipOnCreate enabled).
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    shippingRuleId?: string | null;
+    /**
+     * Shipping-method title from the source checkout; matched against the order channel's shipping-method mappings to pick a shipping rule.
+     * @type {string}
+     * @memberof CreateOrderRequest
+     */
+    shippingMethodTitle?: string | null;
     /**
      * Raw platform-specific payload for reference.
      * @type {{ [key: string]: any; }}

package/dist/esm/models/CreateOrderRequest.js

@@ -44,6 +44,8 @@ export function CreateOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
         'totalAmount': json['totalAmount'] === undefined ? undefined : json['totalAmount'] === null ? null : json['totalAmount'],
         'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
         'notes': json['notes'] === undefined ? undefined : json['notes'] === null ? null : json['notes'],
+        'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
+        'shippingMethodTitle': json['shippingMethodTitle'] === undefined ? undefined : json['shippingMethodTitle'] === null ? null : json['shippingMethodTitle'],
         'externalData': json['externalData'] === undefined ? undefined : json['externalData'] === null ? null : json['externalData'],
     };
 }
@@ -66,6 +68,8 @@ export function CreateOrderRequestToJSONTyped(value, ignoreDiscriminator = false
         'totalAmount': value['totalAmount'],
         'currency': value['currency'],
         'notes': value['notes'],
+        'shippingRuleId': value['shippingRuleId'],
+        'shippingMethodTitle': value['shippingMethodTitle'],
         'externalData': value['externalData'],
     };
 }

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

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

package/dist/esm/models/GetOrderChannelWebhookStatus200Response.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 { GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON, GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON, } from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
+/**
+ * Check if a given object implements the GetOrderChannelWebhookStatus200Response interface.
+ */
+export function instanceOfGetOrderChannelWebhookStatus200Response(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('webhookUrl' in value) || value['webhookUrl'] === undefined)
+        return false;
+    if (!('webhooks' in value) || value['webhooks'] === undefined)
+        return false;
+    return true;
+}
+export function GetOrderChannelWebhookStatus200ResponseFromJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json, false);
+}
+export function GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'],
+        'webhookUrl': json['webhookUrl'],
+        'webhooks': (json['webhooks'].map(GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON)),
+    };
+}
+export function GetOrderChannelWebhookStatus200ResponseToJSON(json) {
+    return GetOrderChannelWebhookStatus200ResponseToJSONTyped(json, false);
+}
+export function GetOrderChannelWebhookStatus200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'enabled': value['enabled'],
+        'webhookUrl': value['webhookUrl'],
+        'webhooks': (value['webhooks'].map(GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON)),
+    };
+}

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

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