@wix/auto_sdk_loyalty_programs 1.0.15 → 1.0.17

package/build/internal/es/src/loyalty-v1-program-programs.public.d.ts

@@ -0,0 +1,88 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { ActivateLoyaltyProgramResponse, BulkGetLoyaltyProgramResponse, DisablePointsExpirationResponse, EnablePointsExpirationResponse, GetLoyaltyProgramPremiumFeaturesResponse, GetLoyaltyProgramResponse, LoyaltyProgram, PauseLoyaltyProgramResponse, ProgramUpdatedEnvelope, UpdateLoyaltyProgramResponse } from './loyalty-v1-program-programs.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getLoyaltyProgram(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>;
+}
+export declare function bulkGetLoyaltyProgram(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>;
+}
+export declare function updateLoyaltyProgram(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>;
+}
+export declare function activateLoyaltyProgram(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>;
+}
+export declare function pauseLoyaltyProgram(httpClient: HttpClient): PauseLoyaltyProgramSignature;
+interface PauseLoyaltyProgramSignature {
+    /**
+     * Changes the program status to `PAUSED`.
+     */
+    (): Promise<PauseLoyaltyProgramResponse>;
+}
+export declare function getLoyaltyProgramPremiumFeatures(httpClient: HttpClient): GetLoyaltyProgramPremiumFeaturesSignature;
+interface GetLoyaltyProgramPremiumFeaturesSignature {
+    /**
+     * Retrieves information about the available loyalty program premium features.
+     */
+    (): Promise<GetLoyaltyProgramPremiumFeaturesResponse>;
+}
+export declare function enablePointsExpiration(httpClient: HttpClient): EnablePointsExpirationSignature;
+interface EnablePointsExpirationSignature {
+    /**
+     * Updates the `pointsExpiration` status to `ENABLED`.
+     */
+    (): Promise<EnablePointsExpirationResponse>;
+}
+export declare function disablePointsExpiration(httpClient: HttpClient): DisablePointsExpirationSignature;
+interface DisablePointsExpirationSignature {
+    /**
+     * Updates the `pointsExpiration` status to `DISABLED`.
+     */
+    (): Promise<DisablePointsExpirationResponse>;
+}
+export declare const onProgramUpdated: EventDefinition<ProgramUpdatedEnvelope, "wix.loyalty.v1.program_updated">;
+export { ActionEvent, ActivateLoyaltyProgramRequest, ActivateLoyaltyProgramResponse, Asset, AssignedFromFloatingReason, BaseEventMetadata, BooleanFeature, BulkGetLoyaltyProgramRequest, BulkGetLoyaltyProgramResponse, CancelRequestedReason, ContractSwitchedReason, DeleteContext, DeleteStatus, DisablePointsExpirationRequest, DisablePointsExpirationResponse, DomainEvent, DomainEventBodyOneOf, Empty, EnablePointsExpirationRequest, EnablePointsExpirationResponse, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Feature, FeatureCancelled, FeatureCancelledReasonOneOf, FeatureContext, FeatureDisabled, FeatureDisabledReasonOneOf, FeatureEnabled, FeatureEnabledReasonOneOf, FeatureEvent, FeatureEventEventOneOf, FeaturePeriod, FeatureQuantityInfoOneOf, FeatureUpdated, FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf, FocalPoint, GetLoyaltyProgramDescriptionRequest, GetLoyaltyProgramDescriptionResponse, GetLoyaltyProgramPremiumFeaturesRequest, GetLoyaltyProgramPremiumFeaturesResponse, GetLoyaltyProgramRequest, GetLoyaltyProgramResponse, IdentificationData, IdentificationDataIdOneOf, LoyaltyProgram, LoyaltyProgramActivated, LoyaltyProgramDescriptionUpdated, ManualFeatureCreationReason, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, MigratedFromLegacyReason, Namespace, NamespaceChanged, NewFeatureReason, PauseLoyaltyProgramRequest, PauseLoyaltyProgramResponse, PointDefinition, PointsExpiration, PointsExpirationChanges, PointsExpirationConfigurationChanged, PointsExpirationDisabled, PointsExpirationEnabled, PremiumFeatures, ProgramInSite, ProgramStatus, ProgramUpdatedEnvelope, 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, UpdateLoyaltyProgramResponse, WebhookIdentityType, } from './loyalty-v1-program-programs.universal.js';

package/build/internal/es/src/loyalty-v1-program-programs.public.js

