@wix/auto_sdk_loyalty_rewards 1.0.6 → 1.0.8

package/build/index.d.mts

@@ -0,0 +1,128 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { R as Reward, B as BulkCreateRewardsResponse, a as BulkGetRewardsResponse, C as CursorQuery, Q as QueryRewardsResponse, U as UpdateReward, b as UpdateRewardResponse, L as ListRewardsOptions, c as ListRewardsResponse, d as RewardCreatedEnvelope, e as RewardDeletedEnvelope, f as RewardUpdatedEnvelope } from './loyalty-v1-reward-rewards.universal-BFnbQRqi.mjs';
+export { a7 as ActionEvent, A as ApplicationError, ac as BaseEventMetadata, x as BulkActionMetadata, v as BulkCreateRewardsRequest, E as BulkGetRewardsRequest, w as BulkRewardResult, j as CouponReward, k as CouponRewardDiscountTypeOneOf, l as CouponRewardScopeOrMinSubtotalOneOf, q as CouponScope, t as CreateRewardRequest, u as CreateRewardResponse, N as CursorPaging, O as CursorPagingMetadata, K as CursorQueryPagingMethodOneOf, T as Cursors, X as DeleteRewardRequest, Y as DeleteRewardResponse, D as DiscountAmount, i as DiscountAmountConfig, a1 as DomainEvent, a2 as DomainEventBodyOneOf, a8 as Empty, a3 as EntityCreatedEvent, a6 as EntityDeletedEvent, a5 as EntityUpdatedEvent, ad as EventMetadata, F as FixedAmountDiscount, m as FixedAmountDiscountConfig, o as FreeShippingDiscount, p as FreeShippingDiscountConfig, y as GetRewardRequest, z as GetRewardResponse, G as Group, aa as IdentificationData, ab as IdentificationDataIdOneOf, I as ItemMetadata, $ as ListRewardsInTierRequest, a0 as ListRewardsInTierResponse, Z as ListRewardsRequest, a9 as MessageEnvelope, _ as PagingMetadataV2, P as PercentageDiscount, n as PercentageDiscountConfig, J as QueryRewardsRequest, a4 as RestoreInfo, s as RewardDisabled, g as RewardType, h as RewardTypeDetailsOneOf, H as RewardsInSite, S as SortOrder, M as Sorting, r as SpiDiscountAmount, V as UpdateRewardRequest, W as WebhookIdentityType } from './loyalty-v1-reward-rewards.universal-BFnbQRqi.mjs';
+
+declare function createReward$1(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>;
+}
+declare function bulkCreateRewards$1(httpClient: HttpClient): BulkCreateRewardsSignature;
+interface BulkCreateRewardsSignature {
+    /**
+     * Creates multiple rewards.
+     * @param - Rewards to create.
+     */
+    (rewards: Reward[]): Promise<BulkCreateRewardsResponse>;
+}
+declare function getReward$1(httpClient: HttpClient): GetRewardSignature;
+interface GetRewardSignature {
+    /**
+     * Retrieves a reward.
+     * @param - ID of the reward to retrieve.
+     * @returns Retrieved reward.
+     */
+    (_id: string): Promise<Reward>;
+}
+declare function bulkGetRewards$1(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>;
+}
+declare function queryRewards$1(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>;
+}
+declare function updateReward$1(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, reward: UpdateReward): Promise<UpdateRewardResponse>;
+}
+declare function deleteReward$1(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>;
+}
+declare function listRewards$1(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>;
+}
+declare const onRewardCreated$1: EventDefinition<RewardCreatedEnvelope, "wix.loyalty.v1.reward_created">;
+declare const onRewardDeleted$1: EventDefinition<RewardDeletedEnvelope, "wix.loyalty.v1.reward_deleted">;
+declare const onRewardUpdated$1: EventDefinition<RewardUpdatedEnvelope, "wix.loyalty.v1.reward_updated">;
+
+declare const createReward: MaybeContext<BuildRESTFunction<typeof createReward$1> & typeof createReward$1>;
+declare const bulkCreateRewards: MaybeContext<BuildRESTFunction<typeof bulkCreateRewards$1> & typeof bulkCreateRewards$1>;
+declare const getReward: MaybeContext<BuildRESTFunction<typeof getReward$1> & typeof getReward$1>;
+declare const bulkGetRewards: MaybeContext<BuildRESTFunction<typeof bulkGetRewards$1> & typeof bulkGetRewards$1>;
+declare const queryRewards: MaybeContext<BuildRESTFunction<typeof queryRewards$1> & typeof queryRewards$1>;
+declare const updateReward: MaybeContext<BuildRESTFunction<typeof updateReward$1> & typeof updateReward$1>;
+declare const deleteReward: MaybeContext<BuildRESTFunction<typeof deleteReward$1> & typeof deleteReward$1>;
+declare const listRewards: MaybeContext<BuildRESTFunction<typeof listRewards$1> & typeof listRewards$1>;
+/**
+ * Triggered when a reward is created.
+ */
+declare const onRewardCreated: BuildEventDefinition<typeof onRewardCreated$1>;
+/**
+ * Triggered when a reward is deleted.
+ */
+declare const onRewardDeleted: BuildEventDefinition<typeof onRewardDeleted$1>;
+/**
+ * Triggered when a reward is updated.
+ */
+declare const onRewardUpdated: BuildEventDefinition<typeof onRewardUpdated$1>;
+
+export { BulkCreateRewardsResponse, BulkGetRewardsResponse, CursorQuery, ListRewardsOptions, ListRewardsResponse, QueryRewardsResponse, Reward, RewardCreatedEnvelope, RewardDeletedEnvelope, RewardUpdatedEnvelope, UpdateReward, UpdateRewardResponse, bulkCreateRewards, bulkGetRewards, createReward, deleteReward, getReward, listRewards, onRewardCreated, onRewardDeleted, onRewardUpdated, queryRewards, updateReward };

