@wix/auto_sdk_loyalty_programs 1.0.20 → 1.0.22

package/build/internal/cjs/index.d.ts

@@ -1 +1,101 @@
-export * from './src/loyalty-v1-program-programs.context.js';
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetLoyaltyProgramResponse, B as BulkGetLoyaltyProgramResponse, L as LoyaltyProgram, U as UpdateLoyaltyProgramResponse, A as ActivateLoyaltyProgramResponse, P as PauseLoyaltyProgramResponse, a as GetLoyaltyProgramPremiumFeaturesResponse, E as EnablePointsExpirationResponse, D as DisablePointsExpirationResponse, b as ProgramUpdatedEnvelope } from './loyalty-v1-program-programs.universal-CEkDSoxz.js';
+export { aP as ActionEvent, s as ActivateLoyaltyProgramRequest, Q as Asset, as as AssignedFromFloatingReason, aT as BaseEventMetadata, an as BooleanFeature, n as BulkGetLoyaltyProgramRequest, aI as CancelRequestedReason, au as ContractSwitchedReason, Y as DeleteContext, f as DeleteStatus, J as DisablePointsExpirationRequest, aJ as DomainEvent, aK as DomainEventBodyOneOf, af as Empty, H as EnablePointsExpirationRequest, aL as EntityCreatedEvent, aO as EntityDeletedEvent, aN as EntityUpdatedEvent, aU as EventMetadata, ak as Feature, aF as FeatureCancelled, aG as FeatureCancelledReasonOneOf, am as FeatureContext, ax as FeatureDisabled, ay as FeatureDisabledReasonOneOf, ai as FeatureEnabled, aj as FeatureEnabledReasonOneOf, ag as FeatureEvent, ah as FeatureEventEventOneOf, F as FeaturePeriod, al as FeatureQuantityInfoOneOf, aC as FeatureUpdated, aD as FeatureUpdatedPreviousQuantityInfoOneOf, aE as FeatureUpdatedReasonOneOf, h as FocalPoint, v as GetLoyaltyProgramDescriptionRequest, w as GetLoyaltyProgramDescriptionResponse, C as GetLoyaltyProgramPremiumFeaturesRequest, m as GetLoyaltyProgramRequest, aR as IdentificationData, aS as IdentificationDataIdOneOf, t as LoyaltyProgramActivated, z as LoyaltyProgramDescriptionUpdated, av as ManualFeatureCreationReason, aQ as MessageEnvelope, M as MetaSiteSpecialEvent, O as MetaSiteSpecialEventPayloadOneOf, aw as MigratedFromLegacyReason, N as Namespace, a6 as NamespaceChanged, at as NewFeatureReason, ab as OdeditorAssigned, ac as OdeditorUnassigned, u as PauseLoyaltyProgramRequest, ad as PicassoAssigned, ae as PicassoUnassigned, g as PointDefinition, i as PointsExpiration, r as PointsExpirationChanges, q as PointsExpirationConfigurationChanged, K as PointsExpirationDisabled, I as PointsExpirationEnabled, j as PremiumFeatures, o as ProgramInSite, c as ProgramStatus, ao as QuotaFeature, ap as QuotaInfo, ar as ReassignedFromSiteReason, aB as ReassignedToAnotherSiteReason, aA as ReplacedByAnotherSubscriptionReason, aM as RestoreInfo, a2 as ServiceProvisioned, a3 as ServiceRemoved, R as SiteCreated, e as SiteCreatedContext, X as SiteDeleted, a5 as SiteHardDeleted, a0 as SiteMarkedAsTemplate, a1 as SiteMarkedAsWixSite, _ as SitePublished, aa as SitePurgedExternally, a4 as SiteRenamed, V as SiteTransferred, Z as SiteUndeleted, $ as SiteUnpublished, a9 as SiteUrlChanged, l as SocialMediaChannel, k as SocialMediaSettings, d as State, S as Status, a7 as StudioAssigned, a8 as StudioUnassigned, aq as TransferredFromAnotherAccountReason, aH as TransferredToAnotherAccountReason, T as Type, az as UnAssingedToFloatingReason, x as UpdateLoyaltyProgramDescriptionRequest, y as UpdateLoyaltyProgramDescriptionResponse, p as UpdateLoyaltyProgramRequest, W as WebhookIdentityType } from './loyalty-v1-program-programs.universal-CEkDSoxz.js';
+
+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.
+     */
+    (): Promise<GetLoyaltyProgramResponse>;
+}
+declare function bulkGetLoyaltyProgram$1(httpClient: HttpClient): BulkGetLoyaltyProgramSignature;
+interface BulkGetLoyaltyProgramSignature {
+    /**
+     * Retrieves loyalty programs for all metasites that the caller is a member of.
+     *
+     * Must be called with user identity.
+     */
+    (): Promise<BulkGetLoyaltyProgramResponse>;
+}
+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.
+     *
+     * 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 - Loyalty program fields to update.
+     */
+    (loyaltyProgram: LoyaltyProgram): Promise<UpdateLoyaltyProgramResponse>;
+}
+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.
+     */
+    (): Promise<ActivateLoyaltyProgramResponse>;
+}
+declare function pauseLoyaltyProgram$1(httpClient: HttpClient): PauseLoyaltyProgramSignature;
+interface PauseLoyaltyProgramSignature {
+    /**
+     * Changes the program status to `PAUSED`.
+     */
+    (): Promise<PauseLoyaltyProgramResponse>;
+}
+declare function getLoyaltyProgramPremiumFeatures$1(httpClient: HttpClient): GetLoyaltyProgramPremiumFeaturesSignature;
+interface GetLoyaltyProgramPremiumFeaturesSignature {
+    /**
+     * Retrieves information about the available loyalty program premium features.
+     */
+    (): Promise<GetLoyaltyProgramPremiumFeaturesResponse>;
+}
+declare function enablePointsExpiration$1(httpClient: HttpClient): EnablePointsExpirationSignature;
+interface EnablePointsExpirationSignature {
+    /**
+     * Updates the `pointsExpiration` status to `ENABLED`.
+     */
+    (): Promise<EnablePointsExpirationResponse>;
+}
+declare function disablePointsExpiration$1(httpClient: HttpClient): DisablePointsExpirationSignature;
+interface DisablePointsExpirationSignature {
+    /**
+     * Updates the `pointsExpiration` status to `DISABLED`.
+     */
+    (): Promise<DisablePointsExpirationResponse>;
+}
+declare const onProgramUpdated$1: EventDefinition<ProgramUpdatedEnvelope, "wix.loyalty.v1.program_updated">;
+
+declare const getLoyaltyProgram: MaybeContext<BuildRESTFunction<typeof getLoyaltyProgram$1> & typeof getLoyaltyProgram$1>;
+declare const bulkGetLoyaltyProgram: MaybeContext<BuildRESTFunction<typeof bulkGetLoyaltyProgram$1> & typeof bulkGetLoyaltyProgram$1>;
+declare const updateLoyaltyProgram: MaybeContext<BuildRESTFunction<typeof updateLoyaltyProgram$1> & typeof updateLoyaltyProgram$1>;
+declare const activateLoyaltyProgram: MaybeContext<BuildRESTFunction<typeof activateLoyaltyProgram$1> & typeof activateLoyaltyProgram$1>;
+declare const pauseLoyaltyProgram: MaybeContext<BuildRESTFunction<typeof pauseLoyaltyProgram$1> & typeof pauseLoyaltyProgram$1>;
+declare const getLoyaltyProgramPremiumFeatures: MaybeContext<BuildRESTFunction<typeof getLoyaltyProgramPremiumFeatures$1> & typeof getLoyaltyProgramPremiumFeatures$1>;
+declare const enablePointsExpiration: MaybeContext<BuildRESTFunction<typeof enablePointsExpiration$1> & typeof enablePointsExpiration$1>;
+declare const disablePointsExpiration: MaybeContext<BuildRESTFunction<typeof disablePointsExpiration$1> & typeof disablePointsExpiration$1>;
+/**
+ * Triggered when a loyalty program is updated.
+ */
+declare const onProgramUpdated: BuildEventDefinition<typeof onProgramUpdated$1>;
+
+export { ActivateLoyaltyProgramResponse, BulkGetLoyaltyProgramResponse, DisablePointsExpirationResponse, EnablePointsExpirationResponse, GetLoyaltyProgramPremiumFeaturesResponse, GetLoyaltyProgramResponse, LoyaltyProgram, PauseLoyaltyProgramResponse, ProgramUpdatedEnvelope, UpdateLoyaltyProgramResponse, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, onProgramUpdated, pauseLoyaltyProgram, updateLoyaltyProgram };