@wix/auto_sdk_loyalty_programs 1.0.15 → 1.0.17

package/build/index.d.mts

@@ -1,101 +0,0 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } 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 } from './loyalty-v1-program-programs.universal-CCZ90Kwf.mjs';
-export { aK as ActionEvent, r as ActivateLoyaltyProgramRequest, O as Asset, an as AssignedFromFloatingReason, aO as BaseEventMetadata, ai as BooleanFeature, m as BulkGetLoyaltyProgramRequest, aD as CancelRequestedReason, ap as ContractSwitchedReason, X as DeleteContext, e as DeleteStatus, I as DisablePointsExpirationRequest, aE as DomainEvent, aF as DomainEventBodyOneOf, aa as Empty, C as EnablePointsExpirationRequest, aG as EntityCreatedEvent, aJ as EntityDeletedEvent, aI as EntityUpdatedEvent, aP as EventMetadata, af as Feature, aA as FeatureCancelled, aB as FeatureCancelledReasonOneOf, ah as FeatureContext, as as FeatureDisabled, at as FeatureDisabledReasonOneOf, ad as FeatureEnabled, ae as FeatureEnabledReasonOneOf, ab as FeatureEvent, ac as FeatureEventEventOneOf, F as FeaturePeriod, ag as FeatureQuantityInfoOneOf, ax as FeatureUpdated, ay as FeatureUpdatedPreviousQuantityInfoOneOf, az as FeatureUpdatedReasonOneOf, g as FocalPoint, u as GetLoyaltyProgramDescriptionRequest, v as GetLoyaltyProgramDescriptionResponse, z as GetLoyaltyProgramPremiumFeaturesRequest, l as GetLoyaltyProgramRequest, aM as IdentificationData, aN as IdentificationDataIdOneOf, s as LoyaltyProgramActivated, y as LoyaltyProgramDescriptionUpdated, aq as ManualFeatureCreationReason, aL as MessageEnvelope, M as MetaSiteSpecialEvent, K as MetaSiteSpecialEventPayloadOneOf, ar as MigratedFromLegacyReason, N as Namespace, a5 as NamespaceChanged, ao as NewFeatureReason, t as PauseLoyaltyProgramRequest, f as PointDefinition, h as PointsExpiration, q as PointsExpirationChanges, p as PointsExpirationConfigurationChanged, J as PointsExpirationDisabled, H as PointsExpirationEnabled, i as PremiumFeatures, n as ProgramInSite, b as ProgramStatus, aQ as ProgramUpdatedEnvelope, aj as QuotaFeature, ak as QuotaInfo, am as ReassignedFromSiteReason, aw as ReassignedToAnotherSiteReason, av as ReplacedByAnotherSubscriptionReason, aH as RestoreInfo, a1 as ServiceProvisioned, a2 as ServiceRemoved, Q as SiteCreated, d as SiteCreatedContext, V as SiteDeleted, a4 as SiteHardDeleted, $ as SiteMarkedAsTemplate, a0 as SiteMarkedAsWixSite, Z as SitePublished, a9 as SitePurgedExternally, a3 as SiteRenamed, R as SiteTransferred, Y as SiteUndeleted, _ as SiteUnpublished, a8 as SiteUrlChanged, k as SocialMediaChannel, j as SocialMediaSettings, c as State, S as Status, a6 as StudioAssigned, a7 as StudioUnassigned, al as TransferredFromAnotherAccountReason, aC as TransferredToAnotherAccountReason, T as Type, au as UnAssingedToFloatingReason, w as UpdateLoyaltyProgramDescriptionRequest, x as UpdateLoyaltyProgramDescriptionResponse, o as UpdateLoyaltyProgramRequest, W as WebhookIdentityType } from './loyalty-v1-program-programs.universal-CCZ90Kwf.mjs';
-import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
-
-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 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: ReturnType<typeof createEventModule<typeof publicOnProgramUpdated>>;
-
-export { ActivateLoyaltyProgramResponse, BulkGetLoyaltyProgramResponse, DisablePointsExpirationResponse, EnablePointsExpirationResponse, GetLoyaltyProgramPremiumFeaturesResponse, GetLoyaltyProgramResponse, LoyaltyProgram, PauseLoyaltyProgramResponse, UpdateLoyaltyProgramResponse, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, onProgramUpdated, pauseLoyaltyProgram, updateLoyaltyProgram };

