@wix/auto_sdk_loyalty_coupons 1.0.17 → 1.0.18

package/build/cjs/{loyalty-v1-coupon-coupons.universal-BooyrntV.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * A loyalty coupon is created when a customer redeems their loyalty points for a reward. Creating a loyalty coupon
  * also creates a corresponding "reference" coupon with the [Coupons API](https://dev.wix.com/api/rest/coupons/about-wix-coupons).
@@ -656,9 +658,60 @@ interface CouponCreatedEnvelope {
     entity: LoyaltyCoupon;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a loyalty coupon is created.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.READ_COUPONS
+ * @webhook
+ * @eventType wix.loyalty.v1.coupon_created
+ * @serviceIdentifier com.wixpress.loyalty.coupon.LoyaltyCoupons
+ * @slug created
+ */
+declare function onCouponCreated(handler: (event: CouponCreatedEnvelope) => void | Promise<void>): void;
 interface CouponDeletedEnvelope {
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a loyalty coupon is deleted.
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionId LOYALTY.READ_COUPONS
+ * @webhook
+ * @eventType wix.loyalty.v1.coupon_deleted
+ * @serviceIdentifier com.wixpress.loyalty.coupon.LoyaltyCoupons
+ * @slug deleted
+ */
+declare function onCouponDeleted(handler: (event: CouponDeletedEnvelope) => void | Promise<void>): void;
+type CouponNonNullablePaths = `_id` | `accountId` | `memberIdDeprecated` | `couponReference.couponId` | `couponReference.code` | `couponReference.specification.moneyOffAmount` | `couponReference.specification.percentOffRate` | `couponReference.specification.freeShipping` | `couponReference.specification.fixedPriceAmount` | `couponReference.specification.buyXGetY.x` | `couponReference.specification.buyXGetY.y` | `couponReference.specification.scope.namespace` | `couponReference.specification.type` | `status` | `rewardName`;
+/**
+ * Redeems a customer's loyalty points for a loyalty reward and creates a loyalty coupon.
+ *
+ * Creating a loyalty coupon also creates a corresponding "reference" coupon with the [Coupons API](https://dev.wix.com/api/rest/coupons/about-wix-coupons).
+ * The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon
+ * are linked and the loyalty coupon's `status` reflects the current state of the reference coupon.
+ *
+ * Check which loyalty rewards a site has available with [List Rewards](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/list-rewards).
+ * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+ * @public
+ * @requiredField options
+ * @requiredField options.loyaltyAccountId
+ * @requiredField rewardId
+ * @permissionId LOYALTY.REDEEM_COUPON
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.RedeemPointsForCoupon
+ */
+declare function redeemPointsForCoupon(rewardId: string, options: NonNullablePaths<RedeemPointsForCouponOptions, `loyaltyAccountId`>): Promise<NonNullablePaths<RedeemPointsForCouponResponse, {
+    [P in CouponNonNullablePaths]: `coupon.${P}`;
+}[CouponNonNullablePaths]>>;
 interface RedeemPointsForCouponOptions {
     /**
      * ID of the [loyalty account](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/account-object) of the customer redeeming points.
@@ -666,10 +719,74 @@ interface RedeemPointsForCouponOptions {
      */
     loyaltyAccountId: string;
 }
+/**
+ * Redeems a current customer's loyalty points for a loyalty reward and creates a loyalty coupon.
+ *
+ * Creating a loyalty coupon also creates a corresponding "reference" coupon with the [Coupons API](https://dev.wix.com/api/rest/coupons/about-wix-coupons).
+ * The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon
+ * are linked and the loyalty coupon's `status` reflects the current state of the reference coupon.
+ *
+ * Check which loyalty rewards a site has available with [List Rewards](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/list-rewards).
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @param rewardId - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+ * @public
+ * @requiredField rewardId
+ * @permissionId LOYALTY.REDEEM_OWN_COUPON
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.RedeemCurrentMemberPointsForCoupon
+ */
+declare function redeemCurrentMemberPointsForCoupon(rewardId: string): Promise<NonNullablePaths<RedeemCurrentMemberPointsForCouponResponse, {
+    [P in CouponNonNullablePaths]: `coupon.${P}`;
+}[CouponNonNullablePaths]>>;
+/**
+ * Retrieves a loyalty coupon.
+ * @param loyaltyCouponId - ID of the loyalty coupon to retrieve.
+ * @public
+ * @requiredField loyaltyCouponId
+ * @permissionId LOYALTY.READ_COUPONS
+ * @applicableIdentity APP
+ * @returns Retrieved loyalty coupon.
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.GetLoyaltyCoupon
+ */
+declare function getLoyaltyCoupon(loyaltyCouponId: string): Promise<NonNullablePaths<LoyaltyCoupon, CouponNonNullablePaths>>;
+/**
+ * Retrieves a sequence of loyalty coupons
+ * @public
+ * @permissionId LOYALTY.REWARD_BULK_READ
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.BulkGetLoyaltyCoupon
+ */
+declare function bulkGetLoyaltyCoupon(options?: BulkGetLoyaltyCouponOptions): Promise<NonNullablePaths<BulkGetLoyaltyCouponResponse, `couponsInSite` | `couponsInSite.${number}.metaSiteId` | {
+    [P in CouponNonNullablePaths]: `couponsInSite.${number}.loyaltyCoupons.${number}.${P}`;
+}[CouponNonNullablePaths]>>;
 interface BulkGetLoyaltyCouponOptions {
     /** Query to filter loyalty coupons. */
     query?: CursorQuery;
 }
+/**
+ * Retrieves the loyalty coupons for the currently logged-in member.
+ *
+ * >**Note:**
+ * >This endpoint requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * @public
+ * @permissionId LOYALTY.READ_OWN_COUPONS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.GetCurrentMemberCoupons
+ */
+declare function getCurrentMemberCoupons(): Promise<NonNullablePaths<GetCurrentMemberCouponsResponse, {
+    [P in CouponNonNullablePaths]: `loyaltyCoupons.${number}.${P}`;
+}[CouponNonNullablePaths]>>;
+/**
+ * Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.
+ * @public
+ * @permissionId LOYALTY.READ_COUPONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.QueryLoyaltyCoupon
+ */
+declare function queryLoyaltyCoupons(): LoyaltyCouponsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -728,5 +845,21 @@ interface LoyaltyCouponsQueryBuilder {
     skipTo: (cursor: string) => LoyaltyCouponsQueryBuilder;
     find: () => Promise<LoyaltyCouponsQueryResult>;
 }
+/**
+ * Deletes a loyalty coupon.
+ *
+ * The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.
+ * @param _id - ID of the loyalty coupon to delete.
+ * @param revision - Revision number, which increments by 1 each time the loyalty coupon is updated.
+ *
+ * To prevent conflicting changes, the current `revision` must be passed when updating the loyalty coupon.
+ * @public
+ * @requiredField _id
+ * @requiredField revision
+ * @permissionId LOYALTY.MANAGE_COUPONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.loyalty.coupon.LoyaltyCoupons.DeleteLoyaltyCoupon
+ */
+declare function deleteLoyaltyCoupon(_id: string, revision: string): Promise<void>;
 
-export { type BaseEventMetadata as $, type QueryV2PagingMethodOneOf as A, type BulkGetLoyaltyCouponOptions as B, type CouponCreatedEnvelope as C, type QueryLoyaltyCouponResponse as D, type PagingMetadataV2 as E, type Cursors as F, type GetCurrentMemberCouponsResponse as G, type DeleteLoyaltyCouponRequest as H, type DeleteLoyaltyCouponResponse as I, type DomainEvent as J, type DomainEventBodyOneOf as K, type LoyaltyCoupon as L, type EntityCreatedEvent as M, type RestoreInfo as N, type EntityUpdatedEvent as O, type Paging as P, type QueryLoyaltyCouponRequest as Q, type RedeemPointsForCouponOptions as R, Status as S, Type as T, type EntityDeletedEvent as U, type ActionEvent as V, WebhookIdentityType as W, type Empty as X, type MessageEnvelope as Y, type IdentificationData as Z, type IdentificationDataIdOneOf as _, type RedeemPointsForCouponResponse as a, type EventMetadata as a0, type LoyaltyCouponsQueryResult as a1, type RedeemCurrentMemberPointsForCouponResponse as b, type BulkGetLoyaltyCouponResponse as c, type LoyaltyCouponsQueryBuilder as d, type CouponDeletedEnvelope as e, SortOrder as f, type CouponReference as g, type Specification as h, type SpecificationTypeDetailsOneOf as i, type SpecificationScopeOrMinSubtotalOneOf as j, type BuyXGetY as k, type Scope as l, type RedeemPointsForCouponRequest as m, type RedeemCurrentMemberPointsForCouponRequest as n, type RedeemMemberPointsForDiscountAmountCouponRequest as o, type RedeemMemberPointsForDiscountAmountCouponResponse as p, type GetLoyaltyCouponRequest as q, type GetLoyaltyCouponResponse as r, type BulkGetLoyaltyCouponRequest as s, type CursorQuery as t, type CursorQueryPagingMethodOneOf as u, type Sorting as v, type CursorPaging as w, type CouponsInSite as x, type GetCurrentMemberCouponsRequest as y, type QueryV2 as z };
+export { type ActionEvent, type BaseEventMetadata, type BulkGetLoyaltyCouponOptions, type BulkGetLoyaltyCouponRequest, type BulkGetLoyaltyCouponResponse, type BuyXGetY, type CouponCreatedEnvelope, type CouponDeletedEnvelope, type CouponReference, type CouponsInSite, type CursorPaging, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteLoyaltyCouponRequest, type DeleteLoyaltyCouponResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetCurrentMemberCouponsRequest, type GetCurrentMemberCouponsResponse, type GetLoyaltyCouponRequest, type GetLoyaltyCouponResponse, type IdentificationData, type IdentificationDataIdOneOf, type LoyaltyCoupon, type LoyaltyCouponsQueryBuilder, type LoyaltyCouponsQueryResult, type MessageEnvelope, type Paging, type PagingMetadataV2, type QueryLoyaltyCouponRequest, type QueryLoyaltyCouponResponse, type QueryV2, type QueryV2PagingMethodOneOf, type RedeemCurrentMemberPointsForCouponRequest, type RedeemCurrentMemberPointsForCouponResponse, type RedeemMemberPointsForDiscountAmountCouponRequest, type RedeemMemberPointsForDiscountAmountCouponResponse, type RedeemPointsForCouponOptions, type RedeemPointsForCouponRequest, type RedeemPointsForCouponResponse, type RestoreInfo, type Scope, SortOrder, type SortOrderWithLiterals, type Sorting, type Specification, type SpecificationScopeOrMinSubtotalOneOf, type SpecificationTypeDetailsOneOf, Status, type StatusWithLiterals, Type, type TypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkGetLoyaltyCoupon, deleteLoyaltyCoupon, getCurrentMemberCoupons, getLoyaltyCoupon, onCouponCreated, onCouponDeleted, queryLoyaltyCoupons, redeemCurrentMemberPointsForCoupon, redeemPointsForCoupon };