@wix/auto_sdk_ecom_orders-settings 1.0.0

package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.d.ts

@@ -0,0 +1,14 @@
+import * as ambassadorWixEcomV1OrdersSettingsTypes from './ecom-v1-orders-settings-orders-settings.types.js';
+import * as ambassadorWixEcomV1OrdersSettingsUniversalTypes from './ecom-v1-orders-settings-orders-settings.universal.js';
+export type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+export declare function getOrdersSettings(): __PublicMethodMetaInfo<'GET', {}, ambassadorWixEcomV1OrdersSettingsUniversalTypes.GetOrdersSettingsRequest, ambassadorWixEcomV1OrdersSettingsTypes.GetOrdersSettingsRequest, ambassadorWixEcomV1OrdersSettingsUniversalTypes.GetOrdersSettingsResponse & ambassadorWixEcomV1OrdersSettingsUniversalTypes.GetOrdersSettingsResponseNonNullableFields, ambassadorWixEcomV1OrdersSettingsTypes.GetOrdersSettingsResponse & ambassadorWixEcomV1OrdersSettingsTypes.GetOrdersSettingsResponseNonNullableFields>;
+export declare function updateOrdersSettings(): __PublicMethodMetaInfo<'PATCH', {}, ambassadorWixEcomV1OrdersSettingsUniversalTypes.UpdateOrdersSettingsRequest, ambassadorWixEcomV1OrdersSettingsTypes.UpdateOrdersSettingsRequest, ambassadorWixEcomV1OrdersSettingsUniversalTypes.UpdateOrdersSettingsResponse & ambassadorWixEcomV1OrdersSettingsUniversalTypes.UpdateOrdersSettingsResponseNonNullableFields, ambassadorWixEcomV1OrdersSettingsTypes.UpdateOrdersSettingsResponse & ambassadorWixEcomV1OrdersSettingsTypes.UpdateOrdersSettingsResponseNonNullableFields>;

package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.js