package/build/index.d.ts

@@ -0,0 +1,128 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { R as Reward, B as BulkCreateRewardsResponse, a as BulkGetRewardsResponse, C as CursorQuery, Q as QueryRewardsResponse, U as UpdateReward, b as UpdateRewardResponse, L as ListRewardsOptions, c as ListRewardsResponse, d as RewardCreatedEnvelope, e as RewardDeletedEnvelope, f as RewardUpdatedEnvelope } from './loyalty-v1-reward-rewards.universal-BFnbQRqi.js';
+export { a7 as ActionEvent, A as ApplicationError, ac as BaseEventMetadata, x as BulkActionMetadata, v as BulkCreateRewardsRequest, E as BulkGetRewardsRequest, w as BulkRewardResult, j as CouponReward, k as CouponRewardDiscountTypeOneOf, l as CouponRewardScopeOrMinSubtotalOneOf, q as CouponScope, t as CreateRewardRequest, u as CreateRewardResponse, N as CursorPaging, O as CursorPagingMetadata, K as CursorQueryPagingMethodOneOf, T as Cursors, X as DeleteRewardRequest, Y as DeleteRewardResponse, D as DiscountAmount, i as DiscountAmountConfig, a1 as DomainEvent, a2 as DomainEventBodyOneOf, a8 as Empty, a3 as EntityCreatedEvent, a6 as EntityDeletedEvent, a5 as EntityUpdatedEvent, ad as EventMetadata, F as FixedAmountDiscount, m as FixedAmountDiscountConfig, o as FreeShippingDiscount, p as FreeShippingDiscountConfig, y as GetRewardRequest, z as GetRewardResponse, G as Group, aa as IdentificationData, ab as IdentificationDataIdOneOf, I as ItemMetadata, $ as ListRewardsInTierRequest, a0 as ListRewardsInTierResponse, Z as ListRewardsRequest, a9 as MessageEnvelope, _ as PagingMetadataV2, P as PercentageDiscount, n as PercentageDiscountConfig, J as QueryRewardsRequest, a4 as RestoreInfo, s as RewardDisabled, g as RewardType, h as RewardTypeDetailsOneOf, H as RewardsInSite, S as SortOrder, M as Sorting, r as SpiDiscountAmount, V as UpdateRewardRequest, W as WebhookIdentityType } from './loyalty-v1-reward-rewards.universal-BFnbQRqi.js';
+
+declare function createReward$1(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>;
+}
+declare function bulkCreateRewards$1(httpClient: HttpClient): BulkCreateRewardsSignature;
+interface BulkCreateRewardsSignature {
+    /**
+     * Creates multiple rewards.
+     * @param - Rewards to create.
+     */
+    (rewards: Reward[]): Promise<BulkCreateRewardsResponse>;
+}
+declare function getReward$1(httpClient: HttpClient): GetRewardSignature;
+interface GetRewardSignature {
+    /**
+     * Retrieves a reward.
+     * @param - ID of the reward to retrieve.
+     * @returns Retrieved reward.
+     */
+    (_id: string): Promise<Reward>;
+}
+declare function bulkGetRewards$1(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>;
+}
+declare function queryRewards$1(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>;
+}
+declare function updateReward$1(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, reward: UpdateReward): Promise<UpdateRewardResponse>;
+}
+declare function deleteReward$1(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>;
+}
+declare function listRewards$1(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>;
+}
+declare const onRewardCreated$1: EventDefinition<RewardCreatedEnvelope, "wix.loyalty.v1.reward_created">;
+declare const onRewardDeleted$1: EventDefinition<RewardDeletedEnvelope, "wix.loyalty.v1.reward_deleted">;
+declare const onRewardUpdated$1: EventDefinition<RewardUpdatedEnvelope, "wix.loyalty.v1.reward_updated">;
+
+declare const createReward: MaybeContext<BuildRESTFunction<typeof createReward$1> & typeof createReward$1>;
+declare const bulkCreateRewards: MaybeContext<BuildRESTFunction<typeof bulkCreateRewards$1> & typeof bulkCreateRewards$1>;
+declare const getReward: MaybeContext<BuildRESTFunction<typeof getReward$1> & typeof getReward$1>;
+declare const bulkGetRewards: MaybeContext<BuildRESTFunction<typeof bulkGetRewards$1> & typeof bulkGetRewards$1>;
+declare const queryRewards: MaybeContext<BuildRESTFunction<typeof queryRewards$1> & typeof queryRewards$1>;
+declare const updateReward: MaybeContext<BuildRESTFunction<typeof updateReward$1> & typeof updateReward$1>;
+declare const deleteReward: MaybeContext<BuildRESTFunction<typeof deleteReward$1> & typeof deleteReward$1>;
+declare const listRewards: MaybeContext<BuildRESTFunction<typeof listRewards$1> & typeof listRewards$1>;
+/**
+ * Triggered when a reward is created.
+ */
+declare const onRewardCreated: BuildEventDefinition<typeof onRewardCreated$1>;
+/**
+ * Triggered when a reward is deleted.
+ */
+declare const onRewardDeleted: BuildEventDefinition<typeof onRewardDeleted$1>;
+/**
+ * Triggered when a reward is updated.
+ */
+declare const onRewardUpdated: BuildEventDefinition<typeof onRewardUpdated$1>;
+
+export { BulkCreateRewardsResponse, BulkGetRewardsResponse, CursorQuery, ListRewardsOptions, ListRewardsResponse, QueryRewardsResponse, Reward, RewardCreatedEnvelope, RewardDeletedEnvelope, RewardUpdatedEnvelope, UpdateReward, UpdateRewardResponse, bulkCreateRewards, bulkGetRewards, createReward, deleteReward, getReward, listRewards, onRewardCreated, onRewardDeleted, onRewardUpdated, queryRewards, updateReward };