@wix/referral 1.0.11 → 1.0.12

package/type-bundles/meta.bundle.d.ts

@@ -933,7 +933,6 @@ declare namespace meta$4 {
   export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_activateReferralProgram as activateReferralProgram, meta$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, meta$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, meta$4_getReferralProgram as getReferralProgram, meta$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, meta$4_pauseReferralProgram as pauseReferralProgram, meta$4_queryReferralPrograms as queryReferralPrograms, meta$4_updateReferralProgram as updateReferralProgram };
 }
 
-/** ReferralEvent. */
 interface ReferralEvent$1 extends ReferralEventEventTypeOneOf$1 {
     /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
     referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
@@ -1248,34 +1247,41 @@ interface ReferredFriendActionRewardTypeOptionsOneOf$1 {
 }
 interface V1Coupon$3 {
     /**
-     * Coupon ID.
+     * Coupon ID. Example: `8934b045-7052-4a90-be2b-832c70afc9da`.
      * @readonly
      */
     id?: string;
     /**
-     * Coupon code.
+     * The code that customers can use to apply the coupon. Example: `6RFD2A3HSPXW`.
      * @readonly
      */
     code?: string;
     /**
-     * Coupon status.
+     * Current status of the coupon.
+     *
+     * Possible values:
+     *
+     * - `UNKNOWN`: Unknown coupon status.
+     * - `ACTIVE`: Coupon is active and can be applied.
+     * - `APPLIED`: Coupon was already applied and can't be used anymore.
+     * - `DELETED`: Coupon was deleted.
      * @readonly
      */
     status?: Status$5;
     /**
-     * Coupon specification.
+     * Detailed specifications of the coupon.
      * @readonly
      */
     couponSpecification?: Coupon$3;
 }
 declare enum Status$5 {
-    /** Unknown coupon status. */
+    /** The coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** Coupon is active and can be applied. */
+    /** The coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** Coupon was already applied and can not be used anymore. */
+    /** The coupon has been applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** Coupon was deleted. */
+    /** The coupon has been deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
@@ -1368,7 +1374,7 @@ interface LoyaltyPoints$1 {
      */
     transactionId?: string;
     /**
-     * Loyalty points amount given.
+     * The number of loyalty points awarded.
      * @readonly
      */
     amount?: number;
@@ -1467,7 +1473,6 @@ interface QueryReferredFriendActionsResponseNonNullableFields$1 {
     referredFriendActions: ReferredFriendActionNonNullableFields$1[];
 }
 
-/** ReferralEvent. */
 interface ReferralEvent extends ReferralEventEventTypeOneOf {
     /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
     referredFriendSignupEvent?: ReferredFriendSignupEvent;
@@ -1782,34 +1787,41 @@ interface ReferredFriendActionRewardTypeOptionsOneOf {
 }
 interface V1Coupon$2 {
     /**
-     * Coupon ID.
+     * Coupon ID. Example: `8934b045-7052-4a90-be2b-832c70afc9da`.
      * @readonly
      */
     _id?: string;
     /**
-     * Coupon code.
+     * The code that customers can use to apply the coupon. Example: `6RFD2A3HSPXW`.
      * @readonly
      */
     code?: string;
     /**
-     * Coupon status.
+     * Current status of the coupon.
+     *
+     * Possible values:
+     *
+     * - `UNKNOWN`: Unknown coupon status.
+     * - `ACTIVE`: Coupon is active and can be applied.
+     * - `APPLIED`: Coupon was already applied and can't be used anymore.
+     * - `DELETED`: Coupon was deleted.
      * @readonly
      */
     status?: Status$4;
     /**
-     * Coupon specification.
+     * Detailed specifications of the coupon.
      * @readonly
      */
     couponSpecification?: Coupon$2;
 }
 declare enum Status$4 {
-    /** Unknown coupon status. */
+    /** The coupon status is unknown or not specified. */
     UNKNOWN = "UNKNOWN",
-    /** Coupon is active and can be applied. */
+    /** The coupon is active and can be applied to purchases. */
     ACTIVE = "ACTIVE",
-    /** Coupon was already applied and can not be used anymore. */
+    /** The coupon has been applied and can't be used again. */
     APPLIED = "APPLIED",
-    /** Coupon was deleted. */
+    /** The coupon has been deleted and is no longer valid. */
     DELETED = "DELETED"
 }
 interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
@@ -1902,7 +1914,7 @@ interface LoyaltyPoints {
      */
     transactionId?: string;
     /**
-     * Loyalty points amount given.
+     * The number of loyalty points awarded.
      * @readonly
      */
     amount?: number;
@@ -2641,7 +2653,6 @@ declare namespace meta$2 {
   export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_getReferralReward as getReferralReward, meta$2_queryReferralRewards as queryReferralRewards };
 }
 
-/** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
 interface ReferredFriend$1 {
     /**
      * ReferredFriend ID.
@@ -2685,6 +2696,8 @@ declare enum Status$1 {
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest$1 {
+    /** Referral code for referred friend */
+    referralCode?: string | null;
 }
 interface CreateReferredFriendResponse$1 {
     /** The created ReferredFriend. */
@@ -2727,26 +2740,32 @@ interface QueryReferredFriendRequest$1 {
     query: CursorQuery$3;
 }
 interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
-    /** 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`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$3;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * 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 in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * 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$3[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$3 {
-    /** 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`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$3;
 }
 interface Sorting$3 {
@@ -2777,7 +2796,7 @@ interface QueryReferredFriendResponse$1 {
     metadata?: CursorPagingMetadata$3;
 }
 interface CursorPagingMetadata$3 {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors$3;
@@ -2817,7 +2836,6 @@ interface QueryReferredFriendResponseNonNullableFields$1 {
     referredFriends: ReferredFriendNonNullableFields$1[];
 }
 
-/** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
 interface ReferredFriend {
     /**
      * ReferredFriend ID.
@@ -2861,6 +2879,8 @@ declare enum Status {
     ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
 }
 interface CreateReferredFriendRequest {
+    /** Referral code for referred friend */
+    referralCode?: string | null;
 }
 interface CreateReferredFriendResponse {
     /** The created ReferredFriend. */
@@ -2903,26 +2923,32 @@ interface QueryReferredFriendRequest {
     query: CursorQuery$2;
 }
 interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
-    /** 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`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$2;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * 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 in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * 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$2[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$2 {
-    /** 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`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging$2;
 }
 interface Sorting$2 {
@@ -2953,7 +2979,7 @@ interface QueryReferredFriendResponse {
     metadata?: CursorPagingMetadata$2;
 }
 interface CursorPagingMetadata$2 {
-    /** Number of items returned in the response. */
+    /** Number of items returned in current page. */
     count?: number | null;
     /** Cursor strings that point to the next page, previous page, or both. */
     cursors?: Cursors$2;