@wix/auto_sdk_loyalty_programs 1.0.25 → 1.0.27

package/build/cjs/index.d.ts

@@ -6,9 +6,7 @@ type ProgramNonNullablePaths = `status` | `pointsExpiration.status` | `pointsExp
 declare function getLoyaltyProgram$1(httpClient: HttpClient): GetLoyaltyProgramSignature;
 interface GetLoyaltyProgramSignature {
     /**
-     * Retrieves the site's loyalty program.
-     *
-     * The `getLoyaltyProgram()` function returns a Promise that resolves to the site's loyalty program.
+     * Retrieves the loyalty program.
      */
     (): Promise<NonNullablePaths<GetLoyaltyProgramResponse, {
         [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
@@ -28,13 +26,10 @@ interface BulkGetLoyaltyProgramSignature {
 declare function updateLoyaltyProgram$1(httpClient: HttpClient): UpdateLoyaltyProgramSignature;
 interface UpdateLoyaltyProgramSignature {
     /**
-     * Updates the site's loyalty program.
-     *
-     * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
+     * Updates a site's loyalty program.
      *
-     * 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.
-     *
-     * >**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 - Loyalty program fields to update.
      */
     (loyaltyProgram: LoyaltyProgram): Promise<NonNullablePaths<UpdateLoyaltyProgramResponse, {
@@ -46,19 +41,13 @@ interface ActivateLoyaltyProgramSignature {
     /**
      * Activates a loyalty program.
      *
-     * The `activateLoyaltyProgram()` function returns a Promise that resolves when the status of the loyalty program is successfully changed to `"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"`.
+     * 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"`.
      *
-     * 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.
+     * This method only updates the status of a loyalty program. To make other updates to the program, call Update Loyalty Program.
      *
-     * 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.
      */
     (): Promise<NonNullablePaths<ActivateLoyaltyProgramResponse, {
         [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
@@ -67,7 +56,9 @@ interface ActivateLoyaltyProgramSignature {
 declare function pauseLoyaltyProgram$1(httpClient: HttpClient): PauseLoyaltyProgramSignature;
 interface PauseLoyaltyProgramSignature {
     /**
-     * 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.
      */
     (): Promise<NonNullablePaths<PauseLoyaltyProgramResponse, {
         [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
@@ -83,7 +74,7 @@ interface GetLoyaltyProgramPremiumFeaturesSignature {
 declare function enablePointsExpiration$1(httpClient: HttpClient): EnablePointsExpirationSignature;
 interface EnablePointsExpirationSignature {
     /**
-     * Updates the `pointsExpiration` status to `ENABLED`.
+     * Updates the `pointsExpiration` status to `"ENABLED"`.
      */
     (): Promise<NonNullablePaths<EnablePointsExpirationResponse, {
         [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
@@ -92,7 +83,7 @@ interface EnablePointsExpirationSignature {
 declare function disablePointsExpiration$1(httpClient: HttpClient): DisablePointsExpirationSignature;
 interface DisablePointsExpirationSignature {
     /**
-     * Updates the `pointsExpiration` status to `DISABLED`.
+     * Updates the `pointsExpiration` status to `"DISABLED"`.
      */
     (): Promise<NonNullablePaths<DisablePointsExpirationResponse, {
         [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;