@wix/auto_sdk_loyalty_coupons 1.0.13 → 1.0.15

package/build/cjs/meta.d.ts

@@ -1 +1,478 @@
-export * from './src/loyalty-v1-coupon-coupons.meta.js';
+import { m as RedeemPointsForCouponRequest$1, a as RedeemPointsForCouponResponse$1, n as RedeemCurrentMemberPointsForCouponRequest$1, b as RedeemCurrentMemberPointsForCouponResponse$1, q as GetLoyaltyCouponRequest$1, r as GetLoyaltyCouponResponse$1, s as BulkGetLoyaltyCouponRequest$1, c as BulkGetLoyaltyCouponResponse$1, y as GetCurrentMemberCouponsRequest$1, G as GetCurrentMemberCouponsResponse$1, Q as QueryLoyaltyCouponRequest$1, D as QueryLoyaltyCouponResponse$1, H as DeleteLoyaltyCouponRequest$1, I as DeleteLoyaltyCouponResponse$1 } from './loyalty-v1-coupon-coupons.universal-YZSAPFpG.js';
+
+/**
+ * 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).
+ */
+interface LoyaltyCoupon {
+    /**
+     * Loyalty coupon ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+    /**
+     * [Loyalty account ID](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/account-object) of the customer that redeemed points for a coupon.
+     * @format GUID
+     * @readonly
+     */
+    accountId?: string;
+    /**
+     * [Member ID](https://dev.wix.com/api/rest/members/members/member-object) of the customer that redeemed points for a coupon.
+     * @format GUID
+     * @readonly
+     * @deprecated [Member ID](https://dev.wix.com/api/rest/members/members/member-object) of the customer that redeemed points for a coupon.
+     * @replacedBy member_id
+     * @targetRemovalDate 2024-06-01
+     */
+    memberIdDeprecated?: string;
+    /**
+     * [Member ID](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object) of the customer that redeemed points for a coupon.
+     * @format GUID
+     * @readonly
+     */
+    memberId?: string | null;
+    /**
+     * Transaction ID for the transaction that created a coupon.
+     * @format GUID
+     * @readonly
+     */
+    transactionId?: string | null;
+    /**
+     * Reference coupon information for the corresponding [coupon](https://dev.wix.com/api/rest/coupons/about-wix-coupons)
+     * that is created along with the loyalty coupon.
+     * @readonly
+     */
+    couponReference?: CouponReference;
+    /**
+     * Loyalty coupon status.
+     *
+     * This status relates to the corresponding coupon that is created
+     * at the same time as the loyalty coupon and is included in `couponReference`.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * Name of reward that was redeemed to create this coupon.
+     * @minLength 1
+     * @maxLength 50
+     * @readonly
+     */
+    rewardName?: string;
+    /**
+     * 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.
+     * @immutable
+     */
+    revision?: string | null;
+    /**
+     * Date and time the loyalty coupon was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the loyalty coupon was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+interface CouponReference {
+    /**
+     * Coupon ID.
+     * @format GUID
+     * @readonly
+     */
+    couponId?: string;
+    /**
+     * Coupon code.
+     *
+     * Unique code entered by a customer to apply the coupon.
+     * @maxLength 20
+     * @readonly
+     */
+    code?: string;
+    /**
+     * Name of coupon.
+     * @maxLength 80
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * The information to use when creating the coupon.
+     * @readonly
+     */
+    specification?: Specification;
+    /**
+     * Whether the referenced coupon was deleted.
+     * @readonly
+     */
+    deleted?: boolean | null;
+}
+interface Specification extends SpecificationTypeDetailsOneOf, SpecificationScopeOrMinSubtotalOneOf {
+    /** Fixed price discount. */
+    moneyOffAmount?: number;
+    /** Discount as a percentage. */
+    percentOffRate?: number;
+    /** Free shipping. If true, the coupon applies to all items in all `namespaces` in the site. */
+    freeShipping?: boolean;
+    /** Specific sale price. Currently only supported for coupons with a `stores` `namespace`. */
+    fixedPriceAmount?: number;
+    /**
+     * Free products when making a purchase. `buyXGetY` is an object that specifies `x` and `y` in the
+     * following scenario: if a visitor purchases x number of products, they receive y number of products for free. C
+     * urrently only supported for coupons with a `stores` `namespace`.
+     */
+    buyXGetY?: BuyXGetY;
+    /**
+     * Scope of the coupon. When no scope is defined, the coupon applies to all
+     * items in all `namespaces` in the site.
+     */
+    scope?: Scope;
+    /** The coupon is only applicable when the order subtotal is over this amount. */
+    minimumSubtotal?: number | null;
+    /** Name of coupon. */
+    name?: string | null;
+    type?: TypeWithLiterals;
+    /**
+     * Whether the coupon is limited to 1 discount per order. If true and a customer pays for multiple items
+     * that the coupon applies to, only the lowest priced item is discounted.
+     * Coupons with a `bookings` `namespace` are always limited to 1 item.
+     */
+    limitedToOneItem?: boolean | null;
+    /** Whether the coupon also applies to subscriptions. */
+    appliesToSubscriptions?: boolean | null;
+    /**
+     * Specifies the amount of cycles to apply the discount to for a subscription item.
+     *
+     * Can only be set when `appliesToSubscriptions` is `TRUE` and `specification.scope.namespace` is `pricingPlans`.
+     * If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     *
+     * Min: `1`
+     *
+     * Max: `999`
+     */
+    discountedCycleCount?: number | null;
+}
+/** @oneof */
+interface SpecificationTypeDetailsOneOf {
+    /** Fixed price discount. */
+    moneyOffAmount?: number;
+    /** Discount as a percentage. */
+    percentOffRate?: number;
+    /** Free shipping. If true, the coupon applies to all items in all `namespaces` in the site. */
+    freeShipping?: boolean;
+    /** Specific sale price. Currently only supported for coupons with a `stores` `namespace`. */
+    fixedPriceAmount?: number;
+    /**
+     * Free products when making a purchase. `buyXGetY` is an object that specifies `x` and `y` in the
+     * following scenario: if a visitor purchases x number of products, they receive y number of products for free. C
+     * urrently only supported for coupons with a `stores` `namespace`.
+     */
+    buyXGetY?: BuyXGetY;
+}
+/** @oneof */
+interface SpecificationScopeOrMinSubtotalOneOf {
+    /**
+     * Scope of the coupon. When no scope is defined, the coupon applies to all
+     * items in all `namespaces` in the site.
+     */
+    scope?: Scope;
+    /** The coupon is only applicable when the order subtotal is over this amount. */
+    minimumSubtotal?: number | null;
+}
+declare enum Type {
+    UNKNOWN = "UNKNOWN",
+    MONEY_OFF_AMOUNT = "MONEY_OFF_AMOUNT",
+    PERCENT_OFF_RATE = "PERCENT_OFF_RATE",
+    FREE_SHIPPING = "FREE_SHIPPING",
+    FIXED_PRICE_AMOUNT = "FIXED_PRICE_AMOUNT",
+    BUY_X_GET_Y = "BUY_X_GET_Y"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN' | 'MONEY_OFF_AMOUNT' | 'PERCENT_OFF_RATE' | 'FREE_SHIPPING' | 'FIXED_PRICE_AMOUNT' | 'BUY_X_GET_Y';
+interface BuyXGetY {
+    /** Number of purchased items required to receive free items. */
+    x?: number;
+    /** Number of items received for free if required number of items were purchased. */
+    y?: number;
+}
+interface Scope {
+    /**
+     * Group within a `namespace` for which the coupon is applicable.
+     *
+     * If no group is specified, the coupon applies to all items in the namespace.
+     * `group` is required in some namespaces. See [Scope Values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values)
+     * for a list of currently supported groups for each namespace.
+     */
+    name?: string | null;
+    /**
+     * ID of the specific entity in the group for which the coupon is applicable.
+     *
+     * If no `entityId` is specified, the coupon applies to all entities in the group. In some cases when a group is specified,
+     * an `entityId` is required. See [Scope Values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values)
+     * for a list of currently supported entities for each namespace and group.
+     */
+    entityId?: string | null;
+    /**
+     * Wix application for which the coupon is applicable.
+     *
+     * One of the following:
+     * + `"stores"`
+     * + `"bookings"`
+     * + `"events"`
+     * + `"pricingPlans"`
+     */
+    namespace?: string;
+}
+declare enum Status {
+    /** Unknown status. */
+    UNKNOWN = "UNKNOWN",
+    /** The reference coupon was created but the loyalty points have not been redeemed yet. */
+    PENDING = "PENDING",
+    /** The reference coupon is active and available to the customer. */
+    ACTIVE = "ACTIVE",
+    /** The reference coupon was applied and is no longer available for use. */
+    APPLIED = "APPLIED",
+    /** The reference coupon was created but something went wrong when redeeming points from the loyalty account. */
+    FAILED = "FAILED",
+    /** The reference coupon was deleted. */
+    ARCHIVED = "ARCHIVED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN' | 'PENDING' | 'ACTIVE' | 'APPLIED' | 'FAILED' | 'ARCHIVED';
+interface RedeemPointsForCouponRequest {
+    /**
+     * ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+     * @format GUID
+     */
+    rewardId: string;
+    /**
+     * ID of the [loyalty account](https://dev.wix.com/docs/rest/crm/loyalty-program/accounts/account-object) of the customer redeeming points.
+     * @format GUID
+     */
+    loyaltyAccountId: string;
+}
+interface RedeemPointsForCouponResponse {
+    /** Created loyalty coupon. */
+    coupon?: LoyaltyCoupon;
+}
+interface RedeemCurrentMemberPointsForCouponRequest {
+    /**
+     * ID of the [loyalty reward](https://dev.wix.com/docs/rest/crm/loyalty-program/rewards/reward-object) to redeem.
+     * @format GUID
+     */
+    rewardId: string;
+}
+interface RedeemCurrentMemberPointsForCouponResponse {
+    /** Created loyalty coupon. */
+    coupon?: LoyaltyCoupon;
+}
+interface GetLoyaltyCouponRequest {
+    /**
+     * ID of the loyalty coupon to retrieve.
+     * @format GUID
+     */
+    loyaltyCouponId: string;
+}
+interface GetLoyaltyCouponResponse {
+    /** Retrieved loyalty coupon. */
+    loyaltyCoupon?: LoyaltyCoupon;
+}
+interface BulkGetLoyaltyCouponRequest {
+    /** Query to filter loyalty coupons. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface BulkGetLoyaltyCouponResponse {
+    /**
+     * Retrieved loyalty coupons.
+     * @maxSize 100
+     */
+    couponsInSite?: CouponsInSite[];
+}
+interface CouponsInSite {
+    /**
+     * Metasite id
+     * @format GUID
+     */
+    metaSiteId?: string;
+    /**
+     * Retrieved loyalty coupons.
+     * @maxSize 100
+     */
+    loyaltyCoupons?: LoyaltyCoupon[];
+}
+interface GetCurrentMemberCouponsRequest {
+}
+interface GetCurrentMemberCouponsResponse {
+    /** Retrieved loyalty coupons. */
+    loyaltyCoupons?: LoyaltyCoupon[];
+}
+interface QueryLoyaltyCouponRequest {
+    /** Query options. */
+    query: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface QueryLoyaltyCouponResponse {
+    /** Retrieved loyalty coupons. */
+    loyaltyCoupons?: LoyaltyCoupon[];
+    /** Metadata. */
+    metadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface DeleteLoyaltyCouponRequest {
+    /**
+     * ID of the loyalty coupon to delete.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * 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.
+     */
+    revision?: string;
+}
+interface DeleteLoyaltyCouponResponse {
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function redeemPointsForCoupon(): __PublicMethodMetaInfo<'POST', {}, RedeemPointsForCouponRequest$1, RedeemPointsForCouponRequest, RedeemPointsForCouponResponse$1, RedeemPointsForCouponResponse>;
+declare function redeemCurrentMemberPointsForCoupon(): __PublicMethodMetaInfo<'POST', {}, RedeemCurrentMemberPointsForCouponRequest$1, RedeemCurrentMemberPointsForCouponRequest, RedeemCurrentMemberPointsForCouponResponse$1, RedeemCurrentMemberPointsForCouponResponse>;
+declare function getLoyaltyCoupon(): __PublicMethodMetaInfo<'GET', {
+    loyaltyCouponId: string;
+}, GetLoyaltyCouponRequest$1, GetLoyaltyCouponRequest, GetLoyaltyCouponResponse$1, GetLoyaltyCouponResponse>;
+declare function bulkGetLoyaltyCoupon(): __PublicMethodMetaInfo<'GET', {}, BulkGetLoyaltyCouponRequest$1, BulkGetLoyaltyCouponRequest, BulkGetLoyaltyCouponResponse$1, BulkGetLoyaltyCouponResponse>;
+declare function getCurrentMemberCoupons(): __PublicMethodMetaInfo<'GET', {}, GetCurrentMemberCouponsRequest$1, GetCurrentMemberCouponsRequest, GetCurrentMemberCouponsResponse$1, GetCurrentMemberCouponsResponse>;
+declare function queryLoyaltyCoupons(): __PublicMethodMetaInfo<'POST', {}, QueryLoyaltyCouponRequest$1, QueryLoyaltyCouponRequest, QueryLoyaltyCouponResponse$1, QueryLoyaltyCouponResponse>;
+declare function deleteLoyaltyCoupon(): __PublicMethodMetaInfo<'DELETE', {
+    id: string;
+}, DeleteLoyaltyCouponRequest$1, DeleteLoyaltyCouponRequest, DeleteLoyaltyCouponResponse$1, DeleteLoyaltyCouponResponse>;
+
+export { type __PublicMethodMetaInfo, bulkGetLoyaltyCoupon, deleteLoyaltyCoupon, getCurrentMemberCoupons, getLoyaltyCoupon, queryLoyaltyCoupons, redeemCurrentMemberPointsForCoupon, redeemPointsForCoupon };