@wix/auto_sdk_loyalty_rewards 1.0.0 → 1.0.2

package/build/cjs/src/loyalty-v1-reward-rewards.types.d.ts

@@ -9,10 +9,15 @@ export interface Reward extends RewardTypeDetailsOneOf {
     couponReward?: CouponReward;
     /**
      * Reward ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
-    /** Reward name. */
+    /**
+     * Reward name.
+     * @minLength 1
+     * @maxLength 50
+     */
     name?: string;
     /** Whether the reward is active. Default: `FALSE` */
     active?: boolean;
@@ -55,15 +60,29 @@ export declare enum RewardType {
     SPI_DISCOUNT_AMOUNT = "SPI_DISCOUNT_AMOUNT"
 }
 export interface DiscountAmount {
-    /** Discount details for each tier. */
+    /**
+     * Discount details for each tier.
+     * @maxSize 21
+     */
     configsByTier?: DiscountAmountConfig[];
 }
 export interface DiscountAmountConfig {
-    /** Discount amount. Must be a positive value. */
+    /**
+     * Discount amount. Must be a positive value.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0, maxScale:2 }
+     */
     amount?: string;
-    /** Tier ID, or empty if config applies to the base tier. */
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
     tierId?: string | null;
-    /** Amount of points required to redeem the reward. */
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
     costInPoints?: number;
 }
 export interface CouponReward extends CouponRewardDiscountTypeOneOf, CouponRewardScopeOrMinSubtotalOneOf {
@@ -89,6 +108,8 @@ export interface CouponReward extends CouponRewardDiscountTypeOneOf, CouponRewar
      *
      * Can only be set when `appliesToSubscriptions` is `true` and `scope.namespace` is `pricingPlans`.
      * If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * @min 1
+     * @max 999
      */
     discountedCycleCount?: number | null;
 }
@@ -112,37 +133,70 @@ export interface CouponRewardScopeOrMinSubtotalOneOf {
     scope?: CouponScope;
 }
 export interface FixedAmountDiscount {
-    /** Discount details for each tier. */
+    /**
+     * Discount details for each tier.
+     * @minSize 1
+     * @maxSize 21
+     */
     configsByTier?: FixedAmountDiscountConfig[];
 }
 export interface FixedAmountDiscountConfig {
-    /** Tier ID, or empty if config applies to the base tier. */
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
     tierId?: string | null;
-    /** Amount of points required to redeem the reward. */
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
     costInPoints?: number;
     /** Discount amount. */
     amount?: number;
 }
 export interface PercentageDiscount {
-    /** Discount details for each tier. */
+    /**
+     * Discount details for each tier.
+     * @minSize 1
+     * @maxSize 21
+     */
     configsByTier?: PercentageDiscountConfig[];
 }
 export interface PercentageDiscountConfig {
-    /** Tier ID, or empty if config applies to the base tier. */
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
     tierId?: string | null;
-    /** Amount of points required to redeem the reward. */
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
     costInPoints?: number;
     /** Percentage discount. */
     percentage?: number;
 }
 export interface FreeShippingDiscount {
-    /** Discount details for each tier. */
+    /**
+     * Discount details for each tier.
+     * @minSize 1
+     * @maxSize 21
+     */
     configsByTier?: FreeShippingDiscountConfig[];
 }
 export interface FreeShippingDiscountConfig {
-    /** Tier ID, or empty if config applies to the base tier. */
+    /**
+     * Tier ID, or empty if config applies to the base tier.
+     * @format GUID
+     */
     tierId?: string | null;
-    /** Amount of points required to redeem the reward. */
+    /**
+     * Amount of points required to redeem the reward.
+     * @min 1
+     * @max 9999999
+     */
     costInPoints?: number;
 }
 export interface CouponScope {
@@ -170,9 +224,15 @@ export interface Group {
     entityId?: string | null;
 }
 export interface SpiDiscountAmount {
-    /** Discount details for each tier. */
+    /**
+     * Discount details for each tier.
+     * @maxSize 21
+     */
     configsByTier?: DiscountAmountConfig[];
-    /** Description of the SPI discount amount reward. Taken from user input in the SPI config. */
+    /**
+     * Description of the SPI discount amount reward. Taken from user input in the SPI config.
+     * @maxLength 200
+     */
     description?: string;
 }
 export interface RewardDisabled {
@@ -186,7 +246,11 @@ export interface CreateRewardResponse {
     reward?: Reward;
 }
 export interface BulkCreateRewardsRequest {
-    /** Rewards to create. */
+    /**
+     * Rewards to create.
+     * @minSize 1
+     * @maxSize 10
+     */
     rewards: Reward[];
 }
 export interface BulkCreateRewardsResponse {
@@ -228,7 +292,10 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface GetRewardRequest {
-    /** ID of the reward to retrieve. */
+    /**
+     * ID of the reward to retrieve.
+     * @format GUID
+     */
     id: string;
 }
 export interface GetRewardResponse {
@@ -242,7 +309,10 @@ export interface BulkGetRewardsResponse {
     rewardsInSite?: RewardsInSite[];
 }
 export interface RewardsInSite {
-    /** Metasite id. */
+    /**
+     * Metasite id.
+     * @format GUID
+     */
     metaSiteId?: string;
     /** Rewards. */
     rewards?: Reward[];
@@ -268,6 +338,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
      * Sort object.
      *
      * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -281,7 +352,10 @@ export interface CursorQueryPagingMethodOneOf {
     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;
@@ -291,13 +365,17 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 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;
 }
@@ -321,9 +399,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 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 UpdateRewardRequest {
@@ -335,7 +419,10 @@ export interface UpdateRewardResponse {
     reward?: Reward;
 }
 export interface DeleteRewardRequest {
-    /** ID of the reward to delete. */
+    /**
+     * ID of the reward to delete.
+     * @format GUID
+     */
     id: string;
     /**
      * Revision number, which increments by 1 each time the reward is updated.
@@ -371,6 +458,7 @@ export interface PagingMetadataV2 {
 export interface ListRewardsInTierRequest {
     /**
      * Tier id.
+     * @format GUID
      * @readonly
      */
     tierId?: string | null;
@@ -458,9 +546,15 @@ export interface ActionEvent {
 export interface Empty {
 }
 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;
@@ -468,26 +562,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/loyalty-v1-reward-rewards.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"loyalty-v1-reward-rewards.types.js","sourceRoot":"","sources":["../../../src/loyalty-v1-reward-rewards.types.ts"],"names":[],"mappings":";;;AA+CA,8BAA8B;AAC9B,IAAY,UASX;AATD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,qCAAuB,CAAA;IACvB,sEAAsE;IACtE,iDAAmC,CAAA;IACnC,sHAAsH;IACtH,6CAA+B,CAAA;IAC/B,wBAAwB;IACxB,yDAA2C,CAAA;AAC7C,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AA0QD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAgOD,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":"loyalty-v1-reward-rewards.types.js","sourceRoot":"","sources":["../../../src/loyalty-v1-reward-rewards.types.ts"],"names":[],"mappings":";;;AAoDA,8BAA8B;AAC9B,IAAY,UASX;AATD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,qCAAuB,CAAA;IACvB,sEAAsE;IACtE,iDAAmC,CAAA;IACnC,sHAAsH;IACtH,6CAA+B,CAAA;IAC/B,wBAAwB;IACxB,yDAA2C,CAAA;AAC7C,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AA+UD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA4QD,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"}