@zippendo/sdk 1.2.4 → 1.2.6

package/dist/esm/apis/OrderChannelsApi.js

@@ -0,0 +1,492 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateOrderChannelRequestToJSON, } from '../models/CreateOrderChannelRequest';
+import { CreateOrderChannelWebhookSecret201ResponseFromJSON, } from '../models/CreateOrderChannelWebhookSecret201Response';
+import { GetOrderChannelWebhookStatus200ResponseFromJSON, } from '../models/GetOrderChannelWebhookStatus200Response';
+import { ListOrderChannels200ResponseFromJSON, } from '../models/ListOrderChannels200Response';
+import { ListOrderChannels200ResponseDataInnerFromJSON, } from '../models/ListOrderChannels200ResponseDataInner';
+import { RevokeApiToken200ResponseFromJSON, } from '../models/RevokeApiToken200Response';
+import { RevokeOrderChannelWebhookSecret200ResponseFromJSON, } from '../models/RevokeOrderChannelWebhookSecret200Response';
+import { UpdateOrderChannelRequestToJSON, } from '../models/UpdateOrderChannelRequest';
+/**
+ *
+ */
+export class OrderChannelsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createOrderChannel without sending the request
+     */
+    createOrderChannelRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling createOrderChannel().');
+            }
+            if (requestParameters['createOrderChannelRequest'] == null) {
+                throw new runtime.RequiredError('createOrderChannelRequest', 'Required parameter "createOrderChannelRequest" was null or undefined when calling createOrderChannel().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateOrderChannelRequestToJSON(requestParameters['createOrderChannelRequest']),
+            };
+        });
+    }
+    /**
+     * Creates a new order channel for an organization.
+     * Create order channel
+     */
+    createOrderChannelRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createOrderChannelRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseDataInnerFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a new order channel for an organization.
+     * Create order channel
+     */
+    createOrderChannel(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createOrderChannelRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for createOrderChannelWebhookSecret without sending the request
+     */
+    createOrderChannelWebhookSecretRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling createOrderChannelWebhookSecret().');
+            }
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling createOrderChannelWebhookSecret().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels/{channelId}/webhook-secret`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Generates (or rotates) the custom channel\'s webhook signing secret used to authenticate order pushes to the ingest URL. The secret is returned only once. Rotating invalidates the previous secret immediately.
+     * Create or rotate webhook signing secret
+     */
+    createOrderChannelWebhookSecretRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createOrderChannelWebhookSecretRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => CreateOrderChannelWebhookSecret201ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates (or rotates) the custom channel\'s webhook signing secret used to authenticate order pushes to the ingest URL. The secret is returned only once. Rotating invalidates the previous secret immediately.
+     * Create or rotate webhook signing secret
+     */
+    createOrderChannelWebhookSecret(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createOrderChannelWebhookSecretRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteOrderChannel without sending the request
+     */
+    deleteOrderChannelRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling deleteOrderChannel().');
+            }
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling deleteOrderChannel().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels/{channelId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes an order channel and cascades deletion of its orders.
+     * Delete order channel
+     */
+    deleteOrderChannelRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteOrderChannelRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => RevokeApiToken200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Deletes an order channel and cascades deletion of its orders.
+     * Delete order channel
+     */
+    deleteOrderChannel(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteOrderChannelRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getOrderChannel without sending the request
+     */
+    getOrderChannelRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling getOrderChannel().');
+            }
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling getOrderChannel().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels/{channelId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a single order channel by ID, including its linked shipping rules.
+     * Get order channel
+     */
+    getOrderChannelRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOrderChannelRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseDataInnerFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a single order channel by ID, including its linked shipping rules.
+     * Get order channel
+     */
+    getOrderChannel(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getOrderChannelRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getOrderChannelWebhookStatus without sending the request
+     */
+    getOrderChannelWebhookStatusRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling getOrderChannelWebhookStatus().');
+            }
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling getOrderChannelWebhookStatus().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels/{channelId}/webhooks`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns whether webhooks are enabled and lists the webhooks registered with the platform.
+     * Get channel webhook status
+     */
+    getOrderChannelWebhookStatusRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOrderChannelWebhookStatusRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetOrderChannelWebhookStatus200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns whether webhooks are enabled and lists the webhooks registered with the platform.
+     * Get channel webhook status
+     */
+    getOrderChannelWebhookStatus(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getOrderChannelWebhookStatusRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listOrderChannels without sending the request
+     */
+    listOrderChannelsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling listOrderChannels().');
+            }
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['brandId'] != null) {
+                queryParameters['brandId'] = requestParameters['brandId'];
+            }
+            if (requestParameters['brandScope'] != null) {
+                queryParameters['brandScope'] = requestParameters['brandScope'];
+            }
+            if (requestParameters['type'] != null) {
+                queryParameters['type'] = requestParameters['type'];
+            }
+            if (requestParameters['enabled'] != null) {
+                queryParameters['enabled'] = requestParameters['enabled'];
+            }
+            if (requestParameters['search'] != null) {
+                queryParameters['search'] = requestParameters['search'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a paginated list of order channels for an organization.
+     * List order channels
+     */
+    listOrderChannelsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listOrderChannelsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of order channels for an organization.
+     * List order channels
+     */
+    listOrderChannels(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listOrderChannelsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for revokeOrderChannelWebhookSecret without sending the request
+     */
+    revokeOrderChannelWebhookSecretRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling revokeOrderChannelWebhookSecret().');
+            }
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling revokeOrderChannelWebhookSecret().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels/{channelId}/webhook-secret`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Revokes the custom channel\'s webhook signing secret. All subsequent pushes to the ingest URL are rejected until a new secret is generated.
+     * Revoke webhook signing secret
+     */
+    revokeOrderChannelWebhookSecretRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.revokeOrderChannelWebhookSecretRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => RevokeOrderChannelWebhookSecret200ResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Revokes the custom channel\'s webhook signing secret. All subsequent pushes to the ingest URL are rejected until a new secret is generated.
+     * Revoke webhook signing secret
+     */
+    revokeOrderChannelWebhookSecret(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.revokeOrderChannelWebhookSecretRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateOrderChannel without sending the request
+     */
+    updateOrderChannelRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling updateOrderChannel().');
+            }
+            if (requestParameters['channelId'] == null) {
+                throw new runtime.RequiredError('channelId', 'Required parameter "channelId" was null or undefined when calling updateOrderChannel().');
+            }
+            if (requestParameters['updateOrderChannelRequest'] == null) {
+                throw new runtime.RequiredError('updateOrderChannelRequest', 'Required parameter "updateOrderChannelRequest" was null or undefined when calling updateOrderChannel().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/order-channels/{channelId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateOrderChannelRequestToJSON(requestParameters['updateOrderChannelRequest']),
+            };
+        });
+    }
+    /**
+     * Updates an order channel and its linked shipping rules.
+     * Update order channel
+     */
+    updateOrderChannelRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateOrderChannelRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseDataInnerFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates an order channel and its linked shipping rules.
+     * Update order channel
+     */
+    updateOrderChannel(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateOrderChannelRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ListOrderChannelsBrandScopeEnum = {
+    Own: 'own',
+    Shared: 'shared',
+    Both: 'both'
+};
+/**
+ * @export
+ */
+export const ListOrderChannelsTypeEnum = {
+    Shopify: 'shopify',
+    Woocommerce: 'woocommerce',
+    Manual: 'manual',
+    Custom: 'custom'
+};

package/dist/esm/apis/index.d.ts

@@ -3,6 +3,7 @@ export * from './BillingApi';
 export * from './BrandsApi';
 export * from './CarrierCatalogApi';
 export * from './CarriersApi';
+export * from './OrderChannelsApi';
 export * from './OrdersApi';
 export * from './OrgsApi';
 export * from './QuotesApi';

package/dist/esm/apis/index.js

@@ -5,6 +5,7 @@ export * from './BillingApi';
 export * from './BrandsApi';
 export * from './CarrierCatalogApi';
 export * from './CarriersApi';
+export * from './OrderChannelsApi';
 export * from './OrdersApi';
 export * from './OrgsApi';
 export * from './QuotesApi';

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

@@ -83,6 +83,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     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";
@@ -155,6 +158,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     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/BatchSendShipments200ResponseResultsInner.js

@@ -47,6 +47,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     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 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     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/CreateOrderChannelRequest.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 { CreateOrderChannelRequestSettings } from './CreateOrderChannelRequestSettings';
+/**
+ *
+ * @export
+ * @interface CreateOrderChannelRequest
+ */
+export interface CreateOrderChannelRequest {
+    /**
+     * Display name for the channel.
+     * @type {string}
+     * @memberof CreateOrderChannelRequest
+     */
+    name: string;
+    /**
+     * Type of the order channel. Platform channels (Shopify, WooCommerce) are created via their connect flows.
+     * @type {CreateOrderChannelRequestTypeEnum}
+     * @memberof CreateOrderChannelRequest
+     */
+    type: CreateOrderChannelRequestTypeEnum;
+    /**
+     * Brand this channel belongs to; null for organization-wide
+     * @type {string}
+     * @memberof CreateOrderChannelRequest
+     */
+    brandId?: string | null;
+    /**
+     * Whether the channel is active.
+     * @type {boolean}
+     * @memberof CreateOrderChannelRequest
+     */
+    enabled?: boolean;
+    /**
+     *
+     * @type {CreateOrderChannelRequestSettings}
+     * @memberof CreateOrderChannelRequest
+     */
+    settings?: CreateOrderChannelRequestSettings;
+}
+/**
+ * @export
+ */
+export declare const CreateOrderChannelRequestTypeEnum: {
+    readonly Manual: "manual";
+    readonly Custom: "custom";
+};
+export type CreateOrderChannelRequestTypeEnum = typeof CreateOrderChannelRequestTypeEnum[keyof typeof CreateOrderChannelRequestTypeEnum];
+/**
+ * Check if a given object implements the CreateOrderChannelRequest interface.
+ */
+export declare function instanceOfCreateOrderChannelRequest(value: object): value is CreateOrderChannelRequest;
+export declare function CreateOrderChannelRequestFromJSON(json: any): CreateOrderChannelRequest;
+export declare function CreateOrderChannelRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderChannelRequest;
+export declare function CreateOrderChannelRequestToJSON(json: any): CreateOrderChannelRequest;
+export declare function CreateOrderChannelRequestToJSONTyped(value?: CreateOrderChannelRequest | null, ignoreDiscriminator?: boolean): any;