@wix/auto_sdk_loyalty_programs 1.0.24 → 1.0.26

package/build/cjs/index.d.ts

@@ -1,15 +1,16 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { GetLoyaltyProgramResponse, BulkGetLoyaltyProgramResponse, LoyaltyProgram, UpdateLoyaltyProgramResponse, ActivateLoyaltyProgramResponse, PauseLoyaltyProgramResponse, GetLoyaltyProgramPremiumFeaturesResponse, EnablePointsExpirationResponse, DisablePointsExpirationResponse, ProgramUpdatedEnvelope } from './index.typings.js';
 export { ActionEvent, ActivateLoyaltyProgramRequest, Asset, AssignedFromFloatingReason, BaseEventMetadata, BooleanFeature, BulkGetLoyaltyProgramRequest, CancelRequestedReason, ContractSwitchedReason, DeleteContext, DeleteStatus, DisablePointsExpirationRequest, DomainEvent, DomainEventBodyOneOf, Empty, EnablePointsExpirationRequest, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Feature, FeatureCancelled, FeatureCancelledReasonOneOf, FeatureContext, FeatureDisabled, FeatureDisabledReasonOneOf, FeatureEnabled, FeatureEnabledReasonOneOf, FeatureEvent, FeatureEventEventOneOf, FeaturePeriod, FeatureQuantityInfoOneOf, FeatureUpdated, FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf, FocalPoint, GetLoyaltyProgramDescriptionRequest, GetLoyaltyProgramDescriptionResponse, GetLoyaltyProgramPremiumFeaturesRequest, GetLoyaltyProgramRequest, IdentificationData, IdentificationDataIdOneOf, LoyaltyProgramActivated, LoyaltyProgramDescriptionUpdated, ManualFeatureCreationReason, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, MigratedFromLegacyReason, Namespace, NamespaceChanged, NewFeatureReason, OdeditorAssigned, OdeditorUnassigned, PauseLoyaltyProgramRequest, PicassoAssigned, PicassoUnassigned, PointDefinition, PointsExpiration, PointsExpirationChanges, PointsExpirationConfigurationChanged, PointsExpirationDisabled, PointsExpirationEnabled, PremiumFeatures, ProgramInSite, ProgramStatus, QuotaFeature, QuotaInfo, ReassignedFromSiteReason, ReassignedToAnotherSiteReason, ReplacedByAnotherSubscriptionReason, RestoreInfo, ServiceProvisioned, ServiceRemoved, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SocialMediaChannel, SocialMediaSettings, State, Status, StudioAssigned, StudioUnassigned, TransferredFromAnotherAccountReason, TransferredToAnotherAccountReason, Type, UnAssingedToFloatingReason, UpdateLoyaltyProgramDescriptionRequest, UpdateLoyaltyProgramDescriptionResponse, UpdateLoyaltyProgramRequest, WebhookIdentityType } from './index.typings.js';
 
+type ProgramNonNullablePaths = `status` | `pointsExpiration.status` | `pointsExpiration.monthsOfInactivity` | `pointsExpiration.expiringPointsPercentage` | `premiumFeatures.loyaltyProgram` | `premiumFeatures.tiers` | `premiumFeatures.pointsExpiration`;
 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<GetLoyaltyProgramResponse>;
+    (): Promise<NonNullablePaths<GetLoyaltyProgramResponse, {
+        [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 declare function bulkGetLoyaltyProgram$1(httpClient: HttpClient): BulkGetLoyaltyProgramSignature;
 interface BulkGetLoyaltyProgramSignature {
@@ -18,70 +19,66 @@ interface BulkGetLoyaltyProgramSignature {
      *
      * Must be called with user identity.
      */
-    (): Promise<BulkGetLoyaltyProgramResponse>;
+    (): Promise<NonNullablePaths<BulkGetLoyaltyProgramResponse, `programInSites` | `programInSites.${number}.metaSiteId` | {
+        [P in ProgramNonNullablePaths]: `programInSites.${number}.loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 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 the 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.
+     * 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).
      * @param - Loyalty program fields to update.
      */
-    (loyaltyProgram: LoyaltyProgram): Promise<UpdateLoyaltyProgramResponse>;
+    (loyaltyProgram: LoyaltyProgram): Promise<NonNullablePaths<UpdateLoyaltyProgramResponse, {
+        [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 declare function activateLoyaltyProgram$1(httpClient: HttpClient): ActivateLoyaltyProgramSignature;
 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"`.
-     *
-     * 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.
+     * When a loyalty program is installed it starts in `DRAFT` status. Customers cannot earn or redeem points while the program is not `ACTIVE`.
      */
-    (): Promise<ActivateLoyaltyProgramResponse>;
+    (): Promise<NonNullablePaths<ActivateLoyaltyProgramResponse, {
+        [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 declare function pauseLoyaltyProgram$1(httpClient: HttpClient): PauseLoyaltyProgramSignature;
 interface PauseLoyaltyProgramSignature {
     /**
      * Changes the program status to `PAUSED`.
      */
-    (): Promise<PauseLoyaltyProgramResponse>;
+    (): Promise<NonNullablePaths<PauseLoyaltyProgramResponse, {
+        [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 declare function getLoyaltyProgramPremiumFeatures$1(httpClient: HttpClient): GetLoyaltyProgramPremiumFeaturesSignature;
 interface GetLoyaltyProgramPremiumFeaturesSignature {
     /**
      * Retrieves information about the available loyalty program premium features.
      */
-    (): Promise<GetLoyaltyProgramPremiumFeaturesResponse>;
+    (): Promise<NonNullablePaths<GetLoyaltyProgramPremiumFeaturesResponse, `loyaltyProgram` | `tiers` | `pointsExpiration`>>;
 }
 declare function enablePointsExpiration$1(httpClient: HttpClient): EnablePointsExpirationSignature;
 interface EnablePointsExpirationSignature {
     /**
      * Updates the `pointsExpiration` status to `ENABLED`.
      */
-    (): Promise<EnablePointsExpirationResponse>;
+    (): Promise<NonNullablePaths<EnablePointsExpirationResponse, {
+        [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 declare function disablePointsExpiration$1(httpClient: HttpClient): DisablePointsExpirationSignature;
 interface DisablePointsExpirationSignature {
     /**
      * Updates the `pointsExpiration` status to `DISABLED`.
      */
-    (): Promise<DisablePointsExpirationResponse>;
+    (): Promise<NonNullablePaths<DisablePointsExpirationResponse, {
+        [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+    }[ProgramNonNullablePaths]>>;
 }
 declare const onProgramUpdated$1: EventDefinition<ProgramUpdatedEnvelope, "wix.loyalty.v1.program_updated">;