@wix/referral 1.0.9 → 1.0.10

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

@@ -1,54 +1,68 @@
-/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
 interface ReferralProgram$1 {
     /** Referral program name. */
     name?: string | null;
     /**
-     * Referral program status.
+     * The status of the referral program.
+     *
+     * `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.
      * @readonly
      */
     status?: ProgramStatus$1;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
+    /** Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current `revision` must be passed when updating the program. */
     revision?: string | null;
     /**
-     * Program's creation date and time.
+     * Date and time the program was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Program's last update date and time
+     * Date and time the program was updated.
      * @readonly
      */
     updatedDate?: Date;
-    /** Referred friend reward configuration. */
+    /** Reward configuration for the referred friend. Specifies the reward given to a new customer who was referred to the business. */
     referredFriendReward?: Reward$3;
-    /** Referring customer reward configuration. */
+    /** 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;
-    /** List of actions that complete referral. */
+    /**
+     * 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.
+     */
     successfulReferralActions?: Action$1[];
     /**
-     * Set to true if user has required plan to activate program.
+     * Whether the user has the required plan to use the referral program.
      * @readonly
-     * @deprecated Set to true if user has required plan to activate program.
+     * @deprecated Whether the user has the required plan to use the referral program.
      * @replacedBy GetReferralProgramPremiumFeatures
      * @targetRemovalDate 2024-09-01
      */
     isPremium?: boolean;
-    /** Emails configuration. */
+    /** Configures email notifications for the referral program. */
     emails?: Emails$1;
     /**
-     * Information about available premium features
+     * Indicates which premium features are available for the current account.
      * @readonly
      */
     premiumFeatures?: PremiumFeatures$1;
 }
 declare enum ProgramStatus$1 {
-    /** unknown status. */
+    /** Program status is unknown. */
     UNKNOWN = "UNKNOWN",
-    /** initial program status (program was created but was not enabled yet). */
+    /** Initial program status. The program was created but not activated. */
     DRAFT = "DRAFT",
-    /** program is active. */
+    /** Program is active. */
     ACTIVE = "ACTIVE",
-    /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
+    /** Program was manually disabled by the user. Can be reactivated. */
     PAUSED = "PAUSED"
 }
 interface Reward$3 extends RewardOptionsOneOf$1 {
@@ -77,37 +91,56 @@ declare enum Type$1 {
     NOTHING = "NOTHING"
 }
 interface Coupon$5 extends CouponDiscountTypeOptionsOneOf$5, CouponScopeOrMinSubtotalOneOf$5 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$5;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$5;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$5;
     /** Coupon name. */
     name?: string;
-    /** Coupon discount type. */
+    /**
+     * Coupon discount type.
+     *
+     * - `UNKNOWN`: Unknown discount type.
+     * - `FIXED_AMOUNT`: Discount as a fixed amount.
+     * - `PERCENTAGE`: Discount as a perctange.
+     * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
+     */
     discountType?: DiscountType$5;
-    /** Limit the coupon to only apply to one item in cart. */
+    /**
+     * Whether the coupon is limited to one item.
+     * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
+     * Coupons with a bookings `scope.namespace` are always limited to one item.
+     */
     limitedToOneItem?: boolean | null;
-    /** If true, coupon also applies to subscriptions. */
+    /** Whether the coupon applies to subscription products. */
     appliesToSubscriptions?: boolean | null;
-    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * - Can only be set when `scope.namespace = pricingPlans`.
+     * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
+     *
+     * Max: `999`
+     */
     discountedCycleCount?: number | null;
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$5 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$5;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$5;
 }
 /** @oneof */
 interface CouponScopeOrMinSubtotalOneOf$5 {
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$5;
 }
 declare enum DiscountType$5 {
@@ -121,17 +154,17 @@ declare enum DiscountType$5 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$5 {
-    /** Fixed amount to discount. */
+    /** Amount of discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$5 {
-    /** Percentage to discount. */
+    /** Percentage of discount. */
     percentage?: number;
 }
 interface CouponScope$5 {
-    /** Namespace of the coupon scope. */
+    /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Group of the coupon scope. */
+    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
     group?: Group$5;
 }
 interface Group$5 {
@@ -141,7 +174,7 @@ interface Group$5 {
     entityId?: string | null;
 }
 interface LoyaltyPoints$3 {
-    /** Amount of points to give. */
+    /** Number of loyalty points to give. */
     amount?: number;
 }
 declare enum Action$1 {
@@ -159,9 +192,18 @@ declare enum Action$1 {
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails$1 {
-    /** Encourage customers to refer their friends email. Select for which apps to enable. */
+    /**
+     * Encourage customers to refer their friends email. Select for which apps to enable.
+     *
+     * - `UNKNOWN`: Unknwown 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.
+     * - `BOOKINGS`: Send an email to customers who've placed an order with bookings.
+     * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
+     */
     encourageToReferFriends?: App$1[];
-    /** Notify customers about their referral reward email. Set true to enable email. */
+    /** Whether to notify customers about their referral reward email. Set to `true` to enable email notifications. */
     notifyCustomersAboutReward?: boolean;
 }
 declare enum App$1 {
@@ -180,7 +222,7 @@ declare enum App$1 {
 }
 interface PremiumFeatures$1 {
     /**
-     * Set to true if user has referral program feature.
+     * Whether the user has the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -188,11 +230,11 @@ interface PremiumFeatures$1 {
 interface GetReferralProgramRequest$1 {
 }
 interface GetReferralProgramResponse$1 {
-    /** The retrieved ReferralProgram. */
+    /** The retrieved referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface QueryReferralProgramsRequest$1 {
-    /** Query to filter ReferralPrograms. */
+    /** Query options. */
     query: CursorQuery$9;
 }
 interface CursorQuery$9 extends CursorQueryPagingMethodOneOf$9 {
@@ -246,13 +288,13 @@ interface CursorPaging$9 {
     cursor?: string | null;
 }
 interface QueryReferralProgramsResponse$1 {
-    /** ReferralPrograms that match the query. */
+    /** The referral programs that match the query. */
     referralPrograms?: ReferralProgram$1[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$9;
 }
 interface CursorPagingMetadata$9 {
-    /** 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$9;
@@ -271,56 +313,56 @@ interface Cursors$9 {
     prev?: string | null;
 }
 interface UpdateReferralProgramRequest$1 {
-    /** ReferralProgram to be updated, may be partial. */
+    /** Provide a `ReferralProgram` object with the fields to update. Include the latest `revision` for a successful update. */
     referralProgram: ReferralProgram$1;
 }
 interface UpdateReferralProgramResponse$1 {
-    /** The updated ReferralProgram. */
+    /** The updated referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface ActivateReferralProgramRequest$1 {
 }
 interface ActivateReferralProgramResponse$1 {
-    /** The activated ReferralProgram. */
+    /** The activated referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface PauseReferralProgramRequest$1 {
 }
 interface PauseReferralProgramResponse$1 {
-    /** The paused ReferralProgram. */
+    /** The paused referral program. */
     referralProgram?: ReferralProgram$1;
 }
 interface GetAISocialMediaPostsSuggestionsRequest$1 {
-    /** The topic to generate suggestions for. */
+    /** The topic to generate socia media post suggestions for. */
     topic?: string;
 }
 interface GetAISocialMediaPostsSuggestionsResponse$1 {
-    /** The generated suggestions. */
+    /** The generated social media post suggestions. */
     suggestions?: AISocialMediaPostSuggestion$1[];
-    /** The refer friends page URL. */
+    /** The referral URL to refer friends. */
     referFriendsPageUrl?: string | null;
 }
 interface AISocialMediaPostSuggestion$1 {
-    /** The suggested post content. */
+    /** Suggested post content. */
     postContent?: string;
-    /** The suggested hashtags. */
+    /** Suggested hashtags. */
     hashtags?: string[];
 }
 interface GenerateAISocialMediaPostsSuggestionsRequest$1 {
-    /** The topic to generate suggestions for. */
+    /** The topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GenerateAISocialMediaPostsSuggestionsResponse$1 {
-    /** The generated suggestions. */
+    /** Generated social media post suggestions. */
     suggestions?: AISocialMediaPostSuggestion$1[];
-    /** The refer friends page URL. */
+    /** Referral URL to refer friends. */
     referFriendsPageUrl?: string | null;
 }
 interface GetReferralProgramPremiumFeaturesRequest$1 {
 }
 interface GetReferralProgramPremiumFeaturesResponse$1 {
     /**
-     * Set to true if user has referral program feature.
+     * Whether the site has the referral program feature enabled.
      * @readonly
      */
     referralProgram?: boolean;
@@ -399,57 +441,71 @@ interface GetReferralProgramPremiumFeaturesResponseNonNullableFields$1 {
     referralProgram: boolean;
 }
 
-/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
 interface ReferralProgram {
     /** Referral program name. */
     name?: string | null;
     /**
-     * Referral program status.
+     * The status of the referral program.
+     *
+     * `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.
      * @readonly
      */
     status?: ProgramStatus;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
+    /** Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current `revision` must be passed when updating the program. */
     revision?: string | null;
     /**
-     * Program's creation date and time.
+     * Date and time the program was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Program's last update date and time
+     * Date and time the program was updated.
      * @readonly
      */
     _updatedDate?: Date;
-    /** Referred friend reward configuration. */
+    /** Reward configuration for the referred friend. Specifies the reward given to a new customer who was referred to the business. */
     referredFriendReward?: Reward$2;
-    /** Referring customer reward configuration. */
+    /** 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;
-    /** List of actions that complete referral. */
+    /**
+     * 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.
+     */
     successfulReferralActions?: Action[];
     /**
-     * Set to true if user has required plan to activate program.
+     * Whether the user has the required plan to use the referral program.
      * @readonly
-     * @deprecated Set to true if user has required plan to activate program.
+     * @deprecated Whether the user has the required plan to use the referral program.
      * @replacedBy GetReferralProgramPremiumFeatures
      * @targetRemovalDate 2024-09-01
      */
     isPremium?: boolean;
-    /** Emails configuration. */
+    /** Configures email notifications for the referral program. */
     emails?: Emails;
     /**
-     * Information about available premium features
+     * Indicates which premium features are available for the current account.
      * @readonly
      */
     premiumFeatures?: PremiumFeatures;
 }
 declare enum ProgramStatus {
-    /** unknown status. */
+    /** Program status is unknown. */
     UNKNOWN = "UNKNOWN",
-    /** initial program status (program was created but was not enabled yet). */
+    /** Initial program status. The program was created but not activated. */
     DRAFT = "DRAFT",
-    /** program is active. */
+    /** Program is active. */
     ACTIVE = "ACTIVE",
-    /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
+    /** Program was manually disabled by the user. Can be reactivated. */
     PAUSED = "PAUSED"
 }
 interface Reward$2 extends RewardOptionsOneOf {
@@ -478,37 +534,56 @@ declare enum Type {
     NOTHING = "NOTHING"
 }
 interface Coupon$4 extends CouponDiscountTypeOptionsOneOf$4, CouponScopeOrMinSubtotalOneOf$4 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$4;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$4;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$4;
     /** Coupon name. */
     name?: string;
-    /** Coupon discount type. */
+    /**
+     * Coupon discount type.
+     *
+     * - `UNKNOWN`: Unknown discount type.
+     * - `FIXED_AMOUNT`: Discount as a fixed amount.
+     * - `PERCENTAGE`: Discount as a perctange.
+     * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
+     */
     discountType?: DiscountType$4;
-    /** Limit the coupon to only apply to one item in cart. */
+    /**
+     * Whether the coupon is limited to one item.
+     * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
+     * Coupons with a bookings `scope.namespace` are always limited to one item.
+     */
     limitedToOneItem?: boolean | null;
-    /** If true, coupon also applies to subscriptions. */
+    /** Whether the coupon applies to subscription products. */
     appliesToSubscriptions?: boolean | null;
-    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * - Can only be set when `scope.namespace = pricingPlans`.
+     * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
+     *
+     * Max: `999`
+     */
     discountedCycleCount?: number | null;
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$4 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$4;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$4;
 }
 /** @oneof */
 interface CouponScopeOrMinSubtotalOneOf$4 {
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$4;
 }
 declare enum DiscountType$4 {
@@ -522,17 +597,17 @@ declare enum DiscountType$4 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$4 {
-    /** Fixed amount to discount. */
+    /** Amount of discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$4 {
-    /** Percentage to discount. */
+    /** Percentage of discount. */
     percentage?: number;
 }
 interface CouponScope$4 {
-    /** Namespace of the coupon scope. */
+    /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Group of the coupon scope. */
+    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
     group?: Group$4;
 }
 interface Group$4 {
@@ -542,7 +617,7 @@ interface Group$4 {
     entityId?: string | null;
 }
 interface LoyaltyPoints$2 {
-    /** Amount of points to give. */
+    /** Number of loyalty points to give. */
     amount?: number;
 }
 declare enum Action {
@@ -560,9 +635,18 @@ declare enum Action {
     RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
 }
 interface Emails {
-    /** Encourage customers to refer their friends email. Select for which apps to enable. */
+    /**
+     * Encourage customers to refer their friends email. Select for which apps to enable.
+     *
+     * - `UNKNOWN`: Unknwown 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.
+     * - `BOOKINGS`: Send an email to customers who've placed an order with bookings.
+     * - `RESTAURANTS`: Send an email to customers who've placed an order with restaurants.
+     */
     encourageToReferFriends?: App[];
-    /** Notify customers about their referral reward email. Set true to enable email. */
+    /** Whether to notify customers about their referral reward email. Set to `true` to enable email notifications. */
     notifyCustomersAboutReward?: boolean;
 }
 declare enum App {
@@ -581,7 +665,7 @@ declare enum App {
 }
 interface PremiumFeatures {
     /**
-     * Set to true if user has referral program feature.
+     * Whether the user has the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -589,11 +673,11 @@ interface PremiumFeatures {
 interface GetReferralProgramRequest {
 }
 interface GetReferralProgramResponse {
-    /** The retrieved ReferralProgram. */
+    /** The retrieved referral program. */
     referralProgram?: ReferralProgram;
 }
 interface QueryReferralProgramsRequest {
-    /** Query to filter ReferralPrograms. */
+    /** Query options. */
     query: CursorQuery$8;
 }
 interface CursorQuery$8 extends CursorQueryPagingMethodOneOf$8 {
@@ -647,13 +731,13 @@ interface CursorPaging$8 {
     cursor?: string | null;
 }
 interface QueryReferralProgramsResponse {
-    /** ReferralPrograms that match the query. */
+    /** The referral programs that match the query. */
     referralPrograms?: ReferralProgram[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$8;
 }
 interface CursorPagingMetadata$8 {
-    /** 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$8;
@@ -672,56 +756,56 @@ interface Cursors$8 {
     prev?: string | null;
 }
 interface UpdateReferralProgramRequest {
-    /** ReferralProgram to be updated, may be partial. */
+    /** Provide a `ReferralProgram` object with the fields to update. Include the latest `revision` for a successful update. */
     referralProgram: ReferralProgram;
 }
 interface UpdateReferralProgramResponse {
-    /** The updated ReferralProgram. */
+    /** The updated referral program. */
     referralProgram?: ReferralProgram;
 }
 interface ActivateReferralProgramRequest {
 }
 interface ActivateReferralProgramResponse {
-    /** The activated ReferralProgram. */
+    /** The activated referral program. */
     referralProgram?: ReferralProgram;
 }
 interface PauseReferralProgramRequest {
 }
 interface PauseReferralProgramResponse {
-    /** The paused ReferralProgram. */
+    /** The paused referral program. */
     referralProgram?: ReferralProgram;
 }
 interface GetAISocialMediaPostsSuggestionsRequest {
-    /** The topic to generate suggestions for. */
+    /** The topic to generate socia media post suggestions for. */
     topic?: string;
 }
 interface GetAISocialMediaPostsSuggestionsResponse {
-    /** The generated suggestions. */
+    /** The generated social media post suggestions. */
     suggestions?: AISocialMediaPostSuggestion[];
-    /** The refer friends page URL. */
+    /** The referral URL to refer friends. */
     referFriendsPageUrl?: string | null;
 }
 interface AISocialMediaPostSuggestion {
-    /** The suggested post content. */
+    /** Suggested post content. */
     postContent?: string;
-    /** The suggested hashtags. */
+    /** Suggested hashtags. */
     hashtags?: string[];
 }
 interface GenerateAISocialMediaPostsSuggestionsRequest {
-    /** The topic to generate suggestions for. */
+    /** The topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GenerateAISocialMediaPostsSuggestionsResponse {
-    /** The generated suggestions. */
+    /** Generated social media post suggestions. */
     suggestions?: AISocialMediaPostSuggestion[];
-    /** The refer friends page URL. */
+    /** Referral URL to refer friends. */
     referFriendsPageUrl?: string | null;
 }
 interface GetReferralProgramPremiumFeaturesRequest {
 }
 interface GetReferralProgramPremiumFeaturesResponse {
     /**
-     * Set to true if user has referral program feature.
+     * Whether the site has the referral program feature enabled.
      * @readonly
      */
     referralProgram?: boolean;
@@ -952,26 +1036,32 @@ interface QueryReferralEventRequest$1 {
     query: CursorQuery$7;
 }
 interface CursorQuery$7 extends CursorQueryPagingMethodOneOf$7 {
-    /** 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$7;
     /**
-     * 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$7[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$7 {
-    /** 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$7;
 }
 interface Sorting$7 {
@@ -1002,7 +1092,7 @@ interface QueryReferralEventResponse$1 {
     metadata?: CursorPagingMetadata$7;
 }
 interface CursorPagingMetadata$7 {
-    /** 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$7;
@@ -1171,37 +1261,56 @@ declare enum Status$5 {
     DELETED = "DELETED"
 }
 interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$3;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$3;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$3;
     /** Coupon name. */
     name?: string;
-    /** Coupon discount type. */
+    /**
+     * Coupon discount type.
+     *
+     * - `UNKNOWN`: Unknown discount type.
+     * - `FIXED_AMOUNT`: Discount as a fixed amount.
+     * - `PERCENTAGE`: Discount as a perctange.
+     * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
+     */
     discountType?: DiscountType$3;
-    /** Limit the coupon to only apply to one item in cart. */
+    /**
+     * Whether the coupon is limited to one item.
+     * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
+     * Coupons with a bookings `scope.namespace` are always limited to one item.
+     */
     limitedToOneItem?: boolean | null;
-    /** If true, coupon also applies to subscriptions. */
+    /** Whether the coupon applies to subscription products. */
     appliesToSubscriptions?: boolean | null;
-    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * - Can only be set when `scope.namespace = pricingPlans`.
+     * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
+     *
+     * Max: `999`
+     */
     discountedCycleCount?: number | null;
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$3 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$3;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$3;
 }
 /** @oneof */
 interface CouponScopeOrMinSubtotalOneOf$3 {
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$3;
 }
 declare enum DiscountType$3 {
@@ -1215,17 +1324,17 @@ declare enum DiscountType$3 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$3 {
-    /** Fixed amount to discount. */
+    /** Amount of discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$3 {
-    /** Percentage to discount. */
+    /** Percentage of discount. */
     percentage?: number;
 }
 interface CouponScope$3 {
-    /** Namespace of the coupon scope. */
+    /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Group of the coupon scope. */
+    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
     group?: Group$3;
 }
 interface Group$3 {
@@ -1461,26 +1570,32 @@ interface QueryReferralEventRequest {
     query: CursorQuery$6;
 }
 interface CursorQuery$6 extends CursorQueryPagingMethodOneOf$6 {
-    /** 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$6;
     /**
-     * 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$6[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$6 {
-    /** 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$6;
 }
 interface Sorting$6 {
@@ -1511,7 +1626,7 @@ interface QueryReferralEventResponse {
     metadata?: CursorPagingMetadata$6;
 }
 interface CursorPagingMetadata$6 {
-    /** 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$6;
@@ -1680,37 +1795,56 @@ declare enum Status$4 {
     DELETED = "DELETED"
 }
 interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$2;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$2;
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$2;
     /** Coupon name. */
     name?: string;
-    /** Coupon discount type. */
+    /**
+     * Coupon discount type.
+     *
+     * - `UNKNOWN`: Unknown discount type.
+     * - `FIXED_AMOUNT`: Discount as a fixed amount.
+     * - `PERCENTAGE`: Discount as a perctange.
+     * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
+     */
     discountType?: DiscountType$2;
-    /** Limit the coupon to only apply to one item in cart. */
+    /**
+     * Whether the coupon is limited to one item.
+     * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
+     * Coupons with a bookings `scope.namespace` are always limited to one item.
+     */
     limitedToOneItem?: boolean | null;
-    /** If true, coupon also applies to subscriptions. */
+    /** Whether the coupon applies to subscription products. */
     appliesToSubscriptions?: boolean | null;
-    /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
+    /**
+     * Specifies the amount of discounted cycles for a subscription item.
+     *
+     * - Can only be set when `scope.namespace = pricingPlans`.
+     * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
+     * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
+     *
+     * Max: `999`
+     */
     discountedCycleCount?: number | null;
 }
 /** @oneof */
 interface CouponDiscountTypeOptionsOneOf$2 {
-    /** Options for fixed amount discount type. */
+    /** Options for fixed amount discount. */
     fixedAmountOptions?: FixedAmountDiscount$2;
-    /** Options for percentage discount type. */
+    /** Options for percentage discount. */
     percentageOptions?: PercentageDiscount$2;
 }
 /** @oneof */
 interface CouponScopeOrMinSubtotalOneOf$2 {
     /** Limit the coupon to carts with a subtotal above this number. */
     minimumSubtotal?: number;
-    /** Specifies the type of line items this coupon will apply to. */
+    /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
     scope?: CouponScope$2;
 }
 declare enum DiscountType$2 {
@@ -1724,17 +1858,17 @@ declare enum DiscountType$2 {
     FREE_SHIPPING = "FREE_SHIPPING"
 }
 interface FixedAmountDiscount$2 {
-    /** Fixed amount to discount. */
+    /** Amount of discount as a fixed value. */
     amount?: number;
 }
 interface PercentageDiscount$2 {
-    /** Percentage to discount. */
+    /** Percentage of discount. */
     percentage?: number;
 }
 interface CouponScope$2 {
-    /** Namespace of the coupon scope. */
+    /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
     namespace?: string;
-    /** Group of the coupon scope. */
+    /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
     group?: Group$2;
 }
 interface Group$2 {