@wix/auto_sdk_loyalty_programs 1.0.26 → 1.0.28

package/build/cjs/index.d.ts

@@ -26,9 +26,10 @@ interface BulkGetLoyaltyProgramSignature {
 declare function updateLoyaltyProgram$1(httpClient: HttpClient): UpdateLoyaltyProgramSignature;
 interface UpdateLoyaltyProgramSignature {
     /**
-     * Updates the loyalty program.
+     * Updates a site's loyalty program.
      *
-     * You cannot activate the loyalty program using this endpoint. To do so, use the [Activate Loyalty Program endpoint](https://dev.wix.com/api/rest/wix-loyalty-program/program/activate-loyalty-program).
+     * 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, {
@@ -40,7 +41,13 @@ interface ActivateLoyaltyProgramSignature {
     /**
      * Activates a loyalty program.
      *
-     * When a loyalty program is installed it starts in `DRAFT` status. Customers cannot earn or redeem points while the program is not `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 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, 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}`;
@@ -49,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}`;
@@ -65,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}`;
@@ -74,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}`;