@zippendo/sdk 1.2.3 → 1.2.5

package/src/models/UpdateOrderChannelRequestSettings.ts

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

package/src/models/index.ts

@@ -16,6 +16,10 @@ export * from './CreateApiTokenRequest';
 export * from './CreateOrder201Response';
 export * from './CreateOrder201ResponseOrderLinesInner';
 export * from './CreateOrder201ResponseShippingAddress';
+export * from './CreateOrderChannelRequest';
+export * from './CreateOrderChannelRequestSettings';
+export * from './CreateOrderChannelRequestSettingsShippingMethodMappingsInner';
+export * from './CreateOrderChannelWebhookSecret201Response';
 export * from './CreateOrderRequest';
 export * from './CreateOrderRequestOrderLinesInner';
 export * from './CreateOrderRequestShippingAddress';
@@ -73,6 +77,8 @@ export * from './GetBillingUsage200ResponseZippyMessages';
 export * from './GetOrder200Response';
 export * from './GetOrder200ResponseShipmentsInner';
 export * from './GetOrder200ResponseShippingRule';
+export * from './GetOrderChannelWebhookStatus200Response';
+export * from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
 export * from './GetOrg200Response';
 export * from './GetOrg200ResponseCount';
 export * from './GetOrgBranding200Response';
@@ -96,6 +102,10 @@ export * from './ListCarrierProducts200ResponseInnerWeightLimits';
 export * from './ListCarriers200Response';
 export * from './ListCarriers200ResponseDataInner';
 export * from './ListCarriers200ResponseDataInnerConfigValue';
+export * from './ListOrderChannels200Response';
+export * from './ListOrderChannels200ResponseDataInner';
+export * from './ListOrderChannels200ResponseDataInnerSettings';
+export * from './ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner';
 export * from './ListOrders200Response';
 export * from './ListOrders200ResponseDataInner';
 export * from './ListOrders200ResponseDataInnerOrderChannel';
@@ -124,6 +134,7 @@ export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf4';
 export * from './ListShippingRules200ResponseDataInnerLabelPrinter';
 export * from './ListShippingRules200ResponseDataInnerReturnShippingRule';
 export * from './RevokeApiToken200Response';
+export * from './RevokeOrderChannelWebhookSecret200Response';
 export * from './SendShipment422Response';
 export * from './SendShipment422ResponseErrorsInner';
 export * from './SplitShipment201Response';
@@ -137,6 +148,8 @@ export * from './TrackShipment200ResponseEventsInner';
 export * from './UpdateAddressRequest';
 export * from './UpdateApiTokenRequest';
 export * from './UpdateCarrierRequest';
+export * from './UpdateOrderChannelRequest';
+export * from './UpdateOrderChannelRequestSettings';
 export * from './UpdateOrderRequest';
 export * from './UpdateOrg200Response';
 export * from './UpdateOrgBrandRequest';