@wix/auto_sdk_loyalty_programs 1.0.23 → 1.0.24

package/build/internal/es/{loyalty-v1-program-programs.universal-CEkDSoxz.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+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
@@ -1352,5 +1354,126 @@ interface ProgramUpdatedEnvelope {
     entity: LoyaltyProgram;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a loyalty program is updated.
+ * @permissionScope Read Loyalty
+ * @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_PROGRAM
+ * @webhook
+ * @eventType wix.loyalty.v1.program_updated
+ * @serviceIdentifier com.wixpress.loyalty.program.LoyaltyPrograms
+ * @slug updated
+ */
+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.
+ * @public
+ * @permissionId LOYALTY.READ_PROGRAM
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.GetLoyaltyProgram
+ */
+declare function getLoyaltyProgram(): Promise<NonNullablePaths<GetLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Retrieves loyalty programs for all metasites that the caller is a member of.
+ *
+ * Must be called with user identity.
+ * @public
+ * @permissionId LOYALTY.PROGRAM_BULK_READ
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.BulkGetLoyaltyProgram
+ */
+declare function bulkGetLoyaltyProgram(): Promise<NonNullablePaths<BulkGetLoyaltyProgramResponse, `programInSites` | `programInSites.${number}.metaSiteId` | {
+    [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.
+ *
+ * >**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.
+ * @param loyaltyProgram - Loyalty program fields to update.
+ * @public
+ * @requiredField loyaltyProgram
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.UpdateLoyaltyProgram
+ */
+declare function updateLoyaltyProgram(loyaltyProgram: LoyaltyProgram): Promise<NonNullablePaths<UpdateLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * 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.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.ActivateLoyaltyProgram
+ */
+declare function activateLoyaltyProgram(): Promise<NonNullablePaths<ActivateLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Changes the program status to `PAUSED`.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.PauseLoyaltyProgram
+ */
+declare function pauseLoyaltyProgram(): Promise<NonNullablePaths<PauseLoyaltyProgramResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Retrieves information about the available loyalty program premium features.
+ * @public
+ * @permissionId LOYALTY.READ_PROGRAM
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.GetLoyaltyProgramPremiumFeatures
+ */
+declare function getLoyaltyProgramPremiumFeatures(): Promise<NonNullablePaths<GetLoyaltyProgramPremiumFeaturesResponse, `loyaltyProgram` | `tiers` | `pointsExpiration`>>;
+/**
+ * Updates the `pointsExpiration` status to `ENABLED`.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.EnablePointsExpiration
+ */
+declare function enablePointsExpiration(): Promise<NonNullablePaths<EnablePointsExpirationResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Updates the `pointsExpiration` status to `DISABLED`.
+ * @public
+ * @permissionId LOYALTY.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.program.LoyaltyPrograms.DisablePointsExpiration
+ */
+declare function disablePointsExpiration(): Promise<NonNullablePaths<DisablePointsExpirationResponse, {
+    [P in ProgramNonNullablePaths]: `loyaltyProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
 
-export { type SiteUnpublished as $, type ActivateLoyaltyProgramResponse as A, type BulkGetLoyaltyProgramResponse as B, type GetLoyaltyProgramPremiumFeaturesRequest as C, type DisablePointsExpirationResponse as D, type EnablePointsExpirationResponse as E, FeaturePeriod as F, type GetLoyaltyProgramResponse as G, type EnablePointsExpirationRequest as H, type PointsExpirationEnabled as I, type DisablePointsExpirationRequest as J, type PointsExpirationDisabled as K, type LoyaltyProgram as L, type MetaSiteSpecialEvent as M, Namespace as N, type MetaSiteSpecialEventPayloadOneOf as O, type PauseLoyaltyProgramResponse as P, type Asset as Q, type SiteCreated as R, Status as S, Type as T, type UpdateLoyaltyProgramResponse as U, type SiteTransferred as V, WebhookIdentityType as W, type SiteDeleted as X, type DeleteContext as Y, type SiteUndeleted as Z, type SitePublished as _, type GetLoyaltyProgramPremiumFeaturesResponse as a, type SiteMarkedAsTemplate as a0, type SiteMarkedAsWixSite as a1, type ServiceProvisioned as a2, type ServiceRemoved as a3, type SiteRenamed as a4, type SiteHardDeleted as a5, type NamespaceChanged as a6, type StudioAssigned as a7, type StudioUnassigned as a8, type SiteUrlChanged as a9, type ReplacedByAnotherSubscriptionReason as aA, type ReassignedToAnotherSiteReason as aB, type FeatureUpdated as aC, type FeatureUpdatedPreviousQuantityInfoOneOf as aD, type FeatureUpdatedReasonOneOf as aE, type FeatureCancelled as aF, type FeatureCancelledReasonOneOf as aG, type TransferredToAnotherAccountReason as aH, type CancelRequestedReason as aI, type DomainEvent as aJ, type DomainEventBodyOneOf as aK, type EntityCreatedEvent as aL, type RestoreInfo as aM, type EntityUpdatedEvent as aN, type EntityDeletedEvent as aO, type ActionEvent as aP, type MessageEnvelope as aQ, type IdentificationData as aR, type IdentificationDataIdOneOf as aS, type BaseEventMetadata as aT, type EventMetadata as aU, type SitePurgedExternally as aa, type OdeditorAssigned as ab, type OdeditorUnassigned as ac, type PicassoAssigned as ad, type PicassoUnassigned as ae, type Empty as af, type FeatureEvent as ag, type FeatureEventEventOneOf as ah, type FeatureEnabled as ai, type FeatureEnabledReasonOneOf as aj, type Feature as ak, type FeatureQuantityInfoOneOf as al, type FeatureContext as am, type BooleanFeature as an, type QuotaFeature as ao, type QuotaInfo as ap, type TransferredFromAnotherAccountReason as aq, type ReassignedFromSiteReason as ar, type AssignedFromFloatingReason as as, type NewFeatureReason as at, type ContractSwitchedReason as au, type ManualFeatureCreationReason as av, type MigratedFromLegacyReason as aw, type FeatureDisabled as ax, type FeatureDisabledReasonOneOf as ay, type UnAssingedToFloatingReason as az, type ProgramUpdatedEnvelope as b, ProgramStatus as c, State as d, SiteCreatedContext as e, DeleteStatus as f, type PointDefinition as g, type FocalPoint as h, type PointsExpiration as i, type PremiumFeatures as j, type SocialMediaSettings as k, type SocialMediaChannel as l, type GetLoyaltyProgramRequest as m, type BulkGetLoyaltyProgramRequest as n, type ProgramInSite as o, type UpdateLoyaltyProgramRequest as p, type PointsExpirationConfigurationChanged as q, type PointsExpirationChanges as r, type ActivateLoyaltyProgramRequest as s, type LoyaltyProgramActivated as t, type PauseLoyaltyProgramRequest as u, type GetLoyaltyProgramDescriptionRequest as v, type GetLoyaltyProgramDescriptionResponse as w, type UpdateLoyaltyProgramDescriptionRequest as x, type UpdateLoyaltyProgramDescriptionResponse as y, type LoyaltyProgramDescriptionUpdated as z };
+export { type ActionEvent, type ActivateLoyaltyProgramRequest, type ActivateLoyaltyProgramResponse, type Asset, type AssignedFromFloatingReason, type BaseEventMetadata, type BooleanFeature, type BulkGetLoyaltyProgramRequest, type BulkGetLoyaltyProgramResponse, type CancelRequestedReason, type ContractSwitchedReason, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DisablePointsExpirationRequest, type DisablePointsExpirationResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EnablePointsExpirationRequest, type EnablePointsExpirationResponse, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Feature, type FeatureCancelled, type FeatureCancelledReasonOneOf, type FeatureContext, type FeatureDisabled, type FeatureDisabledReasonOneOf, type FeatureEnabled, type FeatureEnabledReasonOneOf, type FeatureEvent, type FeatureEventEventOneOf, FeaturePeriod, type FeaturePeriodWithLiterals, type FeatureQuantityInfoOneOf, type FeatureUpdated, type FeatureUpdatedPreviousQuantityInfoOneOf, type FeatureUpdatedReasonOneOf, type FocalPoint, type GetLoyaltyProgramDescriptionRequest, type GetLoyaltyProgramDescriptionResponse, type GetLoyaltyProgramPremiumFeaturesRequest, type GetLoyaltyProgramPremiumFeaturesResponse, type GetLoyaltyProgramRequest, type GetLoyaltyProgramResponse, type IdentificationData, type IdentificationDataIdOneOf, type LoyaltyProgram, type LoyaltyProgramActivated, type LoyaltyProgramDescriptionUpdated, type ManualFeatureCreationReason, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type MigratedFromLegacyReason, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type NewFeatureReason, type OdeditorAssigned, type OdeditorUnassigned, type PauseLoyaltyProgramRequest, type PauseLoyaltyProgramResponse, type PicassoAssigned, type PicassoUnassigned, type PointDefinition, type PointsExpiration, type PointsExpirationChanges, type PointsExpirationConfigurationChanged, type PointsExpirationDisabled, type PointsExpirationEnabled, type PremiumFeatures, type ProgramInSite, ProgramStatus, type ProgramStatusWithLiterals, type ProgramUpdatedEnvelope, type QuotaFeature, type QuotaInfo, type ReassignedFromSiteReason, type ReassignedToAnotherSiteReason, type ReplacedByAnotherSubscriptionReason, type RestoreInfo, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, type SocialMediaChannel, type SocialMediaSettings, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioUnassigned, type TransferredFromAnotherAccountReason, type TransferredToAnotherAccountReason, Type, type TypeWithLiterals, type UnAssingedToFloatingReason, type UpdateLoyaltyProgramDescriptionRequest, type UpdateLoyaltyProgramDescriptionResponse, type UpdateLoyaltyProgramRequest, type UpdateLoyaltyProgramResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, onProgramUpdated, pauseLoyaltyProgram, updateLoyaltyProgram };