@wix/auto_sdk_ecom_orders-settings 1.0.4 → 1.0.5

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, OrdersSettings, OrdersSettingsUpdatedEnvelope, UpdateOrdersSettingsResponse } 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>;
+}
+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>;
+}
+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, IdentificationData, IdentificationDataIdOneOf, InventoryUpdateTrigger, ListOrdersSettingsRequest, ListOrdersSettingsResponse, MessageEnvelope, OrdersSettings, OrdersSettingsUpdatedEnvelope, RestoreInfo, UpdateOrdersSettingsRequest, UpdateOrdersSettingsResponse, 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,EAKL,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;AAaD,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;AAcD,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,EAeL,sBAAsB,EAStB,mBAAmB,GACpB,MAAM,wDAAwD,CAAC"}

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

@@ -0,0 +1,198 @@
+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.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    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.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}

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;AA+KD,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/{ecom-v1-orders-settings-orders-settings.universal-Dk8IycJy.d.ts → es/src/ecom-v1-orders-settings-orders-settings.universal.d.ts}

@@ -1,4 +1,5 @@
-interface OrdersSettings {
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface OrdersSettings {
     /**
      * Defines when to update the store inventory.
      *
@@ -24,38 +25,38 @@ interface OrdersSettings {
      */
     _updatedDate?: Date | null;
 }
-declare enum InventoryUpdateTrigger {
+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"
 }
-interface GetOrdersSettingsRequest {
+export interface GetOrdersSettingsRequest {
 }
-interface GetOrdersSettingsResponse {
+export interface GetOrdersSettingsResponse {
     /** Orders settings. */
     ordersSettings?: OrdersSettings;
 }
-interface UpdateOrdersSettingsRequest {
+export interface UpdateOrdersSettingsRequest {
     /** Orders settings to update. */
     ordersSettings: OrdersSettings;
 }
-interface UpdateOrdersSettingsResponse {
+export interface UpdateOrdersSettingsResponse {
     /** The updated orders settings. */
     ordersSettings?: OrdersSettings;
 }
-interface DeleteOrdersSettingsRequest {
+export interface DeleteOrdersSettingsRequest {
 }
-interface DeleteOrdersSettingsResponse {
+export interface DeleteOrdersSettingsResponse {
 }
-interface ListOrdersSettingsRequest {
+export interface ListOrdersSettingsRequest {
 }
-interface ListOrdersSettingsResponse {
+export interface ListOrdersSettingsResponse {
     /** List of retrieved orders settings. */
     ordersSettings?: OrdersSettings[];
 }
-interface DomainEvent extends DomainEventBodyOneOf {
+export interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -98,19 +99,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-interface DomainEventBodyOneOf {
+export interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-interface EntityCreatedEvent {
+export interface EntityCreatedEvent {
     entity?: string;
 }
-interface RestoreInfo {
+export interface RestoreInfo {
     deletedDate?: Date | null;
 }
-interface EntityUpdatedEvent {
+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.
@@ -118,14 +119,14 @@ interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-interface EntityDeletedEvent {
+export interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-interface ActionEvent {
+export interface ActionEvent {
     body?: string;
 }
-interface MessageEnvelope {
+export interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -141,7 +142,7 @@ interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-interface IdentificationData extends IdentificationDataIdOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -166,7 +167,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-interface IdentificationDataIdOneOf {
+export interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -188,14 +189,14 @@ interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-declare enum WebhookIdentityType {
+export declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-interface BaseEventMetadata {
+export interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -209,7 +210,7 @@ interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-interface EventMetadata extends BaseEventMetadata {
+export interface EventMetadata extends BaseEventMetadata {
     /**
      * Unique event ID.
      * Allows clients to ignore duplicate webhooks.
@@ -247,9 +248,88 @@ interface EventMetadata extends BaseEventMetadata {
      */
     entityEventSequence?: string | null;
 }
-interface OrdersSettingsUpdatedEnvelope {
+export interface OrdersSettingsUpdatedEnvelope {
     entity: OrdersSettings;
     metadata: EventMetadata;
 }
-
-export { type ActionEvent as A, type BaseEventMetadata as B, type DeleteOrdersSettingsRequest as D, type EntityCreatedEvent as E, type GetOrdersSettingsResponse as G, InventoryUpdateTrigger as I, type ListOrdersSettingsRequest as L, type MessageEnvelope as M, type OrdersSettings as O, type RestoreInfo as R, type UpdateOrdersSettingsResponse as U, WebhookIdentityType as W, type GetOrdersSettingsRequest as a, type UpdateOrdersSettingsRequest as b, type DeleteOrdersSettingsResponse as c, type ListOrdersSettingsResponse as d, type DomainEvent as e, type DomainEventBodyOneOf as f, type EntityUpdatedEvent as g, type EntityDeletedEvent as h, type IdentificationData as i, type IdentificationDataIdOneOf as j, type EventMetadata as k, type OrdersSettingsUpdatedEnvelope as l };
+/**
+ * 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
+ * @serviceIdentifier wix.ecom.orders_settings.api.v1.OrdersSettingsService
+ * @slug updated
+ * @documentationMaturity preview
+ */
+export declare function onOrdersSettingsUpdated(handler: (event: OrdersSettingsUpdatedEnvelope) => void | Promise<void>): void;
+type OrdersSettingsNonNullablePaths = `inventoryUpdateTrigger`;
+/**
+ * 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<NonNullablePaths<GetOrdersSettingsResponse, {
+    [P in OrdersSettingsNonNullablePaths]: `ordersSettings.${P}`;
+}[OrdersSettingsNonNullablePaths]>>;
+/**
+ * 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<NonNullablePaths<UpdateOrdersSettingsResponse, {
+    [P in OrdersSettingsNonNullablePaths]: `ordersSettings.${P}`;
+}[OrdersSettingsNonNullablePaths]>>;
+export {};

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

@@ -0,0 +1,113 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixEcomV1OrdersSettings from './ecom-v1-orders-settings-orders-settings.http.js';
+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 = {}));
+/**
+ * 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 async function getOrdersSettings() {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const payload = renameKeysFromSDKRequestToRESTRequest({});
+    const reqOpts = ambassadorWixEcomV1OrdersSettings.getOrdersSettings(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {},
+            singleArgumentUnchanged: false,
+        }, []);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * 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 async function updateOrdersSettings(ordersSettings) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        ordersSettings: ordersSettings,
+    });
+    const reqOpts = ambassadorWixEcomV1OrdersSettings.updateOrdersSettings(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { ordersSettings: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['ordersSettings']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=ecom-v1-orders-settings-orders-settings.universal.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ecom-v1-orders-settings-orders-settings.universal.js","sourceRoot":"","sources":["../../../src/ecom-v1-orders-settings-orders-settings.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,iCAAiC,MAAM,mDAAmD,CAAC;AA6BvG,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;AA6KD,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;AA0FD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB;IAQrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,iCAAiC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAS9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,iCAAiC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAElE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/build/internal/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from './src/ecom-v1-orders-settings-orders-settings.context.js';

package/build/internal/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/ecom-v1-orders-settings-orders-settings.context.js"), exports);
+//# sourceMappingURL=index.js.map

package/build/internal/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2FAAyE"}

package/build/internal/cjs/index.typings.d.ts

@@ -0,0 +1 @@
+export * from './src/ecom-v1-orders-settings-orders-settings.universal.js';