@wix/auto_sdk_loyalty_rewards 1.0.0

package/build/es/src/loyalty-v1-reward-rewards.public.d.ts

@@ -0,0 +1,107 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { BulkCreateRewardsResponse, BulkCreateRewardsResponseNonNullableFields, BulkGetRewardsResponse, BulkGetRewardsResponseNonNullableFields, CursorQuery, ListRewardsOptions, ListRewardsResponse, ListRewardsResponseNonNullableFields, QueryRewardsResponse, QueryRewardsResponseNonNullableFields, Reward, RewardCreatedEnvelope, RewardDeletedEnvelope, RewardNonNullableFields, RewardUpdatedEnvelope, UpdateReward, UpdateRewardResponse, UpdateRewardResponseNonNullableFields } from './loyalty-v1-reward-rewards.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function createReward(httpClient: HttpClient): CreateRewardSignature;
+interface CreateRewardSignature {
+    /**
+     * Creates a reward that can be redeemed with loyalty points.
+     *
+     * When a customer redeems a reward, a loyalty coupon is created
+     * based on the specifications detailed in either the `discountAmount` or `couponReward` fields. This coupon can
+     * then be used by the customer to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
+     * no coupon is actually created until a reward is redeemed with points.
+     * See the Coupons API for more information about coupons.
+     *
+     * A reward's `active` status defaults to `false`. To make the reward available to customers,
+     * either set the `active` field to `true` during creation or call [`updateReward()`](#updatereward)
+     * to change the status.
+     *
+     * To customize a reward for each loyalty tier, use the `configsByTier` parameter.
+     * This allows you to specify the amount of the earned discount, the cost in loyalty points
+     * to redeem the reward, and the tier to which this configuration applies. Each tier requires its own
+     * `configsByTier` configuration. To create a reward that is available to loyalty accounts in the base tier,
+     * leave the `tierId` field empty. See the Loyalty Tiers API for more information on tiers.
+     * @param - Reward to create.
+     * @returns Created reward.
+     */
+    (reward: Reward): Promise<Reward & RewardNonNullableFields>;
+}
+export declare function bulkCreateRewards(httpClient: HttpClient): BulkCreateRewardsSignature;
+interface BulkCreateRewardsSignature {
+    /**
+     * Creates multiple rewards.
+     * @param - Rewards to create.
+     */
+    (rewards: Reward[]): Promise<BulkCreateRewardsResponse & BulkCreateRewardsResponseNonNullableFields>;
+}
+export declare function getReward(httpClient: HttpClient): GetRewardSignature;
+interface GetRewardSignature {
+    /**
+     * Retrieves a reward.
+     * @param - ID of the reward to retrieve.
+     * @returns Retrieved reward.
+     */
+    (_id: string): Promise<Reward & RewardNonNullableFields>;
+}
+export declare function bulkGetRewards(httpClient: HttpClient): BulkGetRewardsSignature;
+interface BulkGetRewardsSignature {
+    /**
+     * Retrieves rewards from all metasites that the caller is the member of.
+     *
+     * Must be called with user identity.
+     */
+    (): Promise<BulkGetRewardsResponse & BulkGetRewardsResponseNonNullableFields>;
+}
+export declare function queryRewards(httpClient: HttpClient): QueryRewardsSignature;
+interface QueryRewardsSignature {
+    /**
+     * Retrieves a list of rewards, given the provided paging, filtering, and sorting.
+     *
+     * Query Rewards runs with these defaults, which you can override: `cursorPaging.limit` is `50`.
+     *
+     * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),[Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     * @param - Query parameters.
+     */
+    (query: CursorQuery): Promise<QueryRewardsResponse & QueryRewardsResponseNonNullableFields>;
+}
+export declare function updateReward(httpClient: HttpClient): UpdateRewardSignature;
+interface UpdateRewardSignature {
+    /**
+     * Updates a loyalty reward.
+     *
+     * Use this endpoint to update details of a reward, such as the name, whether or not a reward is active,
+     * or the amount of points it costs to redeem. Also use this endpoint to add new tiers that are eligible to redeem a reward.
+     *
+     * You may not change the `type` of a reward. That is set upon creation and cannot be updated.
+     * @param - Reward ID.
+     * @param - Reward info to update.
+     */
+    (_id: string | null, reward: UpdateReward): Promise<UpdateRewardResponse & UpdateRewardResponseNonNullableFields>;
+}
+export declare function deleteReward(httpClient: HttpClient): DeleteRewardSignature;
+interface DeleteRewardSignature {
+    /**
+     * Deletes a reward.
+     * @param - ID of the reward to delete.
+     * @param - Revision number, which increments by 1 each time the reward is updated.
+     *
+     * To prevent conflicting changes, the current `revision` must be passed when deleting the reward.
+     */
+    (_id: string, revision: string): Promise<void>;
+}
+export declare function listRewards(httpClient: HttpClient): ListRewardsSignature;
+interface ListRewardsSignature {
+    /**
+     * Retrieves a list of rewards.
+     *
+     * The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.
+     * @param - List options.
+     */
+    (options?: ListRewardsOptions | undefined): Promise<ListRewardsResponse & ListRewardsResponseNonNullableFields>;
+}
+export declare const onRewardCreated: EventDefinition<RewardCreatedEnvelope, "wix.loyalty.v1.reward_created">;
+export declare const onRewardDeleted: EventDefinition<RewardDeletedEnvelope, "wix.loyalty.v1.reward_deleted">;
+export declare const onRewardUpdated: EventDefinition<RewardUpdatedEnvelope, "wix.loyalty.v1.reward_updated">;
+export { ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateRewardsRequest, BulkCreateRewardsResponse, BulkCreateRewardsResponseNonNullableFields, BulkGetRewardsRequest, BulkGetRewardsResponse, BulkGetRewardsResponseNonNullableFields, BulkRewardResult, CouponReward, CouponRewardDiscountTypeOneOf, CouponRewardScopeOrMinSubtotalOneOf, CouponScope, CreateRewardRequest, CreateRewardResponse, CreateRewardResponseNonNullableFields, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteRewardRequest, DeleteRewardResponse, DiscountAmount, DiscountAmountConfig, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FixedAmountDiscount, FixedAmountDiscountConfig, FreeShippingDiscount, FreeShippingDiscountConfig, GetRewardRequest, GetRewardResponse, GetRewardResponseNonNullableFields, Group, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListRewardsInTierRequest, ListRewardsInTierResponse, ListRewardsOptions, ListRewardsRequest, ListRewardsResponse, ListRewardsResponseNonNullableFields, MessageEnvelope, PagingMetadataV2, PercentageDiscount, PercentageDiscountConfig, QueryRewardsRequest, QueryRewardsResponse, QueryRewardsResponseNonNullableFields, RestoreInfo, Reward, RewardCreatedEnvelope, RewardDeletedEnvelope, RewardDisabled, RewardNonNullableFields, RewardType, RewardTypeDetailsOneOf, RewardUpdatedEnvelope, RewardsInSite, SortOrder, Sorting, SpiDiscountAmount, UpdateReward, UpdateRewardRequest, UpdateRewardResponse, UpdateRewardResponseNonNullableFields, WebhookIdentityType, } from './loyalty-v1-reward-rewards.universal.js';

