@wix/auto_sdk_ecom_discount-rules 1.0.0 → 1.0.1

package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.d.ts

@@ -1,6 +1,7 @@
 export interface DiscountRule {
     /**
      * Discount rule ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -26,7 +27,11 @@ export interface DiscountRule {
      * Default: `true`
      */
     active?: boolean | null;
-    /** Discount rule name. */
+    /**
+     * Discount rule name.
+     * @minLength 1
+     * @maxLength 50
+     */
     name?: string | null;
     /**
      * Discount rule trigger.
@@ -97,7 +102,11 @@ export interface Scope extends ScopeScopeItemsOneOf {
     catalogItemFilter?: CatalogItemFilter;
     /** Custom filter. Must be passed with `type."CATALOG_ITEM"`. */
     customFilter?: CustomFilter;
-    /** Scope ID. */
+    /**
+     * Scope ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     id?: string;
     /** Scope type. */
     type?: ScopeType;
@@ -117,13 +126,24 @@ export declare enum ScopeType {
     CUSTOM_FILTER = "CUSTOM_FILTER"
 }
 export interface CatalogItemFilter {
-    /** Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`. */
+    /**
+     * Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`.
+     * @format GUID
+     */
     catalogAppId?: string;
-    /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores. */
+    /**
+     * ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores.
+     * @minLength 1
+     * @maxLength 36
+     * @maxSize 50
+     */
     catalogItemIds?: string[];
 }
 export interface CustomFilter {
-    /** Custom filter app ID, when relevant. */
+    /**
+     * Custom filter app ID, when relevant.
+     * @format GUID
+     */
     appId?: string;
     /**
      * Custom filter in `{ "key": "value" }` form.
@@ -133,33 +153,66 @@ export interface CustomFilter {
     params?: Record<string, any> | null;
 }
 export interface And {
-    /** List of triggers to have an "AND" operator between their results. */
+    /**
+     * List of triggers to have an "AND" operator between their results.
+     * @minSize 2
+     * @maxSize 5
+     */
     triggers?: DiscountTrigger[];
 }
 export interface Or {
-    /** List of triggers to have an "OR" operator between their results. */
+    /**
+     * List of triggers to have an "OR" operator between their results.
+     * @minSize 2
+     * @maxSize 5
+     */
     triggers?: DiscountTrigger[];
 }
 export interface Custom {
-    /** Trigger ID. */
+    /**
+     * Trigger ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     id?: string;
-    /** ID of the app that created the trigger. */
+    /**
+     * ID of the app that created the trigger.
+     * @format GUID
+     */
     appId?: string;
 }
 export interface SubtotalRange {
-    /** Relevant scopes for `SPECIFIC_ITEMS` target type. */
+    /**
+     * Relevant scopes for `SPECIFIC_ITEMS` target type.
+     * @maxSize 50
+     */
     scopes?: Scope[];
-    /** Minimum subtotal price (inclusive). */
+    /**
+     * Minimum subtotal price (inclusive).
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
     from?: string | null;
-    /** Maximum subtotal price (inclusive). */
+    /**
+     * Maximum subtotal price (inclusive).
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
     to?: string | null;
 }
 export interface ItemQuantityRange {
-    /** Relevant scopes for `SPECIFIC_ITEMS` target type. */
+    /**
+     * Relevant scopes for `SPECIFIC_ITEMS` target type.
+     * @maxSize 50
+     */
     scopes?: Scope[];
-    /** Minimum item quantity (inclusive). */
+    /**
+     * Minimum item quantity (inclusive).
+     * @min 1
+     */
     from?: number | null;
-    /** Maximum item quantity (inclusive). */
+    /**
+     * Maximum item quantity (inclusive).
+     * @min 1
+     */
     to?: number | null;
 }
 export declare enum TriggerType {
@@ -182,15 +235,29 @@ export interface ActiveTimeInfo {
     end?: Date | null;
 }
 export interface Discounts {
-    /** Discounts. */
+    /**
+     * Discounts.
+     * @minSize 1
+     * @maxSize 1
+     */
     values?: Discount[];
 }
 export interface Discount extends DiscountDiscountOneOf {
-    /** Percentage to discount from original price. */
+    /**
+     * Percentage to discount from original price.
+     * @min 0.1
+     * @max 100
+     */
     percentage?: number;
-    /** Amount to discount from original price. */
+    /**
+     * Amount to discount from original price.
+     * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
+     */
     fixedAmount?: string;
-    /** Fixed price. Line item will be fixed to this price. */
+    /**
+     * Fixed price. Line item will be fixed to this price.
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
     fixedPrice?: string;
     /**
      * Discount target.
@@ -205,11 +272,21 @@ export interface Discount extends DiscountDiscountOneOf {
 }
 /** @oneof */
 export interface DiscountDiscountOneOf {
-    /** Percentage to discount from original price. */
+    /**
+     * Percentage to discount from original price.
+     * @min 0.1
+     * @max 100
+     */
     percentage?: number;
-    /** Amount to discount from original price. */
+    /**
+     * Amount to discount from original price.
+     * @decimalValue options { gt:0, lte:1000000000000000, maxScale:4 }
+     */
     fixedAmount?: string;
-    /** Fixed price. Line item will be fixed to this price. */
+    /**
+     * Fixed price. Line item will be fixed to this price.
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
     fixedPrice?: string;
 }
 export declare enum Type {
@@ -219,7 +296,11 @@ export declare enum Type {
     SPECIFIC_ITEMS = "SPECIFIC_ITEMS"
 }
 export interface SpecificItemsInfo {
-    /** All associated scopes for `SPECIFIC_ITEMS` target type. */
+    /**
+     * All associated scopes for `SPECIFIC_ITEMS` target type.
+     * @minSize 1
+     * @maxSize 50
+     */
     scopes?: Scope[];
 }
 export declare enum DiscountType {
@@ -241,31 +322,53 @@ export interface BuyXGetYInfo {
      * For example, when the value of `limit` is `2`, with a "2+1" sale on all items, the following logic applies:
      * + Buy 2 get 1, buy 3 get 1.
      * + Buy 4 get 2, buy 6 get 2, buy 9 get 2, and so on.
+     * @min 1
      */
     limit?: number | null;
 }
 export interface CustomerBuy extends CustomerBuyConditionOneOf {
-    /** Minimum number of items the customer must add to the cart to be eligible for a discount. */
+    /**
+     * Minimum number of items the customer must add to the cart to be eligible for a discount.
+     * @min 1
+     */
     minimumQuantity?: number;
-    /** Minimum price the customer must add to the cart to be eligible for a discount. */
+    /**
+     * Minimum price the customer must add to the cart to be eligible for a discount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     minimumSpend?: string | null;
-    /** Scopes of the items that must be added to the cart to enable the discount. */
+    /**
+     * Scopes of the items that must be added to the cart to enable the discount.
+     * @minSize 1
+     * @maxSize 50
+     */
     scopes?: Scope[];
 }
 /** @oneof */
 export interface CustomerBuyConditionOneOf {
-    /** Minimum number of items the customer must add to the cart to be eligible for a discount. */
+    /**
+     * Minimum number of items the customer must add to the cart to be eligible for a discount.
+     * @min 1
+     */
     minimumQuantity?: number;
-    /** Minimum price the customer must add to the cart to be eligible for a discount. */
+    /**
+     * Minimum price the customer must add to the cart to be eligible for a discount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     minimumSpend?: string | null;
 }
 export interface CustomerGet {
     /**
      * Exact number of items in the cart that will be discounted.
      * If the cart contains fewer items than the value of quantity, the discount will not apply.
+     * @min 1
      */
     quantity?: number;
-    /** Scopes of the items that will be discounted. */
+    /**
+     * Scopes of the items that will be discounted.
+     * @minSize 1
+     * @maxSize 50
+     */
     scopes?: Scope[];
 }
 export declare enum Status {
@@ -288,11 +391,17 @@ export interface DiscountSettings {
      * Default: `false`
      */
     includeSubscription?: boolean | null;
-    /** Maximum total number of uses allowed for the discount rule. */
+    /**
+     * Maximum total number of uses allowed for the discount rule.
+     * @min 1
+     * @max 2147483646
+     */
     usageLimit?: number | null;
     /**
      * The usage limit per user per discount.
      * When not provided, this setting will not apply.
+     * @min 1
+     * @max 2147483646
      */
     usageLimitPerUser?: number | null;
 }
@@ -324,7 +433,10 @@ export interface CreateDiscountRuleResponse {
     discountRule?: DiscountRule;
 }
 export interface GetDiscountRuleRequest {
-    /** ID of the discount rule to retrieve. */
+    /**
+     * ID of the discount rule to retrieve.
+     * @format GUID
+     */
     discountRuleId: string;
 }
 export interface GetDiscountRuleResponse {
@@ -340,7 +452,10 @@ export interface UpdateDiscountRuleResponse {
     discountRule?: DiscountRule;
 }
 export interface DeleteDiscountRuleRequest {
-    /** ID of the discount rule to delete. */
+    /**
+     * ID of the discount rule to delete.
+     * @format GUID
+     */
     discountRuleId: string;
 }
 export interface DeleteDiscountRuleResponse {
@@ -367,7 +482,10 @@ export interface PlatformQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -377,19 +495,26 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface PlatformPaging {
-    /** Number of items to load. */
+    /**
+     * Number of items to load.
+     * @max 100
+     */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
@@ -410,30 +535,56 @@ export interface PlatformPagingMetadata {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface GetAppliedDiscountsRequest {
-    /** Line items for which to check for discount rules. */
+    /**
+     * Line items for which to check for discount rules.
+     * @maxSize 1000
+     */
     lineItems?: LineItem[];
-    /** Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order. */
+    /**
+     * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
+     * @format GUID
+     */
     purchaseFlowId?: string | null;
 }
 export interface LineItem {
-    /** Line item ID. */
+    /**
+     * Line item ID.
+     * @minLength 1
+     * @maxLength 100
+     */
     id?: string;
-    /** Line item quantity. */
+    /**
+     * Line item quantity.
+     * @max 100000
+     */
     quantity?: number | null;
     /** Catalog and item reference info. Learn more about [integrating Wix Stores products with Wix eCommerce](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration). */
     catalogReference?: CatalogReference;
-    /** Line item price. */
+    /**
+     * Line item price.
+     * @decimalValue options { gte:0 }
+     */
     price?: string;
 }
 /** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
 export interface CatalogReference {
-    /** ID of the item within the catalog it belongs to. */
+    /**
+     * ID of the item within the catalog it belongs to.
+     * @minLength 1
+     * @maxLength 36
+     */
     catalogItemId?: string;
     /**
      * ID of the app providing the catalog.
@@ -444,6 +595,7 @@ export interface CatalogReference {
      * + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
      * + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
      * + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
+     * @minLength 1
      */
     appId?: string;
     /**
@@ -460,13 +612,20 @@ export interface GetAppliedDiscountsResponse {
 export interface AppliedDiscount {
     /** Discount type. */
     discountType?: Type;
-    /** IDs of line items the discount applies to, in GUID format. */
+    /**
+     * IDs of line items the discount applies to, in GUID format.
+     * @format GUID
+     * @maxSize 1000
+     */
     lineItemIds?: string[];
     /** Applied discount rule. */
     appliedDiscountRule?: AppliedDiscountRule;
 }
 export interface AppliedDiscountRule {
-    /** Applied discount rule ID. */
+    /**
+     * Applied discount rule ID.
+     * @format GUID
+     */
     id?: string;
     /** Discount rule name. */
     name?: DiscountRuleName;
@@ -476,21 +635,31 @@ export interface AppliedDiscountRule {
     discountRuleType?: DiscountType;
 }
 export interface DiscountRuleName {
-    /** Original discount rule name (in site's default language). */
+    /**
+     * Original discount rule name (in site's default language).
+     * @minLength 1
+     * @maxLength 256
+     */
     original?: string;
     /**
      * Translated discount rule name according to buyer language.
      *
      * Default: `original`
+     * @minLength 1
+     * @maxLength 500
      */
     translated?: string | null;
 }
 export interface MultiCurrencyPrice {
-    /** Amount. */
+    /**
+     * Amount.
+     * @decimalValue options { gte:0, lte:1000000000000000 }
+     */
     amount?: string;
     /**
      * Converted amount.
      * @readonly
+     * @decimalValue options { gte:0, lte:1000000000000000 }
      */
     convertedAmount?: string;
     /**
@@ -583,9 +752,15 @@ export interface DiscountRuleUsageLimitReached {
     rule?: DiscountRule;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -593,26 +768,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/ecom-discounts-v1-discount-rule-discount-rules.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecom-discounts-v1-discount-rule-discount-rules.types.js","sourceRoot":"","sources":["../../../src/ecom-discounts-v1-discount-rule-discount-rules.types.ts"],"names":[],"mappings":";;;AAoHA,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,gDAAmC,CAAA;IACnC,6BAA6B;IAC7B,0CAA6B,CAAA;IAC7B,uCAAuC;IACvC,4CAA+B,CAAA;AACjC,CAAC,EANW,SAAS,yBAAT,SAAS,QAMpB;AAuDD,IAAY,WAYX;AAZD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,mGAAmG;IACnG,0BAAW,CAAA;IACX,oEAAoE;IACpE,gDAAiC,CAAA;IACjC,sFAAsF;IACtF,0DAA2C,CAAA;IAC3C,6DAA6D;IAC7D,gCAAiB,CAAA;IACjB,+CAA+C;IAC/C,wBAAS,CAAA;AACX,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB;AA2CD,IAAY,IAKX;AALD,WAAY,IAAI;IACd,iCAAiC;IACjC,+BAAuB,CAAA;IACvB,6CAA6C;IAC7C,yCAAiC,CAAA;AACnC,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AAOD,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,4CAA4C;IAC5C,yCAAyB,CAAA;IACzB,wCAAwC;IACxC,6CAA6B,CAAA;IAC7B,yCAAyC;IACzC,2CAA2B,CAAA;AAC7B,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AA2CD,IAAY,MASX;AATD,WAAY,MAAM;IAChB,kCAAkC;IAClC,iCAAuB,CAAA;IACvB,2BAA2B;IAC3B,uBAAa,CAAA;IACb,mEAAmE;IACnE,6BAAmB,CAAA;IACnB,8DAA8D;IAC9D,6BAAmB,CAAA;AACrB,CAAC,EATW,MAAM,sBAAN,MAAM,QASjB;AAqBD,oCAAoC;AACpC,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,iDAAiD;IACjD,6CAAuB,CAAA;IACvB,8DAA8D;IAC9D,+DAAyC,CAAA;AAC3C,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AAkFD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAyQD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"ecom-discounts-v1-discount-rule-discount-rules.types.js","sourceRoot":"","sources":["../../../src/ecom-discounts-v1-discount-rule-discount-rules.types.ts"],"names":[],"mappings":";;;AA6HA,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,gDAAmC,CAAA;IACnC,6BAA6B;IAC7B,0CAA6B,CAAA;IAC7B,uCAAuC;IACvC,4CAA+B,CAAA;AACjC,CAAC,EANW,SAAS,yBAAT,SAAS,QAMpB;AAmGD,IAAY,WAYX;AAZD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,mGAAmG;IACnG,0BAAW,CAAA;IACX,oEAAoE;IACpE,gDAAiC,CAAA;IACjC,sFAAsF;IACtF,0DAA2C,CAAA;IAC3C,6DAA6D;IAC7D,gCAAiB,CAAA;IACjB,+CAA+C;IAC/C,wBAAS,CAAA;AACX,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB;AAmED,IAAY,IAKX;AALD,WAAY,IAAI;IACd,iCAAiC;IACjC,+BAAuB,CAAA;IACvB,6CAA6C;IAC7C,yCAAiC,CAAA;AACnC,CAAC,EALW,IAAI,oBAAJ,IAAI,QAKf;AAWD,IAAY,YAQX;AARD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,4CAA4C;IAC5C,yCAAyB,CAAA;IACzB,wCAAwC;IACxC,6CAA6B,CAAA;IAC7B,yCAAyC;IACzC,2CAA2B,CAAA;AAC7B,CAAC,EARW,YAAY,4BAAZ,YAAY,QAQvB;AAiED,IAAY,MASX;AATD,WAAY,MAAM;IAChB,kCAAkC;IAClC,iCAAuB,CAAA;IACvB,2BAA2B;IAC3B,uBAAa,CAAA;IACb,mEAAmE;IACnE,6BAAmB,CAAA;IACnB,8DAA8D;IAC9D,6BAAmB,CAAA;AACrB,CAAC,EATW,MAAM,sBAAN,MAAM,QASjB;AA2BD,oCAAoC;AACpC,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,iDAAiD;IACjD,6CAAuB,CAAA;IACvB,8DAA8D;IAC9D,+DAAyC,CAAA;AAC3C,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AA2FD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA0VD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}