@wix/auto_sdk_ecom_discount-rules 1.0.19 → 1.0.21

package/build/cjs/{ecom-discounts-v1-discount-rule-discount-rules.universal-CAqXQEc1.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface DiscountRule {
     /**
      * Discount rule ID.
@@ -840,6 +842,38 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type CreateDiscountRuleApplicationErrors = {
+    code?: 'MAX_DISCOUNT_RULES_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+type CreateDiscountRuleValidationErrors = {
+    ruleName?: 'INVALID_ACTIVE_TIME_RANGE';
+} | {
+    ruleName?: 'INVALID_EMPTY_DISCOUNT';
+} | {
+    ruleName?: 'INVALID_DISCOUNT_TYPE';
+} | {
+    ruleName?: 'MISSING_SUBTOTAL_RANGE';
+} | {
+    ruleName?: 'MISSING_ITEM_QUANTITY_RANGE';
+} | {
+    ruleName?: 'INVALID_SUBTOTAL_RANGE';
+} | {
+    ruleName?: 'INVALID_ITEM_QUANTITY_RANGE';
+} | {
+    ruleName?: 'INVALID_TARGET_TYPE_FIELD';
+} | {
+    ruleName?: 'OPERATOR_TOO_DEEPLY_NESTED';
+} | {
+    ruleName?: 'INVALID_SCOPE_TYPE';
+} | {
+    ruleName?: 'INVALID_TRIGGER_TYPE';
+} | {
+    ruleName?: 'INVALID_SETTINGS_SUBJECT_TYPE';
+} | {
+    ruleName?: 'INVALID_CUSTOMER_BUY_CONDITION';
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -888,13 +922,130 @@ interface DiscountRuleCreatedEnvelope {
     entity: DiscountRule;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a discount rule is created.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @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
+ * @permissionId ECOM.DISCOUNT_RULES_READ
+ * @webhook
+ * @eventType wix.ecom.discounts.v1.discount_rule_created
+ * @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
+ * @slug created
+ */
+declare function onDiscountRuleCreated(handler: (event: DiscountRuleCreatedEnvelope) => void | Promise<void>): void;
 interface DiscountRuleDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a discount rule is deleted.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @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
+ * @permissionId ECOM.DISCOUNT_RULES_READ
+ * @webhook
+ * @eventType wix.ecom.discounts.v1.discount_rule_deleted
+ * @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
+ * @slug deleted
+ */
+declare function onDiscountRuleDeleted(handler: (event: DiscountRuleDeletedEnvelope) => void | Promise<void>): void;
 interface DiscountRuleUpdatedEnvelope {
     entity: DiscountRule;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a discount rule is updated.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @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
+ * @permissionId ECOM.DISCOUNT_RULES_READ
+ * @webhook
+ * @eventType wix.ecom.discounts.v1.discount_rule_updated
+ * @serviceIdentifier com.wix.ecom.discounts.DiscountRuleService
+ * @slug updated
+ */
+declare function onDiscountRuleUpdated(handler: (event: DiscountRuleUpdatedEnvelope) => void | Promise<void>): void;
+type DiscountRuleNonNullablePaths = `trigger.and.triggers` | `trigger.or.triggers` | `trigger.customTrigger._id` | `trigger.customTrigger.appId` | `trigger.subtotalRange.scopes` | `trigger.subtotalRange.scopes.${number}.catalogItemFilter.catalogAppId` | `trigger.subtotalRange.scopes.${number}.customFilter.appId` | `trigger.subtotalRange.scopes.${number}._id` | `trigger.subtotalRange.scopes.${number}.type` | `trigger.itemQuantityRange.scopes` | `trigger.triggerType` | `discounts.values` | `discounts.values.${number}.percentage` | `discounts.values.${number}.fixedAmount` | `discounts.values.${number}.fixedPrice` | `discounts.values.${number}.targetType` | `discounts.values.${number}.discountType` | `status` | `usageCount`;
+/**
+ * Creates a new discount rule.
+ *
+ *
+ * The `createDiscountRule()` function returns a Promise that resolves to the new discount rule when it's created.
+ * @param discountRule - Discount rule info.
+ * @public
+ * @requiredField discountRule
+ * @requiredField discountRule.discounts
+ * @requiredField discountRule.name
+ * @permissionId ECOM.DISCOUNT_RULES_CREATE
+ * @applicableIdentity APP
+ * @returns Discount rule.
+ * @fqn com.wix.ecom.discounts.DiscountRuleService.CreateDiscountRule
+ */
+declare function createDiscountRule(discountRule: NonNullablePaths<DiscountRule, `discounts` | `name`>): Promise<NonNullablePaths<DiscountRule, DiscountRuleNonNullablePaths> & {
+    __applicationErrorsType?: CreateDiscountRuleApplicationErrors;
+    __validationErrorsType?: CreateDiscountRuleValidationErrors;
+}>;
+/**
+ * Retrieves a discount rule.
+ *
+ *
+ * The `getDiscountRule()` function returns a Promise that resolves when the specified discount rule is retrieved.
+ * @param discountRuleId - ID of the discount rule to retrieve.
+ * @public
+ * @requiredField discountRuleId
+ * @permissionId ECOM.DISCOUNT_RULES_READ
+ * @applicableIdentity APP
+ * @returns The requested discount rule.
+ * @fqn com.wix.ecom.discounts.DiscountRuleService.GetDiscountRule
+ */
+declare function getDiscountRule(discountRuleId: string): Promise<NonNullablePaths<DiscountRule, DiscountRuleNonNullablePaths>>;
+/**
+ * Updates a discount rule's properties.
+ *
+ *
+ * The `updateDiscountRule()` function returns a Promise that resolves when the specified discount rule's properties are updated.
+ *
+ * Each time the discount rule is updated, `revision` increments by 1. The existing `revision` must be included when updating the discount rule. This ensures you're working with the latest discount rule information, and it prevents unintended overwrites.
+ * @param _id - Discount rule ID.
+ * @public
+ * @requiredField _id
+ * @requiredField discountRule
+ * @requiredField discountRule.revision
+ * @param discountRule - Discount rule info.
+ * @param options - Discount rule info.
+ * @permissionId ECOM.DISCOUNT_RULES_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated discount rule.
+ * @fqn com.wix.ecom.discounts.DiscountRuleService.UpdateDiscountRule
+ */
+declare function updateDiscountRule(_id: string, discountRule: NonNullablePaths<UpdateDiscountRule, `revision`>): Promise<NonNullablePaths<DiscountRule, DiscountRuleNonNullablePaths>>;
 interface UpdateDiscountRule {
     /**
      * Discount rule ID.
@@ -960,6 +1111,40 @@ interface UpdateDiscountRule {
      */
     usageCount?: number;
 }
+/**
+ * Deletes a discount rule.
+ *
+ *
+ * The `deleteDiscountRule()` function returns a Promise that resolves when the specified discount rule is deleted.
+ * @param discountRuleId - ID of the discount rule to delete.
+ * @public
+ * @requiredField discountRuleId
+ * @permissionId ECOM.DISCOUNT_RULES_DELETE
+ * @applicableIdentity APP
+ * @fqn com.wix.ecom.discounts.DiscountRuleService.DeleteDiscountRule
+ */
+declare function deleteDiscountRule(discountRuleId: string): Promise<void>;
+/**
+ * Creates a query to retrieve a list of discount rules.
+ *
+ *
+ * The `queryDiscountRules()` function builds a query to retrieve a list of up to 100 discount rules, and returns a [`DiscountRulesQueryBuilder`](#discountrulesquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](/discount-rules/discount-rules-query-builder/find) function.
+ *
+ * You can refine the query by chaining `DiscountRulesQueryBuilder` functions onto the query. `DiscountRulesQueryBuilder` functions enable you to sort, filter, and control the results queryDiscountRules() returns.
+ *
+ * By default, `queryDiscountRules()` sorts results by [`ascending("_id")`](/discount-rules/discount-rules-query-builder/ascending) by default. This can be overridden.
+ *
+ * To learn how to query posts, refer to the table below.
+ *
+ * The following `DiscountRulesQueryBuilder` functions are supported for the `queryDiscountRules()` function. For a full description of the discount rule object, see the object returned for the [`items`](/discount-rules/discount-rules-query-result/items) property in the `DiscountRulesQueryResult`.
+ * @public
+ * @permissionId ECOM.DISCOUNT_RULES_READ
+ * @applicableIdentity APP
+ * @fqn com.wix.ecom.discounts.DiscountRuleService.QueryDiscountRules
+ */
+declare function queryDiscountRules(): DiscountRulesQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -1019,4 +1204,4 @@ interface DiscountRulesQueryBuilder {
     find: () => Promise<DiscountRulesQueryResult>;
 }
 
-export { type GetAppliedDiscountsRequest as $, AppliedSubjectType as A, type BuyXGetYInfo as B, type CatalogItemFilter as C, type DiscountRule as D, type ExtendedFields as E, type CreateDiscountRuleResponse as F, type GetDiscountRuleRequest as G, type GetDiscountRuleResponse as H, type ItemQuantityRange as I, type UpdateDiscountRuleRequest as J, type UpdateDiscountRuleResponse as K, type DeleteDiscountRuleRequest as L, type DeleteDiscountRuleResponse as M, type PlatformQueryPagingMethodOneOf as N, type Or as O, type PlatformQuery as P, type QueryDiscountRulesRequest as Q, type Sorting as R, ScopeType as S, TriggerType as T, type UpdateDiscountRule as U, type PlatformPaging as V, WebhookIdentityType as W, type CursorPaging as X, type QueryDiscountRulesResponse as Y, type PlatformPagingMetadata as Z, type Cursors as _, type DiscountRulesQueryBuilder as a, type LineItem as a0, type CatalogReference as a1, type GetAppliedDiscountsResponse as a2, type AppliedDiscount as a3, type AppliedDiscountRule as a4, type DiscountRuleName as a5, type MultiCurrencyPrice as a6, type DomainEvent as a7, type DomainEventBodyOneOf as a8, type EntityCreatedEvent as a9, type RestoreInfo as aa, type EntityUpdatedEvent as ab, type EntityDeletedEvent as ac, type ActionEvent as ad, type Empty as ae, type DiscountRuleUsageLimitReached as af, type MessageEnvelope as ag, type IdentificationData as ah, type IdentificationDataIdOneOf as ai, type BaseEventMetadata as aj, type EventMetadata as ak, type DiscountRulesQueryResult as al, type DiscountRuleCreatedEnvelope as b, type DiscountRuleDeletedEnvelope as c, type DiscountRuleUpdatedEnvelope as d, Type as e, DiscountType as f, Status as g, SortOrder as h, type DiscountTrigger as i, type DiscountTriggerTriggerOneOf as j, type Scope as k, type ScopeScopeItemsOneOf as l, type CustomFilter as m, type And as n, type Custom as o, type SubtotalRange as p, type ActiveTimeInfo as q, type Discounts as r, type Discount as s, type DiscountDiscountOneOf as t, type SpecificItemsInfo as u, type CustomerBuy as v, type CustomerBuyConditionOneOf as w, type CustomerGet as x, type DiscountSettings as y, type CreateDiscountRuleRequest as z };
+export { type ActionEvent, type ActiveTimeInfo, type And, type AppliedDiscount, type AppliedDiscountRule, AppliedSubjectType, type AppliedSubjectTypeWithLiterals, type BaseEventMetadata, type BuyXGetYInfo, type CatalogItemFilter, type CatalogReference, type CreateDiscountRuleApplicationErrors, type CreateDiscountRuleRequest, type CreateDiscountRuleResponse, type CreateDiscountRuleValidationErrors, type CursorPaging, type Cursors, type Custom, type CustomFilter, type CustomerBuy, type CustomerBuyConditionOneOf, type CustomerGet, type DeleteDiscountRuleRequest, type DeleteDiscountRuleResponse, type Discount, type DiscountDiscountOneOf, type DiscountRule, type DiscountRuleCreatedEnvelope, type DiscountRuleDeletedEnvelope, type DiscountRuleName, type DiscountRuleUpdatedEnvelope, type DiscountRuleUsageLimitReached, type DiscountRulesQueryBuilder, type DiscountRulesQueryResult, type DiscountSettings, type DiscountTrigger, type DiscountTriggerTriggerOneOf, DiscountType, type DiscountTypeWithLiterals, type Discounts, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetAppliedDiscountsRequest, type GetAppliedDiscountsResponse, type GetDiscountRuleRequest, type GetDiscountRuleResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemQuantityRange, type LineItem, type MessageEnvelope, type MultiCurrencyPrice, type Or, type PlatformPaging, type PlatformPagingMetadata, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type QueryDiscountRulesRequest, type QueryDiscountRulesResponse, type RestoreInfo, type Scope, type ScopeScopeItemsOneOf, ScopeType, type ScopeTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpecificItemsInfo, Status, type StatusWithLiterals, type SubtotalRange, TriggerType, type TriggerTypeWithLiterals, Type, type TypeWithLiterals, type UpdateDiscountRule, type UpdateDiscountRuleRequest, type UpdateDiscountRuleResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createDiscountRule, deleteDiscountRule, getDiscountRule, onDiscountRuleCreated, onDiscountRuleDeleted, onDiscountRuleUpdated, queryDiscountRules, updateDiscountRule };