@wix/auto_sdk_loyalty_coupons 1.0.12 → 1.0.14

package/build/internal/{cjs/src/loyalty-v1-coupon-coupons.types.d.ts → meta.d.ts}

@@ -1,8 +1,10 @@
+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).
  */
-export interface LoyaltyCoupon {
+interface LoyaltyCoupon {
     /**
      * Loyalty coupon ID.
      * @format GUID
@@ -49,7 +51,7 @@ export interface LoyaltyCoupon {
      * at the same time as the loyalty coupon and is included in `couponReference`.
      * @readonly
      */
-    status?: Status;
+    status?: StatusWithLiterals;
     /**
      * Name of reward that was redeemed to create this coupon.
      * @minLength 1
@@ -75,7 +77,7 @@ export interface LoyaltyCoupon {
      */
     updatedDate?: Date | null;
 }
-export interface CouponReference {
+interface CouponReference {
     /**
      * Coupon ID.
      * @format GUID
@@ -107,7 +109,7 @@ export interface CouponReference {
      */
     deleted?: boolean | null;
 }
-export interface Specification extends SpecificationTypeDetailsOneOf, SpecificationScopeOrMinSubtotalOneOf {
+interface Specification extends SpecificationTypeDetailsOneOf, SpecificationScopeOrMinSubtotalOneOf {
     /** Fixed price discount. */
     moneyOffAmount?: number;
     /** Discount as a percentage. */
@@ -131,7 +133,7 @@ export interface Specification extends SpecificationTypeDetailsOneOf, Specificat
     minimumSubtotal?: number | null;
     /** Name of coupon. */
     name?: string | null;
-    type?: Type;
+    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.
@@ -153,7 +155,7 @@ export interface Specification extends SpecificationTypeDetailsOneOf, Specificat
     discountedCycleCount?: number | null;
 }
 /** @oneof */
-export interface SpecificationTypeDetailsOneOf {
+interface SpecificationTypeDetailsOneOf {
     /** Fixed price discount. */
     moneyOffAmount?: number;
     /** Discount as a percentage. */
@@ -170,7 +172,7 @@ export interface SpecificationTypeDetailsOneOf {
     buyXGetY?: BuyXGetY;
 }
 /** @oneof */
-export interface SpecificationScopeOrMinSubtotalOneOf {
+interface SpecificationScopeOrMinSubtotalOneOf {
     /**
      * Scope of the coupon. When no scope is defined, the coupon applies to all
      * items in all `namespaces` in the site.
@@ -179,7 +181,7 @@ export interface SpecificationScopeOrMinSubtotalOneOf {
     /** The coupon is only applicable when the order subtotal is over this amount. */
     minimumSubtotal?: number | null;
 }
-export declare enum Type {
+declare enum Type {
     UNKNOWN = "UNKNOWN",
     MONEY_OFF_AMOUNT = "MONEY_OFF_AMOUNT",
     PERCENT_OFF_RATE = "PERCENT_OFF_RATE",
@@ -187,13 +189,15 @@ export declare enum Type {
     FIXED_PRICE_AMOUNT = "FIXED_PRICE_AMOUNT",
     BUY_X_GET_Y = "BUY_X_GET_Y"
 }
-export interface BuyXGetY {
+/** @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;
 }
-export interface Scope {
+interface Scope {
     /**
      * Group within a `namespace` for which the coupon is applicable.
      *
@@ -221,7 +225,7 @@ export interface Scope {
      */
     namespace?: string;
 }
-export declare enum Status {
+declare enum Status {
     /** Unknown status. */
     UNKNOWN = "UNKNOWN",
     /** The reference coupon was created but the loyalty points have not been redeemed yet. */
@@ -235,7 +239,9 @@ export declare enum Status {
     /** The reference coupon was deleted. */
     ARCHIVED = "ARCHIVED"
 }
-export interface RedeemPointsForCouponRequest {
+/** @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
@@ -247,59 +253,37 @@ export interface RedeemPointsForCouponRequest {
      */
     loyaltyAccountId: string;
 }
-export interface RedeemPointsForCouponResponse {
+interface RedeemPointsForCouponResponse {
     /** Created loyalty coupon. */
     coupon?: LoyaltyCoupon;
 }
-export interface RedeemCurrentMemberPointsForCouponRequest {
+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;
 }
-export interface RedeemCurrentMemberPointsForCouponResponse {
+interface RedeemCurrentMemberPointsForCouponResponse {
     /** Created loyalty coupon. */
     coupon?: LoyaltyCoupon;
 }
-export interface RedeemMemberPointsForDiscountAmountCouponRequest {
-    /**
-     * ID of the [loyalty reward](https://dev.wix.com/api/rest/wix-loyalty-program/rewards) to redeem.
-     * @format GUID
-     */
-    rewardId?: string;
-    /**
-     * Loyalty account id.
-     * @format GUID
-     */
-    loyaltyAccountId?: string;
-    /** Number of points to redeem. */
-    pointsToRedeem?: number;
-    /** Coupon specification. */
-    specification?: Specification;
-}
-export interface RedeemMemberPointsForDiscountAmountCouponResponse {
-    /** Created loyalty coupon. */
-    coupon?: LoyaltyCoupon;
-    /** Transaction id of the coupon redemption */
-    transactionId?: string;
-}
-export interface GetLoyaltyCouponRequest {
+interface GetLoyaltyCouponRequest {
     /**
      * ID of the loyalty coupon to retrieve.
      * @format GUID
      */
     loyaltyCouponId: string;
 }
-export interface GetLoyaltyCouponResponse {
+interface GetLoyaltyCouponResponse {
     /** Retrieved loyalty coupon. */
     loyaltyCoupon?: LoyaltyCoupon;
 }
-export interface BulkGetLoyaltyCouponRequest {
+interface BulkGetLoyaltyCouponRequest {
     /** Query to filter loyalty coupons. */
     query?: CursorQuery;
 }
-export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -321,7 +305,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface CursorQueryPagingMethodOneOf {
+interface CursorQueryPagingMethodOneOf {
     /**
      * Cursor paging options.
      *
@@ -329,20 +313,22 @@ export interface CursorQueryPagingMethodOneOf {
      */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
     /** Sort order. */
-    order?: SortOrder;
+    order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface CursorPaging {
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -357,14 +343,14 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface BulkGetLoyaltyCouponResponse {
+interface BulkGetLoyaltyCouponResponse {
     /**
      * Retrieved loyalty coupons.
      * @maxSize 100
      */
     couponsInSite?: CouponsInSite[];
 }
-export interface CouponsInSite {
+interface CouponsInSite {
     /**
      * Metasite id
      * @format GUID
@@ -376,17 +362,17 @@ export interface CouponsInSite {
      */
     loyaltyCoupons?: LoyaltyCoupon[];
 }
-export interface GetCurrentMemberCouponsRequest {
+interface GetCurrentMemberCouponsRequest {
 }
-export interface GetCurrentMemberCouponsResponse {
+interface GetCurrentMemberCouponsResponse {
     /** Retrieved loyalty coupons. */
     loyaltyCoupons?: LoyaltyCoupon[];
 }
-export interface QueryLoyaltyCouponRequest {
+interface QueryLoyaltyCouponRequest {
     /** Query options. */
     query: QueryV2;
 }
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
+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`. */
@@ -409,25 +395,25 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
     fieldsets?: string[];
 }
 /** @oneof */
-export interface QueryV2PagingMethodOneOf {
+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;
 }
-export interface Paging {
+interface Paging {
     /** Number of items to load. */
     limit?: number | null;
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface QueryLoyaltyCouponResponse {
+interface QueryLoyaltyCouponResponse {
     /** Retrieved loyalty coupons. */
     loyaltyCoupons?: LoyaltyCoupon[];
     /** Metadata. */
     metadata?: PagingMetadataV2;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -439,7 +425,7 @@ export interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -451,7 +437,7 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface DeleteLoyaltyCouponRequest {
+interface DeleteLoyaltyCouponRequest {
     /**
      * ID of the loyalty coupon to delete.
      * @format GUID
@@ -464,141 +450,29 @@ export interface DeleteLoyaltyCouponRequest {
      */
     revision?: string;
 }
-export interface DeleteLoyaltyCouponResponse {
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface Empty {
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityType;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
+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 };