@@ -0,0 +1,38 @@
+import * as ambassadorWixEcomV1OrdersSettings from './ecom-v1-orders-settings-orders-settings.http.js';
+export function getOrdersSettings() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixEcomV1OrdersSettings.getOrdersSettings(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'GET',
+        path: '/v1/orders-settings',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+export function updateOrdersSettings() {
+    const payload = {};
+    const getRequestOptions = ambassadorWixEcomV1OrdersSettings.updateOrdersSettings(payload);
+    const getUrl = (context) => {
+        const { url } = getRequestOptions(context);
+        return url;
+    };
+    return {
+        getUrl,
+        httpMethod: 'PATCH',
+        path: '/v1/orders-settings',
+        pathParams: {},
+        __requestType: null,
+        __originalRequestType: null,
+        __responseType: null,
+        __originalResponseType: null,
+    };
+}
+//# sourceMappingURL=ecom-v1-orders-settings-orders-settings.meta.js.map

package/build/es/src/ecom-v1-orders-settings-orders-settings.meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-v1-orders-settings-orders-settings.meta.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iCAAiC,MAAM,mDAAmD,CAAC;AAsBvG,MAAM,UAAU,iBAAiB;IAU/B,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,iCAAiC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,qBAAqB;QAC3B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB;IAUlC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,iCAAiC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAElE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,OAAO;QACnB,IAAI,EAAE,qBAAqB;QAC3B,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC"}

package/build/es/src/ecom-v1-orders-settings-orders-settings.public.d.ts

@@ -0,0 +1,30 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { GetOrdersSettingsResponse, GetOrdersSettingsResponseNonNullableFields, OrdersSettings, OrdersSettingsUpdatedEnvelope, UpdateOrdersSettingsResponse, UpdateOrdersSettingsResponseNonNullableFields } from './ecom-v1-orders-settings-orders-settings.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getOrdersSettings(httpClient: HttpClient): GetOrdersSettingsSignature;
+interface GetOrdersSettingsSignature {
+    /**
+     * Retrieves the sites' order settings.
+     *
+     *
+     * The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
+     * @returns The requested orders settings.
+     */
+    (): Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
+}
+export declare function updateOrdersSettings(httpClient: HttpClient): UpdateOrdersSettingsSignature;
+interface UpdateOrdersSettingsSignature {
+    /**
+     * Updates the sites' orders settings.
+     *
+     *
+     * The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
+     * @param - Orders settings to update.
+     * @returns The updated orders settings.
+     */
+    (ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
+}
+export declare const onOrdersSettingsUpdated: EventDefinition<OrdersSettingsUpdatedEnvelope, "wix.ecom.v1.orders_settings_updated">;
+export { ActionEvent, BaseEventMetadata, DeleteOrdersSettingsRequest, DeleteOrdersSettingsResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetOrdersSettingsRequest, GetOrdersSettingsResponse, GetOrdersSettingsResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, InventoryUpdateTrigger, ListOrdersSettingsRequest, ListOrdersSettingsResponse, MessageEnvelope, OrdersSettings, OrdersSettingsUpdatedEnvelope, RestoreInfo, UpdateOrdersSettingsRequest, UpdateOrdersSettingsResponse, UpdateOrdersSettingsResponseNonNullableFields, WebhookIdentityType, } from './ecom-v1-orders-settings-orders-settings.universal.js';

package/build/es/src/ecom-v1-orders-settings-orders-settings.public.js

@@ -0,0 +1,28 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { getOrdersSettings as universalGetOrdersSettings, updateOrdersSettings as universalUpdateOrdersSettings, } from './ecom-v1-orders-settings-orders-settings.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/ecom' };
+export function getOrdersSettings(httpClient) {
+    return () => universalGetOrdersSettings(
+    // @ts-ignore
+    { httpClient });
+}
+export function updateOrdersSettings(httpClient) {
+    return (ordersSettings) => universalUpdateOrdersSettings(ordersSettings, 
+    // @ts-ignore
+    { httpClient });
+}
+export const onOrdersSettingsUpdated = EventDefinition('wix.ecom.v1.orders_settings_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+export { InventoryUpdateTrigger, WebhookIdentityType, } from './ecom-v1-orders-settings-orders-settings.universal.js';
+//# sourceMappingURL=ecom-v1-orders-settings-orders-settings.public.js.map

package/build/es/src/ecom-v1-orders-settings-orders-settings.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-v1-orders-settings-orders-settings.public.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAOL,iBAAiB,IAAI,0BAA0B,EAC/C,oBAAoB,IAAI,6BAA6B,GACtD,MAAM,wDAAwD,CAAC;AAEhE,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAExD,MAAM,UAAU,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,0BAA0B;IACxB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAeD,MAAM,UAAU,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,cAA8B,EAAE,EAAE,CACxC,6BAA6B,CAC3B,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,CAAC,MAAM,uBAAuB,GAAG,eAAe,CACpD,qCAAqC,EACrC,IAAI,EACJ,CAAC,KAAoC,EAAE,EAAE,CACvC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAAiC,CAAC;AAEnC,OAAO,EAgBL,sBAAsB,EAUtB,mBAAmB,GACpB,MAAM,wDAAwD,CAAC"}

package/build/es/src/ecom-v1-orders-settings-orders-settings.types.d.ts

@@ -0,0 +1,178 @@
+export interface OrdersSettings {
+    /**
+     * Defines when to update the store inventory.
+     * Default: `ON_ORDER_PLACED`
+     */
+    inventoryUpdateTrigger?: InventoryUpdateTrigger;
+    /**
+     * Whether to automatically create invoices for every new order paid online.
+     * <br>
+     * Default: `false`
+     * <br>
+     * **Note**: The issued invoice for an order is not a tax invoice and doesn't reflect refunds. You are responsible for ensuring that invoices you issue conform to any relevant legal requirements.
+     */
+    createInvoice?: boolean | null;
+    /**
+     * Date and time the orders settings were created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the orders settings were updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+export declare enum InventoryUpdateTrigger {
+    UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
+    /** Stock quantities will update only after the payment is approved. */
+    ON_ORDER_PAID = "ON_ORDER_PAID",
+    /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
+    ON_ORDER_PLACED = "ON_ORDER_PLACED"
+}
+export interface GetOrdersSettingsRequest {
+}
+export interface GetOrdersSettingsResponse {
+    /** Orders settings. */
+    ordersSettings?: OrdersSettings;
+}
+export interface UpdateOrdersSettingsRequest {
+    /** Orders settings to update. */
+    ordersSettings: OrdersSettings;
+}
+export interface UpdateOrdersSettingsResponse {
+    /** The updated orders settings. */
+    ordersSettings?: OrdersSettings;
+}
+export interface DeleteOrdersSettingsRequest {
+}
+export interface DeleteOrdersSettingsResponse {
+}
+export interface ListOrdersSettingsRequest {
+}
+export interface ListOrdersSettingsResponse {
+    /** List of retrieved orders settings. */
+    ordersSettings?: OrdersSettings[];
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface OrdersSettingsNonNullableFields {
+    inventoryUpdateTrigger: InventoryUpdateTrigger;
+}
+export interface GetOrdersSettingsResponseNonNullableFields {
+    ordersSettings?: OrdersSettingsNonNullableFields;
+}
+export interface UpdateOrdersSettingsResponseNonNullableFields {
+    ordersSettings?: OrdersSettingsNonNullableFields;
+}
+export {};

package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js

@@ -0,0 +1,17 @@
+export var InventoryUpdateTrigger;
+(function (InventoryUpdateTrigger) {
+    InventoryUpdateTrigger["UNKNOWN_INVENTORY_UPDATE_TRIGGER"] = "UNKNOWN_INVENTORY_UPDATE_TRIGGER";
+    /** Stock quantities will update only after the payment is approved. */
+    InventoryUpdateTrigger["ON_ORDER_PAID"] = "ON_ORDER_PAID";
+    /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
+    InventoryUpdateTrigger["ON_ORDER_PLACED"] = "ON_ORDER_PLACED";
+})(InventoryUpdateTrigger || (InventoryUpdateTrigger = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=ecom-v1-orders-settings-orders-settings.types.js.map

package/build/es/src/ecom-v1-orders-settings-orders-settings.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-v1-orders-settings-orders-settings.types.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.types.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAN,IAAY,sBAMX;AAND,WAAY,sBAAsB;IAChC,+FAAqE,CAAA;IACrE,uEAAuE;IACvE,yDAA+B,CAAA;IAC/B,gIAAgI;IAChI,6DAAmC,CAAA;AACrC,CAAC,EANW,sBAAsB,KAAtB,sBAAsB,QAMjC;AAiJD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}

package/build/es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts

@@ -0,0 +1,300 @@
+export interface OrdersSettings {
+    /**
+     * Defines when to update the store inventory.
+     *
+     * - `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.
+     *  - `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.
+     *
+     * Default: `ON_ORDER_PLACED`
+     */
+    inventoryUpdateTrigger?: InventoryUpdateTrigger;
+    /**
+     * Whether to automatically create invoices for every new order paid online.
+     * Default: `false`
+     */
+    createInvoice?: boolean | null;
+    /**
+     * Date and time the orders settings were created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the orders settings were updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+export declare enum InventoryUpdateTrigger {
+    UNKNOWN_INVENTORY_UPDATE_TRIGGER = "UNKNOWN_INVENTORY_UPDATE_TRIGGER",
+    /** Stock quantities will update only after the payment is approved. */
+    ON_ORDER_PAID = "ON_ORDER_PAID",
+    /** Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock. */
+    ON_ORDER_PLACED = "ON_ORDER_PLACED"
+}
+export interface GetOrdersSettingsRequest {
+}
+export interface GetOrdersSettingsResponse {
+    /** Orders settings. */
+    ordersSettings?: OrdersSettings;
+}
+export interface UpdateOrdersSettingsRequest {
+    /** Orders settings to update. */
+    ordersSettings: OrdersSettings;
+}
+export interface UpdateOrdersSettingsResponse {
+    /** The updated orders settings. */
+    ordersSettings?: OrdersSettings;
+}
+export interface DeleteOrdersSettingsRequest {
+}
+export interface DeleteOrdersSettingsResponse {
+}
+export interface ListOrdersSettingsRequest {
+}
+export interface ListOrdersSettingsResponse {
+    /** List of retrieved orders settings. */
+    ordersSettings?: OrdersSettings[];
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface OrdersSettingsNonNullableFields {
+    inventoryUpdateTrigger: InventoryUpdateTrigger;
+}
+export interface GetOrdersSettingsResponseNonNullableFields {
+    ordersSettings?: OrdersSettingsNonNullableFields;
+}
+export interface UpdateOrdersSettingsResponseNonNullableFields {
+    ordersSettings?: OrdersSettingsNonNullableFields;
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface OrdersSettingsUpdatedEnvelope {
+    entity: OrdersSettings;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when orders settings are updated.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
+ * @permissionId ECOM.READ_ORDERS_SETTINGS
+ * @webhook
+ * @eventType wix.ecom.v1.orders_settings_updated
+ * @documentationMaturity preview
+ */
+export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Retrieves the sites' order settings.
+ *
+ *
+ * The `getOrdersSettings()` function returns a Promise that resolves to orders settings.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId ECOM.READ_ORDERS_SETTINGS
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-STORES.READ-ORDERS
+ * @permissionScope Read Stores - all read permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns The requested orders settings.
+ * @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.GetOrdersSettings
+ */
+export declare function getOrdersSettings(): Promise<GetOrdersSettingsResponse & GetOrdersSettingsResponseNonNullableFields>;
+/**
+ * Updates the sites' orders settings.
+ *
+ *
+ * The `updateOrdersSettings()` function returns a Promise that resolves to the newly updated orders settings.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ordersSettings
+ * @param ordersSettings - Orders settings to update.
+ * @permissionId ECOM.UPDATE_ORDERS_SETTINGS
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @returns The updated orders settings.
+ * @fqn wix.ecom.orders_settings.api.v1.OrdersSettingsService.UpdateOrdersSettings
+ */
+export declare function updateOrdersSettings(ordersSettings: OrdersSettings): Promise<UpdateOrdersSettingsResponse & UpdateOrdersSettingsResponseNonNullableFields>;
+export {};