@zippendo/sdk 1.2.3 → 1.2.5

package/dist/apis/OrderChannelsApi.d.ts

@@ -0,0 +1,195 @@
+/**
+ * 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 * as runtime from '../runtime';
+import { type CreateOrderChannelRequest } from '../models/CreateOrderChannelRequest';
+import { type CreateOrderChannelWebhookSecret201Response } from '../models/CreateOrderChannelWebhookSecret201Response';
+import { type GetOrderChannelWebhookStatus200Response } from '../models/GetOrderChannelWebhookStatus200Response';
+import { type ListOrderChannels200Response } from '../models/ListOrderChannels200Response';
+import { type ListOrderChannels200ResponseDataInner } from '../models/ListOrderChannels200ResponseDataInner';
+import { type RevokeApiToken200Response } from '../models/RevokeApiToken200Response';
+import { type RevokeOrderChannelWebhookSecret200Response } from '../models/RevokeOrderChannelWebhookSecret200Response';
+import { type UpdateOrderChannelRequest } from '../models/UpdateOrderChannelRequest';
+export interface CreateOrderChannelOperationRequest {
+    orgId: string;
+    createOrderChannelRequest: CreateOrderChannelRequest;
+}
+export interface CreateOrderChannelWebhookSecretRequest {
+    orgId: string;
+    channelId: string;
+}
+export interface DeleteOrderChannelRequest {
+    orgId: string;
+    channelId: string;
+}
+export interface GetOrderChannelRequest {
+    orgId: string;
+    channelId: string;
+}
+export interface GetOrderChannelWebhookStatusRequest {
+    orgId: string;
+    channelId: string;
+}
+export interface ListOrderChannelsRequest {
+    orgId: string;
+    page?: number;
+    limit?: number;
+    brandId?: string;
+    brandScope?: ListOrderChannelsBrandScopeEnum;
+    type?: ListOrderChannelsTypeEnum;
+    enabled?: string;
+    search?: string;
+}
+export interface RevokeOrderChannelWebhookSecretRequest {
+    orgId: string;
+    channelId: string;
+}
+export interface UpdateOrderChannelOperationRequest {
+    orgId: string;
+    channelId: string;
+    updateOrderChannelRequest: UpdateOrderChannelRequest;
+}
+/**
+ *
+ */
+export declare class OrderChannelsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createOrderChannel without sending the request
+     */
+    createOrderChannelRequestOpts(requestParameters: CreateOrderChannelOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates a new order channel for an organization.
+     * Create order channel
+     */
+    createOrderChannelRaw(requestParameters: CreateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200ResponseDataInner>>;
+    /**
+     * Creates a new order channel for an organization.
+     * Create order channel
+     */
+    createOrderChannel(requestParameters: CreateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200ResponseDataInner>;
+    /**
+     * Creates request options for createOrderChannelWebhookSecret without sending the request
+     */
+    createOrderChannelWebhookSecretRequestOpts(requestParameters: CreateOrderChannelWebhookSecretRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: CreateOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrderChannelWebhookSecret201Response>>;
+    /**
+     * 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: CreateOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrderChannelWebhookSecret201Response>;
+    /**
+     * Creates request options for deleteOrderChannel without sending the request
+     */
+    deleteOrderChannelRequestOpts(requestParameters: DeleteOrderChannelRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Deletes an order channel and cascades deletion of its orders.
+     * Delete order channel
+     */
+    deleteOrderChannelRaw(requestParameters: DeleteOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RevokeApiToken200Response>>;
+    /**
+     * Deletes an order channel and cascades deletion of its orders.
+     * Delete order channel
+     */
+    deleteOrderChannel(requestParameters: DeleteOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeApiToken200Response>;
+    /**
+     * Creates request options for getOrderChannel without sending the request
+     */
+    getOrderChannelRequestOpts(requestParameters: GetOrderChannelRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a single order channel by ID, including its linked shipping rules.
+     * Get order channel
+     */
+    getOrderChannelRaw(requestParameters: GetOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200ResponseDataInner>>;
+    /**
+     * Returns a single order channel by ID, including its linked shipping rules.
+     * Get order channel
+     */
+    getOrderChannel(requestParameters: GetOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200ResponseDataInner>;
+    /**
+     * Creates request options for getOrderChannelWebhookStatus without sending the request
+     */
+    getOrderChannelWebhookStatusRequestOpts(requestParameters: GetOrderChannelWebhookStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns whether webhooks are enabled and lists the webhooks registered with the platform.
+     * Get channel webhook status
+     */
+    getOrderChannelWebhookStatusRaw(requestParameters: GetOrderChannelWebhookStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrderChannelWebhookStatus200Response>>;
+    /**
+     * Returns whether webhooks are enabled and lists the webhooks registered with the platform.
+     * Get channel webhook status
+     */
+    getOrderChannelWebhookStatus(requestParameters: GetOrderChannelWebhookStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrderChannelWebhookStatus200Response>;
+    /**
+     * Creates request options for listOrderChannels without sending the request
+     */
+    listOrderChannelsRequestOpts(requestParameters: ListOrderChannelsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a paginated list of order channels for an organization.
+     * List order channels
+     */
+    listOrderChannelsRaw(requestParameters: ListOrderChannelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200Response>>;
+    /**
+     * Returns a paginated list of order channels for an organization.
+     * List order channels
+     */
+    listOrderChannels(requestParameters: ListOrderChannelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200Response>;
+    /**
+     * Creates request options for revokeOrderChannelWebhookSecret without sending the request
+     */
+    revokeOrderChannelWebhookSecretRequestOpts(requestParameters: RevokeOrderChannelWebhookSecretRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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: RevokeOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RevokeOrderChannelWebhookSecret200Response>>;
+    /**
+     * 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: RevokeOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeOrderChannelWebhookSecret200Response>;
+    /**
+     * Creates request options for updateOrderChannel without sending the request
+     */
+    updateOrderChannelRequestOpts(requestParameters: UpdateOrderChannelOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an order channel and its linked shipping rules.
+     * Update order channel
+     */
+    updateOrderChannelRaw(requestParameters: UpdateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200ResponseDataInner>>;
+    /**
+     * Updates an order channel and its linked shipping rules.
+     * Update order channel
+     */
+    updateOrderChannel(requestParameters: UpdateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200ResponseDataInner>;
+}
+/**
+ * @export
+ */
+export declare const ListOrderChannelsBrandScopeEnum: {
+    readonly Own: "own";
+    readonly Shared: "shared";
+    readonly Both: "both";
+};
+export type ListOrderChannelsBrandScopeEnum = typeof ListOrderChannelsBrandScopeEnum[keyof typeof ListOrderChannelsBrandScopeEnum];
+/**
+ * @export
+ */
+export declare const ListOrderChannelsTypeEnum: {
+    readonly Shopify: "shopify";
+    readonly Woocommerce: "woocommerce";
+    readonly Manual: "manual";
+    readonly Custom: "custom";
+};
+export type ListOrderChannelsTypeEnum = typeof ListOrderChannelsTypeEnum[keyof typeof ListOrderChannelsTypeEnum];