@wix/auto_sdk_loyalty_coupons 1.0.5 → 1.0.7

package/build/index.d.mts

@@ -0,0 +1,100 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { R as RedeemPointsForCouponOptions, a as RedeemPointsForCouponResponse, b as RedeemCurrentMemberPointsForCouponResponse, L as LoyaltyCoupon, B as BulkGetLoyaltyCouponOptions, c as BulkGetLoyaltyCouponResponse, G as GetCurrentMemberCouponsResponse, d as LoyaltyCouponsQueryBuilder } from './loyalty-v1-coupon-coupons.universal-BpPn8h94.mjs';
+export { O as ActionEvent, Z as BaseEventMetadata, q as BulkGetLoyaltyCouponRequest, i as BuyXGetY, $ as CouponCreatedEnvelope, a0 as CouponDeletedEnvelope, C as CouponReference, v as CouponsInSite, u as CursorPaging, r as CursorQuery, s as CursorQueryPagingMethodOneOf, D as Cursors, E as DeleteLoyaltyCouponRequest, F as DeleteLoyaltyCouponResponse, H as DomainEvent, I as DomainEventBodyOneOf, U as Empty, J as EntityCreatedEvent, N as EntityDeletedEvent, M as EntityUpdatedEvent, _ as EventMetadata, w as GetCurrentMemberCouponsRequest, o as GetLoyaltyCouponRequest, p as GetLoyaltyCouponResponse, X as IdentificationData, Y as IdentificationDataIdOneOf, a1 as LoyaltyCouponsQueryResult, V as MessageEnvelope, P as Paging, A as PagingMetadataV2, Q as QueryLoyaltyCouponRequest, z as QueryLoyaltyCouponResponse, x as QueryV2, y as QueryV2PagingMethodOneOf, l as RedeemCurrentMemberPointsForCouponRequest, m as RedeemMemberPointsForDiscountAmountCouponRequest, n as RedeemMemberPointsForDiscountAmountCouponResponse, k as RedeemPointsForCouponRequest, K as RestoreInfo, j as Scope, e as SortOrder, t as Sorting, f as Specification, h as SpecificationScopeOrMinSubtotalOneOf, g as SpecificationTypeDetailsOneOf, S as Status, T as Type, W as WebhookIdentityType } from './loyalty-v1-coupon-coupons.universal-BpPn8h94.mjs';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function redeemPointsForCoupon$1(httpClient: HttpClient): RedeemPointsForCouponSignature;
+interface RedeemPointsForCouponSignature {
+    /**
+     * 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 - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+     */
+    (rewardId: string, options: RedeemPointsForCouponOptions): Promise<RedeemPointsForCouponResponse>;
+}
+declare function redeemCurrentMemberPointsForCoupon$1(httpClient: HttpClient): RedeemCurrentMemberPointsForCouponSignature;
+interface RedeemCurrentMemberPointsForCouponSignature {
+    /**
+     * 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 - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+     */
+    (rewardId: string): Promise<RedeemCurrentMemberPointsForCouponResponse>;
+}
+declare function getLoyaltyCoupon$1(httpClient: HttpClient): GetLoyaltyCouponSignature;
+interface GetLoyaltyCouponSignature {
+    /**
+     * Retrieves a loyalty coupon.
+     * @param - ID of the loyalty coupon to retrieve.
+     * @returns Retrieved loyalty coupon.
+     */
+    (loyaltyCouponId: string): Promise<LoyaltyCoupon>;
+}
+declare function bulkGetLoyaltyCoupon$1(httpClient: HttpClient): BulkGetLoyaltyCouponSignature;
+interface BulkGetLoyaltyCouponSignature {
+    /**
+     * Retrieves a sequence of loyalty coupons
+     */
+    (options?: BulkGetLoyaltyCouponOptions | undefined): Promise<BulkGetLoyaltyCouponResponse>;
+}
+declare function getCurrentMemberCoupons$1(httpClient: HttpClient): GetCurrentMemberCouponsSignature;
+interface GetCurrentMemberCouponsSignature {
+    /**
+     * 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).
+     */
+    (): Promise<GetCurrentMemberCouponsResponse>;
+}
+declare function queryLoyaltyCoupons$1(httpClient: HttpClient): QueryLoyaltyCouponsSignature;
+interface QueryLoyaltyCouponsSignature {
+    /**
+     * Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.
+     */
+    (): LoyaltyCouponsQueryBuilder;
+}
+declare function deleteLoyaltyCoupon$1(httpClient: HttpClient): DeleteLoyaltyCouponSignature;
+interface DeleteLoyaltyCouponSignature {
+    /**
+     * Deletes a loyalty coupon.
+     *
+     * The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.
+     * @param - ID of the loyalty coupon to delete.
+     * @param - 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.
+     */
+    (_id: string, revision: string): Promise<void>;
+}
+
+declare const redeemPointsForCoupon: MaybeContext<BuildRESTFunction<typeof redeemPointsForCoupon$1> & typeof redeemPointsForCoupon$1>;
+declare const redeemCurrentMemberPointsForCoupon: MaybeContext<BuildRESTFunction<typeof redeemCurrentMemberPointsForCoupon$1> & typeof redeemCurrentMemberPointsForCoupon$1>;
+declare const getLoyaltyCoupon: MaybeContext<BuildRESTFunction<typeof getLoyaltyCoupon$1> & typeof getLoyaltyCoupon$1>;
+declare const bulkGetLoyaltyCoupon: MaybeContext<BuildRESTFunction<typeof bulkGetLoyaltyCoupon$1> & typeof bulkGetLoyaltyCoupon$1>;
+declare const getCurrentMemberCoupons: MaybeContext<BuildRESTFunction<typeof getCurrentMemberCoupons$1> & typeof getCurrentMemberCoupons$1>;
+declare const queryLoyaltyCoupons: MaybeContext<BuildRESTFunction<typeof queryLoyaltyCoupons$1> & typeof queryLoyaltyCoupons$1>;
+declare const deleteLoyaltyCoupon: MaybeContext<BuildRESTFunction<typeof deleteLoyaltyCoupon$1> & typeof deleteLoyaltyCoupon$1>;
+/**
+ * Triggered when a loyalty coupon is created.
+ */
+declare const onCouponCreated: ReturnType<typeof createEventModule<typeof publicOnCouponCreated>>;
+/**
+ * Triggered when a loyalty coupon is deleted.
+ */
+declare const onCouponDeleted: ReturnType<typeof createEventModule<typeof publicOnCouponDeleted>>;
+
+export { BulkGetLoyaltyCouponOptions, BulkGetLoyaltyCouponResponse, GetCurrentMemberCouponsResponse, LoyaltyCoupon, LoyaltyCouponsQueryBuilder, RedeemCurrentMemberPointsForCouponResponse, RedeemPointsForCouponOptions, RedeemPointsForCouponResponse, bulkGetLoyaltyCoupon, deleteLoyaltyCoupon, getCurrentMemberCoupons, getLoyaltyCoupon, onCouponCreated, onCouponDeleted, queryLoyaltyCoupons, redeemCurrentMemberPointsForCoupon, redeemPointsForCoupon };

