@wix/auto_sdk_loyalty_programs 1.0.25 → 1.0.27

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

@@ -1,9 +1,8 @@
 import { NonNullablePaths } from '@wix/sdk-types';
 
 /**
- * A loyalty program allows sites to maintain customer reward accounts. Site owners can create a
- * loyalty program to increase customer retention. Read more about the loyalty program in
- * [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
+ * A loyalty program allows sites to maintain customer reward accounts. Wix users can create a
+ * loyalty program to increase customer retention. Read more about the [loyalty program](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
  */
 interface LoyaltyProgram {
     /**
@@ -12,10 +11,11 @@ interface LoyaltyProgram {
      * @maxLength 50
      */
     name?: string | null;
-    /** Information about the program's collectible entity. */
+    /** Details about the program's collectible unit. */
     pointDefinition?: PointDefinition;
     /**
-     * Program status. Customers can only earn or redeem points while the program is `ACTIVE`.
+     * Program status.
+     * Customers can only earn or redeem points while the program is `"ACTIVE"`.
      *
      * Default: `"DRAFT"`
      * @readonly
@@ -43,11 +43,11 @@ interface PointDefinition {
     /**
      * Display name for the program's collectible unit.
      *
-     * It's recommended to use a plural, for example `Stars`.
+     * It's recommended to use a plural, for example `"Stars"`.
      *
      * In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.
      *
-     * Default: `Points`.
+     * Default: `"Points"`.
      * @maxLength 20
      */
     customName?: string | null;
@@ -67,11 +67,15 @@ interface FocalPoint {
 declare enum ProgramStatus {
     /** Unknown program status. */
     UNKNOWN = "UNKNOWN",
-    /** Program was created but is not enabled yet. */
+    /** Program is in draft mode. Customers can't earn or redeem points. */
     DRAFT = "DRAFT",
-    /** Program is active. */
+    /** Program is active. Customers can earn and redeem points. */
     ACTIVE = "ACTIVE",
-    /** Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again. */
+    /**
+     * Program is paused. Customers can't earn or redeem points while the program is paused.
+     *
+     * Set the program to `"ACTIVE"` to resume earning and redeeming points.
+     */
     PAUSED = "PAUSED"
 }
 /** @enumType */
@@ -1371,9 +1375,7 @@ interface ProgramUpdatedEnvelope {
 declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise<void>): void;
 type ProgramNonNullablePaths = `status` | `pointsExpiration.status` | `pointsExpiration.monthsOfInactivity` | `pointsExpiration.expiringPointsPercentage` | `premiumFeatures.loyaltyProgram` | `premiumFeatures.tiers` | `premiumFeatures.pointsExpiration`;
 /**
- * Retrieves the site's loyalty program.
- *
- * The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.
+ * Retrieves the loyalty program.
  * @public
  * @permissionId LOYALTY.READ_PROGRAM
  * @applicableIdentity APP
@@ -1395,13 +1397,10 @@ declare function bulkGetLoyaltyProgram(): Promise<NonNullablePaths<BulkGetLoyalt
     [P in ProgramNonNullablePaths]: `programInSites.${number}.loyaltyProgram.${P}`;
 }[ProgramNonNullablePaths]>>;
 /**
- * Updates the site's loyalty program.
- *
- * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
- *
- * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
+ * Updates a site's loyalty program.
  *
- * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
+ * This method updates the name of the loyalty program and the details of the collectible points unit.
+ * To activate the loyalty program, call Activate Loyalty Program.
  * @param loyaltyProgram - Loyalty program fields to update.
  * @public
  * @requiredField loyaltyProgram
@@ -1415,19 +1414,13 @@ declare function updateLoyaltyProgram(loyaltyProgram: LoyaltyProgram): Promise<N
 /**
  * Activates a loyalty program.
  *
- * The `activateLoyaltyProgram()` function returns a Promise that resolves when the status of the loyalty program is successfully changed to `"ACTIVE"`.
+ * Initially, when a loyalty program is installed, the status is set to `"DRAFT"`.
+ * You can change the program's status to `"ACTIVE"` with this method or through the [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/).
+ * A site's customers can only earn or redeem points while the program is `"ACTIVE"`.
  *
- * Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
+ * This method only updates the status of a loyalty program. To make other updates to the program, call Update Loyalty Program.
  *
- * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
- *
- * To temporarily pause your loyalty program you must follow three steps:
- * 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
- * 1. Hide the loyalty page from your site.
- * 1. Delete the My Rewards page from the Member pages.
- * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
- *
- * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can activate a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
+ * To temporarily pause your loyalty program, call Pause Loyalty Program and see [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
  * @public
  * @permissionId LOYALTY.MANAGE_PROGRAM
  * @applicableIdentity APP
@@ -1437,7 +1430,9 @@ declare function activateLoyaltyProgram(): Promise<NonNullablePaths<ActivateLoya
     [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
 }[ProgramNonNullablePaths]>>;
 /**
- * Changes the program status to `PAUSED`.
+ * Changes the program status to `"PAUSED"`.
+ *
+ * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
  * @public
  * @permissionId LOYALTY.MANAGE_PROGRAM
  * @applicableIdentity APP
@@ -1456,7 +1451,7 @@ declare function pauseLoyaltyProgram(): Promise<NonNullablePaths<PauseLoyaltyPro
  */
 declare function getLoyaltyProgramPremiumFeatures(): Promise<NonNullablePaths<GetLoyaltyProgramPremiumFeaturesResponse, `loyaltyProgram` | `tiers` | `pointsExpiration`>>;
 /**
- * Updates the `pointsExpiration` status to `ENABLED`.
+ * Updates the `pointsExpiration` status to `"ENABLED"`.
  * @public
  * @permissionId LOYALTY.MANAGE_PROGRAM
  * @applicableIdentity APP
@@ -1466,7 +1461,7 @@ declare function enablePointsExpiration(): Promise<NonNullablePaths<EnablePoints
     [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
 }[ProgramNonNullablePaths]>>;
 /**
- * Updates the `pointsExpiration` status to `DISABLED`.
+ * Updates the `pointsExpiration` status to `"DISABLED"`.
  * @public
  * @permissionId LOYALTY.MANAGE_PROGRAM
  * @applicableIdentity APP