@wix/referral 1.0.10 → 1.0.12

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

@@ -2,12 +2,12 @@ interface ReferralProgram$1 {
     /** Referral program name. */
     name?: string | null;
     /**
-     * The status of the referral program.
+     * The status of the referral program. Possible values:
      *
-     * `UNKNOWN`: Status is unknown, this status is never used.
-     * `DRAFT`: Rderral program is in a draft state, currently being modified, not yet active.
-     * `ACTIVE`: Referral program is active.
-     * `PAUSED`: Referral program is paused.
+     * - `UNKNOWN`: Status is unknown. This value is never used.
+     * - `DRAFT`: Referral program is in a draft state and is currently being modified. Not yet active.
+     * - `ACTIVE`: Referral program is active.
+     * - `PAUSED`: Referral program is paused.
      * @readonly
      */
     status?: ProgramStatus$1;
@@ -23,20 +23,27 @@ interface ReferralProgram$1 {
      * @readonly
      */
     updatedDate?: Date;
-    /** Reward configuration for the referred friend. Specifies the reward given to a new customer who was referred to the business. */
+    /**
+     * Reward configuration for the referred friend.
+     * Specifies the reward given to a new customer who was referred to the business.
+     */
     referredFriendReward?: Reward$3;
-    /** Reward configuration for the referring customer. Specifies the reward given to an existing customer who referred a new customer to the business. */
+    /**
+     * Reward configuration for the referring customer.
+     * Specifies the reward given to an existing customer who referred a new customer to the business.
+     */
     referringCustomerReward?: Reward$3;
     /**
      * A list of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
      *
      * Possible values:
-     * -`UNKNOWN`: Action is unknown.
-     * -`STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
-     * -`PLAN_ORDERED`: Referred friend ordered and paid for a plan.
-     * -`TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
-     * -`SESSION_BOOKED`: Referred friend booked and paid for a session.
-     * -`RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
+     *
+     * - `UNKNOWN`: Action is unknown.
+     * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
+     * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
+     * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
+     * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
+     * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
      */
     successfulReferralActions?: Action$1[];
     /**
@@ -193,9 +200,11 @@ declare enum Action$1 {
 }
 interface Emails$1 {
     /**
-     * Encourage customers to refer their friends email. Select for which apps to enable.
+     * Encourage customers to refer their friends via email. Select which apps to enable.
+     *
+     * Available apps:
      *
-     * - `UNKNOWN`: Unknwown email.
+     * - `UNKNOWN`: Unknown email.
      * - `STORES`: Send an email to customers who've placed an order with stores.
      * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
      * - `EVENTS`: Send an email to customers who've placed an order with events.
@@ -230,7 +239,7 @@ interface PremiumFeatures$1 {
 interface GetReferralProgramRequest$1 {
 }
 interface GetReferralProgramResponse$1 {
-    /** The retrieved referral program. */
+    /** Retrieved referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface QueryReferralProgramsRequest$1 {
@@ -288,7 +297,7 @@ interface CursorPaging$9 {
     cursor?: string | null;
 }
 interface QueryReferralProgramsResponse$1 {
-    /** The referral programs that match the query. */
+    /** Referral programs matching the query. */
     referralPrograms?: ReferralProgram$1[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$9;
@@ -313,33 +322,33 @@ interface Cursors$9 {
     prev?: string | null;
 }
 interface UpdateReferralProgramRequest$1 {
-    /** Provide a `ReferralProgram` object with the fields to update. Include the latest `revision` for a successful update. */
+    /** Referral program to update. Include the latest `revision` for a successful update. */
     referralProgram: ReferralProgram$1;
 }
 interface UpdateReferralProgramResponse$1 {
-    /** The updated referral program. */
+    /** Updated referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface ActivateReferralProgramRequest$1 {
 }
 interface ActivateReferralProgramResponse$1 {
-    /** The activated referral program. */
+    /** Activated referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface PauseReferralProgramRequest$1 {
 }
 interface PauseReferralProgramResponse$1 {
-    /** The paused referral program. */
+    /** Paused referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface GetAISocialMediaPostsSuggestionsRequest$1 {
-    /** The topic to generate socia media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GetAISocialMediaPostsSuggestionsResponse$1 {
-    /** The generated social media post suggestions. */
+    /** Generated social media post suggestions. */
     suggestions?: AISocialMediaPostSuggestion$1[];
-    /** The referral URL to refer friends. */
+    /** Referral URL to refer friends. */
     referFriendsPageUrl?: string | null;
 }
 interface AISocialMediaPostSuggestion$1 {
@@ -349,7 +358,7 @@ interface AISocialMediaPostSuggestion$1 {
     hashtags?: string[];
 }
 interface GenerateAISocialMediaPostsSuggestionsRequest$1 {
-    /** The topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GenerateAISocialMediaPostsSuggestionsResponse$1 {
@@ -445,12 +454,12 @@ interface ReferralProgram {
     /** Referral program name. */
     name?: string | null;
     /**
-     * The status of the referral program.
+     * The status of the referral program. Possible values:
      *
-     * `UNKNOWN`: Status is unknown, this status is never used.
-     * `DRAFT`: Rderral program is in a draft state, currently being modified, not yet active.
-     * `ACTIVE`: Referral program is active.
-     * `PAUSED`: Referral program is paused.
+     * - `UNKNOWN`: Status is unknown. This value is never used.
+     * - `DRAFT`: Referral program is in a draft state and is currently being modified. Not yet active.
+     * - `ACTIVE`: Referral program is active.
+     * - `PAUSED`: Referral program is paused.
      * @readonly
      */
     status?: ProgramStatus;
@@ -466,20 +475,27 @@ interface ReferralProgram {
      * @readonly
      */
     _updatedDate?: Date;
-    /** Reward configuration for the referred friend. Specifies the reward given to a new customer who was referred to the business. */
+    /**
+     * Reward configuration for the referred friend.
+     * Specifies the reward given to a new customer who was referred to the business.
+     */
     referredFriendReward?: Reward$2;
-    /** Reward configuration for the referring customer. Specifies the reward given to an existing customer who referred a new customer to the business. */
+    /**
+     * Reward configuration for the referring customer.
+     * Specifies the reward given to an existing customer who referred a new customer to the business.
+     */
     referringCustomerReward?: Reward$2;
     /**
      * A list of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
      *
      * Possible values:
-     * -`UNKNOWN`: Action is unknown.
-     * -`STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
-     * -`PLAN_ORDERED`: Referred friend ordered and paid for a plan.
-     * -`TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
-     * -`SESSION_BOOKED`: Referred friend booked and paid for a session.
-     * -`RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
+     *
+     * - `UNKNOWN`: Action is unknown.
+     * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
+     * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
+     * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
+     * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
+     * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
      */
     successfulReferralActions?: Action[];
     /**
@@ -636,9 +652,11 @@ declare enum Action {
 }
 interface Emails {
     /**
-     * Encourage customers to refer their friends email. Select for which apps to enable.
+     * Encourage customers to refer their friends via email. Select which apps to enable.
+     *
+     * Available apps:
      *
-     * - `UNKNOWN`: Unknwown email.
+     * - `UNKNOWN`: Unknown email.
      * - `STORES`: Send an email to customers who've placed an order with stores.
      * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
      * - `EVENTS`: Send an email to customers who've placed an order with events.
@@ -673,7 +691,7 @@ interface PremiumFeatures {
 interface GetReferralProgramRequest {
 }
 interface GetReferralProgramResponse {
-    /** The retrieved referral program. */
+    /** Retrieved referral program. */
     referralProgram?: ReferralProgram;
 }
 interface QueryReferralProgramsRequest {
@@ -731,7 +749,7 @@ interface CursorPaging$8 {
     cursor?: string | null;
 }
 interface QueryReferralProgramsResponse {
-    /** The referral programs that match the query. */
+    /** Referral programs matching the query. */
     referralPrograms?: ReferralProgram[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$8;
@@ -756,33 +774,33 @@ interface Cursors$8 {
     prev?: string | null;
 }
 interface UpdateReferralProgramRequest {
-    /** Provide a `ReferralProgram` object with the fields to update. Include the latest `revision` for a successful update. */
+    /** Referral program to update. Include the latest `revision` for a successful update. */
     referralProgram: ReferralProgram;
 }
 interface UpdateReferralProgramResponse {
-    /** The updated referral program. */
+    /** Updated referral program. */
     referralProgram?: ReferralProgram;
 }
 interface ActivateReferralProgramRequest {
 }
 interface ActivateReferralProgramResponse {
-    /** The activated referral program. */
+    /** Activated referral program. */
     referralProgram?: ReferralProgram;
 }
 interface PauseReferralProgramRequest {
 }
 interface PauseReferralProgramResponse {
-    /** The paused referral program. */
+    /** Paused referral program. */
     referralProgram?: ReferralProgram;
 }
 interface GetAISocialMediaPostsSuggestionsRequest {
-    /** The topic to generate socia media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GetAISocialMediaPostsSuggestionsResponse {
-    /** The generated social media post suggestions. */
+    /** Generated social media post suggestions. */
     suggestions?: AISocialMediaPostSuggestion[];
-    /** The referral URL to refer friends. */
+    /** Referral URL to refer friends. */
     referFriendsPageUrl?: string | null;
 }
 interface AISocialMediaPostSuggestion {
@@ -792,7 +810,7 @@ interface AISocialMediaPostSuggestion {
     hashtags?: string[];
 }
 interface GenerateAISocialMediaPostsSuggestionsRequest {
-    /** The topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GenerateAISocialMediaPostsSuggestionsResponse {
@@ -915,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;
@@ -1230,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 {
@@ -1350,7 +1374,7 @@ interface LoyaltyPoints$1 {
      */
     transactionId?: string;
     /**
-     * Loyalty points amount given.
+     * The number of loyalty points awarded.
      * @readonly
      */
     amount?: number;
@@ -1449,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;
@@ -1764,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 {
@@ -1884,7 +1914,7 @@ interface LoyaltyPoints {
      */
     transactionId?: string;
     /**
-     * Loyalty points amount given.
+     * The number of loyalty points awarded.
      * @readonly
      */
     amount?: number;
@@ -2623,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.
@@ -2667,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. */
@@ -2709,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 {
@@ -2759,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;
@@ -2799,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.
@@ -2843,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. */
@@ -2885,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 {
@@ -2935,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;