@wix/auto_sdk_loyalty_rewards 1.0.15 → 1.0.16

package/build/es/index.typings.d.mts

@@ -56,13 +56,11 @@ declare enum RewardType {
     UNDEFINED = "UNDEFINED",
     /** Discount reward. Special flexible reward type used in checkout. */
     DISCOUNT_AMOUNT = "DISCOUNT_AMOUNT",
-    /** Coupon reward. [Learn more about coupons.](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards) */
-    COUPON_REWARD = "COUPON_REWARD",
-    /** For internal use. */
-    SPI_DISCOUNT_AMOUNT = "SPI_DISCOUNT_AMOUNT"
+    /** Coupon reward. [Learn more about coupons](https://support.wix.com/en/article/using-coupons-as-loyalty-rewards). */
+    COUPON_REWARD = "COUPON_REWARD"
 }
 /** @enumType */
-type RewardTypeWithLiterals = RewardType | 'UNDEFINED' | 'DISCOUNT_AMOUNT' | 'COUPON_REWARD' | 'SPI_DISCOUNT_AMOUNT';
+type RewardTypeWithLiterals = RewardType | 'UNDEFINED' | 'DISCOUNT_AMOUNT' | 'COUPON_REWARD';
 interface DiscountAmount {
     /**
      * Discount details for each tier.
@@ -99,11 +97,12 @@ interface CouponReward extends CouponRewardDiscountTypeOneOf, CouponRewardScopeO
     /** Limit the coupon to carts with a subtotal greater than this number. */
     minimumSubtotal?: number;
     /**
-     * Specifies the type of line items this coupon will apply to.
-     * For more information, see [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).
+     * Specifies the type of line items this coupon applies to.
+     *
+     * For more information, see [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values).
      */
     scope?: CouponScope;
-    /** Whether the coupon is limited to one item. */
+    /** Whether the coupon is limited to 1 item. */
     limitedToOneItem?: boolean | null;
     /** Whether the coupon also applies to subscriptions. */
     appliesToSubscriptions?: boolean | null;
@@ -131,8 +130,9 @@ interface CouponRewardScopeOrMinSubtotalOneOf {
     /** Limit the coupon to carts with a subtotal greater than this number. */
     minimumSubtotal?: number;
     /**
-     * Specifies the type of line items this coupon will apply to.
-     * For more information, see [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values).
+     * Specifies the type of line items this coupon applies to.
+     *
+     * For more information, see [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values).
      */
     scope?: CouponScope;
 }
@@ -207,13 +207,13 @@ interface CouponScope {
     /**
      * Scope namespace.
      *
-     * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid namespaces.
+     * See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values) for valid namespaces.
      */
     namespace?: string;
     /**
      * Coupon scope's applied group.
      *
-     * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.
+     * See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values) for valid groups.
      */
     group?: Group;
 }
@@ -221,10 +221,10 @@ interface Group {
     /**
      * Name of coupon scope's group.
      *
-     * See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values) for valid groups.
+     * See [valid scope values](https://dev.wix.com/docs/rest/business-management/marketing/coupons/coupons/valid-scope-values) for valid groups.
      */
     name?: string;
-    /** Entity ID, if the coupon scope is limited to just one item. */
+    /** Entity ID, if the coupon scope is limited to just 1 item. */
     entityId?: string | null;
 }
 interface SpiDiscountAmount {
@@ -314,7 +314,7 @@ interface BulkGetRewardsResponse {
 }
 interface RewardsInSite {
     /**
-     * Metasite id.
+     * Metasite ID.
      * @format GUID
      */
     metaSiteId?: string;
@@ -335,13 +335,13 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Filter object.
      *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
      * Sort object.
      *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -433,7 +433,7 @@ interface DeleteRewardRequest {
     /**
      * Revision number, which increments by 1 each time the reward is updated.
      *
-     * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.
+     * To prevent conflicting changes, pass the current `revision` when deleting the reward.
      */
     revision?: string;
 }
@@ -463,7 +463,7 @@ interface PagingMetadataV2 {
 }
 interface ListRewardsInTierRequest {
     /**
-     * Tier id.
+     * Tier ID.
      * @format GUID
      * @readonly
      */
@@ -482,25 +482,21 @@ interface DomainEvent extends DomainEventBodyOneOf {
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For 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
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 */
+    /** 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
@@ -510,12 +506,8 @@ interface DomainEvent extends DomainEventBodyOneOf {
     /** 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.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
 }
@@ -541,7 +533,7 @@ interface EntityUpdatedEvent {
     currentEntity?: string;
 }
 interface EntityDeletedEvent {
-    /** Entity that was deleted */
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
 interface ActionEvent {
@@ -636,25 +628,21 @@ interface BaseEventMetadata {
     identity?: IdentificationData;
 }
 interface EventMetadata extends BaseEventMetadata {
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For 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
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 */
+    /** 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
@@ -664,12 +652,8 @@ interface EventMetadata extends BaseEventMetadata {
     /** 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.
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
      */
     entityEventSequence?: string | null;
 }
@@ -683,6 +667,8 @@ interface RewardCreatedEnvelope {
  * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
  * @permissionScope Manage Loyalty
  * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionId LOYALTY.READ_REWARDS
  * @webhook
  * @eventType wix.loyalty.v1.reward_created
@@ -699,6 +685,8 @@ interface RewardDeletedEnvelope {
  * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
  * @permissionScope Manage Loyalty
  * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionId LOYALTY.READ_REWARDS
  * @webhook
  * @eventType wix.loyalty.v1.reward_deleted
@@ -716,6 +704,8 @@ interface RewardUpdatedEnvelope {
  * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
  * @permissionScope Manage Loyalty
  * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
  * @permissionId LOYALTY.READ_REWARDS
  * @webhook
  * @eventType wix.loyalty.v1.reward_updated
@@ -725,24 +715,23 @@ interface RewardUpdatedEnvelope {
 declare function onRewardUpdated(handler: (event: RewardUpdatedEnvelope) => void | Promise<void>): void;
 type RewardNonNullablePaths = `discountAmount.configsByTier` | `discountAmount.configsByTier.${number}.amount` | `discountAmount.configsByTier.${number}.costInPoints` | `couponReward.fixedAmount.configsByTier` | `couponReward.fixedAmount.configsByTier.${number}.costInPoints` | `couponReward.fixedAmount.configsByTier.${number}.amount` | `couponReward.percentage.configsByTier` | `couponReward.percentage.configsByTier.${number}.costInPoints` | `couponReward.percentage.configsByTier.${number}.percentage` | `couponReward.freeShipping.configsByTier` | `couponReward.freeShipping.configsByTier.${number}.costInPoints` | `couponReward.minimumSubtotal` | `couponReward.scope.namespace` | `couponReward.scope.group.name` | `name` | `active` | `type`;
 /**
- * Creates a reward that can be redeemed with loyalty points.
+ * Creates a reward that customers can redeem with loyalty points.
  *
- * When a customer [redeems a reward](/coupons/redeem-points-for-coupon), a loyalty coupon is created
- * based on the specifications detailed in either the `discountAmount` or `couponReward` fields. This coupon can
- * then be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
- * no coupon is actually created until a [reward is redeemed](/coupons/redeem-points-for-coupon) with points.
- * See the [Coupons API](https://dev.wix.com/api/rest/coupons) for more information about coupons. The `type` of reward
- * cannot be updated.
+ * When a customer redeems a reward, a loyalty coupon is created
+ * based on the specifications detailed in the `discountAmount` or `couponReward` fields. The customer can
+ * then use this coupon to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
+ * no coupon is actually created until a customer redeems a reward with points.
+ * See the Coupons API for more information about coupons. You can't update the `type` of reward after it's created.
  *
  * A reward's `active` status defaults to `false`. To make the reward available to customers,
- * either set the `active` field to `true` during creation or call [Update Reward](/update-reward)
+ * either set the `active` field to `true` during creation or call Update Reward
  * to change the status.
  *
- * To customize a reward for each [loyalty tier](/tiers), use the `configsByTier` parameter.
+ * To customize a reward for each loyalty tier, use `configsByTier`.
  * This allows you to specify the amount of the earned discount, the cost in loyalty points
  * to redeem the reward, and the tier to which this configuration applies. Each tier requires its own
- * `configsByTier` configuration. To create a reward that is available to loyalty accounts in the base tier,
- * leave the `tierId` field empty. See the [Tiers API](/tiers) for more information on tiers.
+ * `configsByTier` configuration. To create a reward that's available to loyalty accounts in the base tier,
+ * leave the `tierId` field empty. See the Tiers API for more information on tiers.
  * @param reward - Reward to create.
  * @public
  * @requiredField reward
@@ -779,11 +768,10 @@ declare function bulkCreateRewards(rewards: NonNullablePaths<Reward, `name`>[]):
  */
 declare function getReward(_id: string): Promise<NonNullablePaths<Reward, RewardNonNullablePaths>>;
 /**
- * Retrieves rewards from all metasites that the caller is the member of.
+ * Retrieves rewards from all metasites that the caller is a member of.
  *
  * Must be called with user identity.
  * @public
- * @documentationMaturity preview
  * @permissionId LOYALTY.REWARD_BULK_READ
  * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.BulkGetRewards
  */
@@ -791,11 +779,11 @@ declare function bulkGetRewards(): Promise<NonNullablePaths<BulkGetRewardsRespon
     [P in RewardNonNullablePaths]: `rewardsInSite.${number}.rewards.${number}.${P}`;
 }[RewardNonNullablePaths]>>;
 /**
- * Retrieves a list of rewards, given the provided paging, filtering, and sorting.
+ * Retrieves a list of rewards with the specified paging, filtering, and sorting.
  *
  * Query Rewards runs with these defaults, which you can override: `cursorPaging.limit` is `50`.
  *
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+ * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language),[Sorting and Paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging),and [Field Projection](https://dev.wix.com/docs/rest/articles/get-started/field-projection).
  * @param query - Query parameters.
  * @public
  * @requiredField query
@@ -810,10 +798,10 @@ declare function queryRewards(query: CursorQuery): Promise<NonNullablePaths<Quer
 /**
  * Updates a loyalty reward.
  *
- * Use this endpoint to update details of a reward, such as the name, whether or not a reward is active,
- * or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.
+ * Call this method to update details of a reward, such as the name, whether a reward is active,
+ * or the amount of points it costs to redeem. Also call this method to add new tiers that are eligible to redeem a reward.
  *
- * You may not change the `type` of a reward. That is set upon creation and cannot be updated.
+ * You may not change the `type` of a reward. That's set upon creation and can't be updated.
  * @param _id - Reward ID.
  * @public
  * @requiredField _id
@@ -872,7 +860,7 @@ interface UpdateReward {
  * @param _id - ID of the reward to delete.
  * @param revision - Revision number, which increments by 1 each time the reward is updated.
  *
- * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.
+ * To prevent conflicting changes, pass the current `revision` when deleting the reward.
  * @public
  * @requiredField _id
  * @requiredField revision

package/build/es/index.typings.mjs

@@ -417,7 +417,6 @@ var RewardType = /* @__PURE__ */ ((RewardType2) => {
   RewardType2["UNDEFINED"] = "UNDEFINED";
   RewardType2["DISCOUNT_AMOUNT"] = "DISCOUNT_AMOUNT";
   RewardType2["COUPON_REWARD"] = "COUPON_REWARD";
-  RewardType2["SPI_DISCOUNT_AMOUNT"] = "SPI_DISCOUNT_AMOUNT";
   return RewardType2;
 })(RewardType || {});
 var SortOrder = /* @__PURE__ */ ((SortOrder2) => {