@wix/auto_sdk_loyalty_rewards 1.0.11 → 1.0.12

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 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';
+import { Reward, BulkCreateRewardsResponse, BulkGetRewardsResponse, CursorQuery, QueryRewardsResponse, UpdateReward, UpdateRewardResponse, ListRewardsOptions, ListRewardsResponse, RewardCreatedEnvelope, RewardDeletedEnvelope, RewardUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCreateRewardsRequest, BulkGetRewardsRequest, BulkRewardResult, CouponReward, CouponRewardDiscountTypeOneOf, CouponRewardScopeOrMinSubtotalOneOf, CouponScope, CreateRewardRequest, CreateRewardResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DeleteRewardRequest, DeleteRewardResponse, DiscountAmount, DiscountAmountConfig, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, FixedAmountDiscount, FixedAmountDiscountConfig, FreeShippingDiscount, FreeShippingDiscountConfig, GetRewardRequest, GetRewardResponse, Group, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListRewardsInTierRequest, ListRewardsInTierResponse, ListRewardsRequest, MessageEnvelope, PagingMetadataV2, PercentageDiscount, PercentageDiscountConfig, QueryRewardsRequest, RestoreInfo, RewardDisabled, RewardType, RewardTypeDetailsOneOf, RewardsInSite, SortOrder, Sorting, SpiDiscountAmount, UpdateRewardRequest, WebhookIdentityType } from './index.typings.js';
 
 declare function createReward$1(httpClient: HttpClient): CreateRewardSignature;
 interface CreateRewardSignature {

package/build/cjs/{loyalty-v1-reward-rewards.universal-BFnbQRqi.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * A loyalty reward is an object a customer can redeem with loyalty points.
  * Redeeming a reward then creates a loyalty coupon that the customer can use.
@@ -678,13 +680,156 @@ interface RewardCreatedEnvelope {
     entity: Reward;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a reward is created.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionId LOYALTY.READ_REWARDS
+ * @webhook
+ * @eventType wix.loyalty.v1.reward_created
+ * @serviceIdentifier com.wixpress.loyalty.reward.LoyaltyRewards
+ * @slug created
+ */
+declare function onRewardCreated(handler: (event: RewardCreatedEnvelope) => void | Promise<void>): void;
 interface RewardDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a reward is deleted.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionId LOYALTY.READ_REWARDS
+ * @webhook
+ * @eventType wix.loyalty.v1.reward_deleted
+ * @serviceIdentifier com.wixpress.loyalty.reward.LoyaltyRewards
+ * @slug deleted
+ */
+declare function onRewardDeleted(handler: (event: RewardDeletedEnvelope) => void | Promise<void>): void;
 interface RewardUpdatedEnvelope {
     entity: Reward;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a reward is updated.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionId LOYALTY.READ_REWARDS
+ * @webhook
+ * @eventType wix.loyalty.v1.reward_updated
+ * @serviceIdentifier com.wixpress.loyalty.reward.LoyaltyRewards
+ * @slug updated
+ */
+declare function onRewardUpdated(handler: (event: RewardUpdatedEnvelope) => void | Promise<void>): void;
+type RewardNonNullablePaths = `discountAmount.configsByTier` | `discountAmount.configsByTier.${number}.amount` | `discountAmount.configsByTier.${number}.costInPoints` | `couponReward.fixedAmount.configsByTier` | `couponReward.fixedAmount.configsByTier.${number}.costInPoints` | `couponReward.fixedAmount.configsByTier.${number}.amount` | `couponReward.percentage.configsByTier` | `couponReward.percentage.configsByTier.${number}.costInPoints` | `couponReward.percentage.configsByTier.${number}.percentage` | `couponReward.freeShipping.configsByTier` | `couponReward.freeShipping.configsByTier.${number}.costInPoints` | `couponReward.minimumSubtotal` | `couponReward.scope.namespace` | `couponReward.scope.group.name` | `name` | `active` | `type`;
+/**
+ * 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 - Reward to create.
+ * @public
+ * @requiredField reward
+ * @requiredField reward.name
+ * @permissionId LOYALTY.MANAGE_REWARDS
+ * @applicableIdentity APP
+ * @returns Created reward.
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.CreateReward
+ */
+declare function createReward(reward: NonNullablePaths<Reward, `name`>): Promise<NonNullablePaths<Reward, RewardNonNullablePaths>>;
+/**
+ * Creates multiple rewards.
+ * @param rewards - Rewards to create.
+ * @public
+ * @requiredField rewards
+ * @requiredField rewards.name
+ * @permissionId LOYALTY.MANAGE_REWARDS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.BulkCreateRewards
+ */
+declare function bulkCreateRewards(rewards: NonNullablePaths<Reward, `name`>[]): Promise<NonNullablePaths<BulkCreateRewardsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
+    [P in RewardNonNullablePaths]: `results.${number}.item.${P}`;
+}[RewardNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
+/**
+ * Retrieves a reward.
+ * @param _id - ID of the reward to retrieve.
+ * @public
+ * @requiredField _id
+ * @permissionId LOYALTY.READ_REWARDS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Retrieved reward.
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.GetReward
+ */
+declare function getReward(_id: string): Promise<NonNullablePaths<Reward, RewardNonNullablePaths>>;
+/**
+ * Retrieves rewards from all metasites that the caller is the member of.
+ *
+ * Must be called with user identity.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId LOYALTY.REWARD_BULK_READ
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.BulkGetRewards
+ */
+declare function bulkGetRewards(): Promise<NonNullablePaths<BulkGetRewardsResponse, `rewardsInSite` | `rewardsInSite.${number}.metaSiteId` | {
+    [P in RewardNonNullablePaths]: `rewardsInSite.${number}.rewards.${number}.${P}`;
+}[RewardNonNullablePaths]>>;
+/**
+ * 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 - Query parameters.
+ * @public
+ * @requiredField query
+ * @permissionId LOYALTY.READ_REWARDS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.QueryRewards
+ */
+declare function queryRewards(query: CursorQuery): Promise<NonNullablePaths<QueryRewardsResponse, {
+    [P in RewardNonNullablePaths]: `rewards.${number}.${P}`;
+}[RewardNonNullablePaths]>>;
+/**
+ * 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 _id - Reward ID.
+ * @public
+ * @requiredField _id
+ * @requiredField reward
+ * @requiredField reward.name
+ * @requiredField reward.revision
+ * @param reward - Reward info to update.
+ * @permissionId LOYALTY.MANAGE_REWARDS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.UpdateReward
+ */
+declare function updateReward(_id: string, reward: NonNullablePaths<UpdateReward, `name` | `revision`>): Promise<NonNullablePaths<UpdateRewardResponse, {
+    [P in RewardNonNullablePaths]: `reward.${P}`;
+}[RewardNonNullablePaths]>>;
 interface UpdateReward {
     /** Discount details. */
     discountAmount?: DiscountAmount;
@@ -724,9 +869,37 @@ interface UpdateReward {
      */
     _updatedDate?: Date | null;
 }
+/**
+ * Deletes a reward.
+ * @param _id - ID of the reward to delete.
+ * @param revision - 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.
+ * @public
+ * @requiredField _id
+ * @requiredField revision
+ * @permissionId LOYALTY.MANAGE_REWARDS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.DeleteReward
+ */
+declare function deleteReward(_id: string, revision: string): Promise<void>;
+/**
+ * Retrieves a list of rewards.
+ *
+ * The list includes rewards that are currently nonredeemable due to insufficient points held by any customers.
+ * @public
+ * @param options - List options.
+ * @permissionId LOYALTY.READ_REWARDS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn com.wixpress.loyalty.reward.LoyaltyRewards.ListRewards
+ */
+declare function listRewards(options?: ListRewardsOptions): Promise<NonNullablePaths<ListRewardsResponse, {
+    [P in RewardNonNullablePaths]: `rewards.${number}.${P}`;
+}[RewardNonNullablePaths]>>;
 interface ListRewardsOptions {
     /** Pagination options. */
     cursorPaging?: CursorPaging;
 }
 
-export { type ListRewardsInTierRequest as $, type ApplicationError as A, type BulkCreateRewardsResponse as B, type CursorQuery as C, type DiscountAmount as D, type BulkGetRewardsRequest as E, type FixedAmountDiscount as F, type Group as G, type RewardsInSite as H, type ItemMetadata as I, type QueryRewardsRequest as J, type CursorQueryPagingMethodOneOf as K, type ListRewardsOptions as L, type Sorting as M, type CursorPaging as N, type CursorPagingMetadata as O, type PercentageDiscount as P, type QueryRewardsResponse as Q, type Reward as R, SortOrder as S, type Cursors as T, type UpdateReward as U, type UpdateRewardRequest as V, WebhookIdentityType as W, type DeleteRewardRequest as X, type DeleteRewardResponse as Y, type ListRewardsRequest as Z, type PagingMetadataV2 as _, type BulkGetRewardsResponse as a, type ListRewardsInTierResponse as a0, type DomainEvent as a1, type DomainEventBodyOneOf as a2, type EntityCreatedEvent as a3, type RestoreInfo as a4, type EntityUpdatedEvent as a5, type EntityDeletedEvent as a6, type ActionEvent as a7, type Empty as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type UpdateRewardResponse as b, type ListRewardsResponse as c, type RewardCreatedEnvelope as d, type RewardDeletedEnvelope as e, type RewardUpdatedEnvelope as f, RewardType as g, type RewardTypeDetailsOneOf as h, type DiscountAmountConfig as i, type CouponReward as j, type CouponRewardDiscountTypeOneOf as k, type CouponRewardScopeOrMinSubtotalOneOf as l, type FixedAmountDiscountConfig as m, type PercentageDiscountConfig as n, type FreeShippingDiscount as o, type FreeShippingDiscountConfig as p, type CouponScope as q, type SpiDiscountAmount as r, type RewardDisabled as s, type CreateRewardRequest as t, type CreateRewardResponse as u, type BulkCreateRewardsRequest as v, type BulkRewardResult as w, type BulkActionMetadata as x, type GetRewardRequest as y, type GetRewardResponse as z };
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateRewardsRequest, type BulkCreateRewardsResponse, type BulkGetRewardsRequest, type BulkGetRewardsResponse, type BulkRewardResult, type CouponReward, type CouponRewardDiscountTypeOneOf, type CouponRewardScopeOrMinSubtotalOneOf, type CouponScope, type CreateRewardRequest, type CreateRewardResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteRewardRequest, type DeleteRewardResponse, type DiscountAmount, type DiscountAmountConfig, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FixedAmountDiscount, type FixedAmountDiscountConfig, type FreeShippingDiscount, type FreeShippingDiscountConfig, type GetRewardRequest, type GetRewardResponse, type Group, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListRewardsInTierRequest, type ListRewardsInTierResponse, type ListRewardsOptions, type ListRewardsRequest, type ListRewardsResponse, type MessageEnvelope, type PagingMetadataV2, type PercentageDiscount, type PercentageDiscountConfig, type QueryRewardsRequest, type QueryRewardsResponse, type RestoreInfo, type Reward, type RewardCreatedEnvelope, type RewardDeletedEnvelope, type RewardDisabled, RewardType, type RewardTypeDetailsOneOf, type RewardTypeWithLiterals, type RewardUpdatedEnvelope, type RewardsInSite, SortOrder, type SortOrderWithLiterals, type Sorting, type SpiDiscountAmount, type UpdateReward, type UpdateRewardRequest, type UpdateRewardResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateRewards, bulkGetRewards, createReward, deleteReward, getReward, listRewards, onRewardCreated, onRewardDeleted, onRewardUpdated, queryRewards, updateReward };