package/build/index.d.ts

@@ -0,0 +1,100 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { R as RedeemPointsForCouponOptions, a as RedeemPointsForCouponResponse, b as RedeemCurrentMemberPointsForCouponResponse, L as LoyaltyCoupon, B as BulkGetLoyaltyCouponOptions, c as BulkGetLoyaltyCouponResponse, G as GetCurrentMemberCouponsResponse, d as LoyaltyCouponsQueryBuilder } from './loyalty-v1-coupon-coupons.universal-BpPn8h94.js';
+export { O as ActionEvent, Z as BaseEventMetadata, q as BulkGetLoyaltyCouponRequest, i as BuyXGetY, $ as CouponCreatedEnvelope, a0 as CouponDeletedEnvelope, C as CouponReference, v as CouponsInSite, u as CursorPaging, r as CursorQuery, s as CursorQueryPagingMethodOneOf, D as Cursors, E as DeleteLoyaltyCouponRequest, F as DeleteLoyaltyCouponResponse, H as DomainEvent, I as DomainEventBodyOneOf, U as Empty, J as EntityCreatedEvent, N as EntityDeletedEvent, M as EntityUpdatedEvent, _ as EventMetadata, w as GetCurrentMemberCouponsRequest, o as GetLoyaltyCouponRequest, p as GetLoyaltyCouponResponse, X as IdentificationData, Y as IdentificationDataIdOneOf, a1 as LoyaltyCouponsQueryResult, V as MessageEnvelope, P as Paging, A as PagingMetadataV2, Q as QueryLoyaltyCouponRequest, z as QueryLoyaltyCouponResponse, x as QueryV2, y as QueryV2PagingMethodOneOf, l as RedeemCurrentMemberPointsForCouponRequest, m as RedeemMemberPointsForDiscountAmountCouponRequest, n as RedeemMemberPointsForDiscountAmountCouponResponse, k as RedeemPointsForCouponRequest, K as RestoreInfo, j as Scope, e as SortOrder, t as Sorting, f as Specification, h as SpecificationScopeOrMinSubtotalOneOf, g as SpecificationTypeDetailsOneOf, S as Status, T as Type, W as WebhookIdentityType } from './loyalty-v1-coupon-coupons.universal-BpPn8h94.js';
+import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
+
+declare function redeemPointsForCoupon$1(httpClient: HttpClient): RedeemPointsForCouponSignature;
+interface RedeemPointsForCouponSignature {
+    /**
+     * 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 - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+     */
+    (rewardId: string, options: RedeemPointsForCouponOptions): Promise<RedeemPointsForCouponResponse>;
+}
+declare function redeemCurrentMemberPointsForCoupon$1(httpClient: HttpClient): RedeemCurrentMemberPointsForCouponSignature;
+interface RedeemCurrentMemberPointsForCouponSignature {
+    /**
+     * 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 - ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+     */
+    (rewardId: string): Promise<RedeemCurrentMemberPointsForCouponResponse>;
+}
+declare function getLoyaltyCoupon$1(httpClient: HttpClient): GetLoyaltyCouponSignature;
+interface GetLoyaltyCouponSignature {
+    /**
+     * Retrieves a loyalty coupon.
+     * @param - ID of the loyalty coupon to retrieve.
+     * @returns Retrieved loyalty coupon.
+     */
+    (loyaltyCouponId: string): Promise<LoyaltyCoupon>;
+}
+declare function bulkGetLoyaltyCoupon$1(httpClient: HttpClient): BulkGetLoyaltyCouponSignature;
+interface BulkGetLoyaltyCouponSignature {
+    /**
+     * Retrieves a sequence of loyalty coupons
+     */
+    (options?: BulkGetLoyaltyCouponOptions | undefined): Promise<BulkGetLoyaltyCouponResponse>;
+}
+declare function getCurrentMemberCoupons$1(httpClient: HttpClient): GetCurrentMemberCouponsSignature;
+interface GetCurrentMemberCouponsSignature {
+    /**
+     * 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).
+     */
+    (): Promise<GetCurrentMemberCouponsResponse>;
+}
+declare function queryLoyaltyCoupons$1(httpClient: HttpClient): QueryLoyaltyCouponsSignature;
+interface QueryLoyaltyCouponsSignature {
+    /**
+     * Retrieves a list of loyalty coupons, given the provided paging, filtering, and sorting.
+     */
+    (): LoyaltyCouponsQueryBuilder;
+}
+declare function deleteLoyaltyCoupon$1(httpClient: HttpClient): DeleteLoyaltyCouponSignature;
+interface DeleteLoyaltyCouponSignature {
+    /**
+     * Deletes a loyalty coupon.
+     *
+     * The deletion of a loyalty coupon does not impact the functionality of the corresponding coupon itself.
+     * @param - ID of the loyalty coupon to delete.
+     * @param - 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.
+     */
+    (_id: string, revision: string): Promise<void>;
+}
+
+declare const redeemPointsForCoupon: MaybeContext<BuildRESTFunction<typeof redeemPointsForCoupon$1> & typeof redeemPointsForCoupon$1>;
+declare const redeemCurrentMemberPointsForCoupon: MaybeContext<BuildRESTFunction<typeof redeemCurrentMemberPointsForCoupon$1> & typeof redeemCurrentMemberPointsForCoupon$1>;
+declare const getLoyaltyCoupon: MaybeContext<BuildRESTFunction<typeof getLoyaltyCoupon$1> & typeof getLoyaltyCoupon$1>;
+declare const bulkGetLoyaltyCoupon: MaybeContext<BuildRESTFunction<typeof bulkGetLoyaltyCoupon$1> & typeof bulkGetLoyaltyCoupon$1>;
+declare const getCurrentMemberCoupons: MaybeContext<BuildRESTFunction<typeof getCurrentMemberCoupons$1> & typeof getCurrentMemberCoupons$1>;
+declare const queryLoyaltyCoupons: MaybeContext<BuildRESTFunction<typeof queryLoyaltyCoupons$1> & typeof queryLoyaltyCoupons$1>;
+declare const deleteLoyaltyCoupon: MaybeContext<BuildRESTFunction<typeof deleteLoyaltyCoupon$1> & typeof deleteLoyaltyCoupon$1>;
+/**
+ * Triggered when a loyalty coupon is created.
+ */
+declare const onCouponCreated: ReturnType<typeof createEventModule<typeof publicOnCouponCreated>>;
+/**
+ * Triggered when a loyalty coupon is deleted.
+ */
+declare const onCouponDeleted: ReturnType<typeof createEventModule<typeof publicOnCouponDeleted>>;
+
+export { BulkGetLoyaltyCouponOptions, BulkGetLoyaltyCouponResponse, GetCurrentMemberCouponsResponse, LoyaltyCoupon, LoyaltyCouponsQueryBuilder, RedeemCurrentMemberPointsForCouponResponse, RedeemPointsForCouponOptions, RedeemPointsForCouponResponse, bulkGetLoyaltyCoupon, deleteLoyaltyCoupon, getCurrentMemberCoupons, getLoyaltyCoupon, onCouponCreated, onCouponDeleted, queryLoyaltyCoupons, redeemCurrentMemberPointsForCoupon, redeemPointsForCoupon };