package/build/es/src/loyalty-v1-reward-rewards.public.js

@@ -0,0 +1,105 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { bulkCreateRewards as universalBulkCreateRewards, bulkGetRewards as universalBulkGetRewards, createReward as universalCreateReward, deleteReward as universalDeleteReward, getReward as universalGetReward, listRewards as universalListRewards, queryRewards as universalQueryRewards, updateReward as universalUpdateReward, } from './loyalty-v1-reward-rewards.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/loyalty' };
+export function createReward(httpClient) {
+    return (reward) => universalCreateReward(reward, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkCreateRewards(httpClient) {
+    return (rewards) => universalBulkCreateRewards(rewards, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getReward(httpClient) {
+    return (_id) => universalGetReward(_id, 
+    // @ts-ignore
+    { httpClient });
+}
+export function bulkGetRewards(httpClient) {
+    return () => universalBulkGetRewards(
+    // @ts-ignore
+    { httpClient });
+}
+export function queryRewards(httpClient) {
+    return (query) => universalQueryRewards(query, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateReward(httpClient) {
+    return (_id, reward) => universalUpdateReward(_id, reward, 
+    // @ts-ignore
+    { httpClient });
+}
+export function deleteReward(httpClient) {
+    return (_id, revision) => universalDeleteReward(_id, revision, 
+    // @ts-ignore
+    { httpClient });
+}
+export function listRewards(httpClient) {
+    return (options) => universalListRewards(options, 
+    // @ts-ignore
+    { httpClient });
+}
+export const onRewardCreated = EventDefinition('wix.loyalty.v1.reward_created', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTFloatToSDKFloat,
+        paths: [
+            { path: 'entity.couponReward.minimumSubtotal' },
+            { path: 'entity.couponReward.fixedAmount.configsByTier.amount' },
+            { path: 'entity.couponReward.percentage.configsByTier.percentage' },
+        ],
+    },
+])))();
+export const onRewardDeleted = EventDefinition('wix.loyalty.v1.reward_deleted', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'undefined.createdDate' },
+            { path: 'undefined.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTFloatToSDKFloat,
+        paths: [
+            { path: 'undefined.couponReward.minimumSubtotal' },
+            { path: 'undefined.couponReward.fixedAmount.configsByTier.amount' },
+            {
+                path: 'undefined.couponReward.percentage.configsByTier.percentage',
+            },
+        ],
+    },
+])))();
+export const onRewardUpdated = EventDefinition('wix.loyalty.v1.reward_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+    {
+        transformFn: transformRESTFloatToSDKFloat,
+        paths: [
+            { path: 'entity.couponReward.minimumSubtotal' },
+            { path: 'entity.couponReward.fixedAmount.configsByTier.amount' },
+            { path: 'entity.couponReward.percentage.configsByTier.percentage' },
+        ],
+    },
+])))();
+export { RewardType, SortOrder, WebhookIdentityType, } from './loyalty-v1-reward-rewards.universal.js';
+//# sourceMappingURL=loyalty-v1-reward-rewards.public.js.map