package/build/index.d.ts

@@ -1,101 +0,0 @@
-import { HttpClient, MaybeContext, BuildRESTFunction } 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 } from './loyalty-v1-program-programs.universal-CCZ90Kwf.js';
-export { aK as ActionEvent, r as ActivateLoyaltyProgramRequest, O as Asset, an as AssignedFromFloatingReason, aO as BaseEventMetadata, ai as BooleanFeature, m as BulkGetLoyaltyProgramRequest, aD as CancelRequestedReason, ap as ContractSwitchedReason, X as DeleteContext, e as DeleteStatus, I as DisablePointsExpirationRequest, aE as DomainEvent, aF as DomainEventBodyOneOf, aa as Empty, C as EnablePointsExpirationRequest, aG as EntityCreatedEvent, aJ as EntityDeletedEvent, aI as EntityUpdatedEvent, aP as EventMetadata, af as Feature, aA as FeatureCancelled, aB as FeatureCancelledReasonOneOf, ah as FeatureContext, as as FeatureDisabled, at as FeatureDisabledReasonOneOf, ad as FeatureEnabled, ae as FeatureEnabledReasonOneOf, ab as FeatureEvent, ac as FeatureEventEventOneOf, F as FeaturePeriod, ag as FeatureQuantityInfoOneOf, ax as FeatureUpdated, ay as FeatureUpdatedPreviousQuantityInfoOneOf, az as FeatureUpdatedReasonOneOf, g as FocalPoint, u as GetLoyaltyProgramDescriptionRequest, v as GetLoyaltyProgramDescriptionResponse, z as GetLoyaltyProgramPremiumFeaturesRequest, l as GetLoyaltyProgramRequest, aM as IdentificationData, aN as IdentificationDataIdOneOf, s as LoyaltyProgramActivated, y as LoyaltyProgramDescriptionUpdated, aq as ManualFeatureCreationReason, aL as MessageEnvelope, M as MetaSiteSpecialEvent, K as MetaSiteSpecialEventPayloadOneOf, ar as MigratedFromLegacyReason, N as Namespace, a5 as NamespaceChanged, ao as NewFeatureReason, t as PauseLoyaltyProgramRequest, f as PointDefinition, h as PointsExpiration, q as PointsExpirationChanges, p as PointsExpirationConfigurationChanged, J as PointsExpirationDisabled, H as PointsExpirationEnabled, i as PremiumFeatures, n as ProgramInSite, b as ProgramStatus, aQ as ProgramUpdatedEnvelope, aj as QuotaFeature, ak as QuotaInfo, am as ReassignedFromSiteReason, aw as ReassignedToAnotherSiteReason, av as ReplacedByAnotherSubscriptionReason, aH as RestoreInfo, a1 as ServiceProvisioned, a2 as ServiceRemoved, Q as SiteCreated, d as SiteCreatedContext, V as SiteDeleted, a4 as SiteHardDeleted, $ as SiteMarkedAsTemplate, a0 as SiteMarkedAsWixSite, Z as SitePublished, a9 as SitePurgedExternally, a3 as SiteRenamed, R as SiteTransferred, Y as SiteUndeleted, _ as SiteUnpublished, a8 as SiteUrlChanged, k as SocialMediaChannel, j as SocialMediaSettings, c as State, S as Status, a6 as StudioAssigned, a7 as StudioUnassigned, al as TransferredFromAnotherAccountReason, aC as TransferredToAnotherAccountReason, T as Type, au as UnAssingedToFloatingReason, w as UpdateLoyaltyProgramDescriptionRequest, x as UpdateLoyaltyProgramDescriptionResponse, o as UpdateLoyaltyProgramRequest, W as WebhookIdentityType } from './loyalty-v1-program-programs.universal-CCZ90Kwf.js';
-import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
-
-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 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: ReturnType<typeof createEventModule<typeof publicOnProgramUpdated>>;
-
-export { ActivateLoyaltyProgramResponse, BulkGetLoyaltyProgramResponse, DisablePointsExpirationResponse, EnablePointsExpirationResponse, GetLoyaltyProgramPremiumFeaturesResponse, GetLoyaltyProgramResponse, LoyaltyProgram, PauseLoyaltyProgramResponse, UpdateLoyaltyProgramResponse, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, onProgramUpdated, pauseLoyaltyProgram, updateLoyaltyProgram };