@@ -0,0 +1,63 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { activateLoyaltyProgram as universalActivateLoyaltyProgram, bulkGetLoyaltyProgram as universalBulkGetLoyaltyProgram, disablePointsExpiration as universalDisablePointsExpiration, enablePointsExpiration as universalEnablePointsExpiration, getLoyaltyProgram as universalGetLoyaltyProgram, getLoyaltyProgramPremiumFeatures as universalGetLoyaltyProgramPremiumFeatures, pauseLoyaltyProgram as universalPauseLoyaltyProgram, updateLoyaltyProgram as universalUpdateLoyaltyProgram, } from './loyalty-v1-program-programs.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/loyalty' };
+export function getLoyaltyProgram(httpClient) {
+    return () => universalGetLoyaltyProgram(
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkGetLoyaltyProgram(httpClient) {
+    return () => universalBulkGetLoyaltyProgram(
+    // @ts-ignore
+    { httpClient });
+}
+export function updateLoyaltyProgram(httpClient) {
+    return (loyaltyProgram) => universalUpdateLoyaltyProgram(loyaltyProgram, 
+    // @ts-ignore
+    { httpClient });
+}
+export function activateLoyaltyProgram(httpClient) {
+    return () => universalActivateLoyaltyProgram(
+    // @ts-ignore
+    { httpClient });
+}
+export function pauseLoyaltyProgram(httpClient) {
+    return () => universalPauseLoyaltyProgram(
+    // @ts-ignore
+    { httpClient });
+}
+export function getLoyaltyProgramPremiumFeatures(httpClient) {
+    return () => universalGetLoyaltyProgramPremiumFeatures(
+    // @ts-ignore
+    { httpClient });
+}
+export function enablePointsExpiration(httpClient) {
+    return () => universalEnablePointsExpiration(
+    // @ts-ignore
+    { httpClient });
+}
+export function disablePointsExpiration(httpClient) {
+    return () => universalDisablePointsExpiration(
+    // @ts-ignore
+    { httpClient });
+}
+export const onProgramUpdated = EventDefinition('wix.loyalty.v1.program_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTImageToSDKImage,
+        paths: [{ path: 'entity.pointDefinition.icon' }],
+    },
+])))();
+export { DeleteStatus, FeaturePeriod, Namespace, ProgramStatus, SiteCreatedContext, State, Status, Type, WebhookIdentityType, } from './loyalty-v1-program-programs.universal.js';
+//# sourceMappingURL=loyalty-v1-program-programs.public.js.map

package/build/internal/es/src/loyalty-v1-program-programs.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-v1-program-programs.public.js","sourceRoot":"","sources":["../../../../src/loyalty-v1-program-programs.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,4BAA4B,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAWL,sBAAsB,IAAI,+BAA+B,EACzD,qBAAqB,IAAI,8BAA8B,EACvD,uBAAuB,IAAI,gCAAgC,EAC3D,sBAAsB,IAAI,+BAA+B,EACzD,iBAAiB,IAAI,0BAA0B,EAC/C,gCAAgC,IAAI,yCAAyC,EAC7E,mBAAmB,IAAI,4BAA4B,EACnD,oBAAoB,IAAI,6BAA6B,GACtD,MAAM,4CAA4C,CAAC;AAEpD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,MAAM,UAAU,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,0BAA0B;IACxB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,qBAAqB,CACnC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,8BAA8B;IAC5B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,oBAAoB,CAClC,UAAsB;IAEtB,OAAO,CAAC,cAA8B,EAAE,EAAE,CACxC,6BAA6B,CAC3B,cAAc;IACd,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,sBAAsB,CACpC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,+BAA+B;IAC7B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAuBD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,4BAA4B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AASD,MAAM,UAAU,gCAAgC,CAC9C,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,yCAAyC;IACvC,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AASD,MAAM,UAAU,sBAAsB,CACpC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,+BAA+B;IAC7B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AASD,MAAM,UAAU,uBAAuB,CACrC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,gCAAgC;IAC9B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AASD,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAC7C,gCAAgC,EAChC,IAAI,EACJ,CAAC,KAA6B,EAAE,EAAE,CAChC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAC;KACjD;CACF,CAAC,CACH,CACJ,EAA0B,CAAC;AAE5B,OAAO,EAaL,YAAY,EAsBZ,aAAa,EAsBb,SAAS,EAaT,aAAa,EAWb,kBAAkB,EAclB,KAAK,EACL,MAAM,EAKN,IAAI,EAMJ,mBAAmB,GACpB,MAAM,4CAA4C,CAAC"}