package/build/es/src/loyalty-v1-reward-rewards.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-v1-reward-rewards.public.js","sourceRoot":"","sources":["../../../src/loyalty-v1-reward-rewards.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,EAmBL,iBAAiB,IAAI,0BAA0B,EAC/C,cAAc,IAAI,uBAAuB,EACzC,YAAY,IAAI,qBAAqB,EACrC,YAAY,IAAI,qBAAqB,EACrC,SAAS,IAAI,kBAAkB,EAC/B,WAAW,IAAI,oBAAoB,EACnC,YAAY,IAAI,qBAAqB,EACrC,YAAY,IAAI,qBAAqB,GACtC,MAAM,0CAA0C,CAAC;AAElD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;AAE3D,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,MAAc,EAAE,EAAE,CACxB,qBAAqB,CACnB,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AA2BD,MAAM,UAAU,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,CAAC,OAAiB,EAAE,EAAE,CAC3B,0BAA0B,CACxB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAYD,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,kBAAkB,CAChB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,cAAc,CAC5B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,uBAAuB;IACrB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAWD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,KAAkB,EAAE,EAAE,CAC5B,qBAAqB,CACnB,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAgBD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,GAAkB,EAAE,MAAoB,EAAE,EAAE,CAClD,qBAAqB,CACnB,GAAG,EACH,MAAM;IACN,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAkBD,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,GAAW,EAAE,QAAgB,EAAE,EAAE,CACvC,qBAAqB,CACnB,GAAG,EACH,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAaD,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,OAA4B,EAAE,EAAE,CACtC,oBAAoB,CAClB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,+BAA+B,EAC/B,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,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;YACL,EAAE,IAAI,EAAE,qCAAqC,EAAE;YAC/C,EAAE,IAAI,EAAE,sDAAsD,EAAE;YAChE,EAAE,IAAI,EAAE,yDAAyD,EAAE;SACpE;KACF;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AAC3B,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,+BAA+B,EAC/B,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE;YACjC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;IACD;QACE,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,wCAAwC,EAAE;YAClD,EAAE,IAAI,EAAE,yDAAyD,EAAE;YACnE;gBACE,IAAI,EAAE,4DAA4D;aACnE;SACF;KACF;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AAC3B,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,+BAA+B,EAC/B,IAAI,EACJ,CAAC,KAA4B,EAAE,EAAE,CAC/B,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;YACL,EAAE,IAAI,EAAE,qCAAqC,EAAE;YAC/C,EAAE,IAAI,EAAE,sDAAsD,EAAE;YAChE,EAAE,IAAI,EAAE,yDAAyD,EAAE;SACpE;KACF;CACF,CAAC,CACH,CACJ,EAAyB,CAAC;AAE3B,OAAO,EAiEL,UAAU,EAIV,SAAS,EAOT,mBAAmB,GACpB,MAAM,0CAA0C,CAAC"}