@wix/referral 1.0.12 → 1.0.13

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

@@ -2,16 +2,21 @@ interface ReferralProgram$1 {
     /** Referral program name. */
     name?: string | null;
     /**
-     * The status of the referral program. Possible values:
+     * Status of the referral program.
      *
-     * - `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.
+     * Possible values:
+     *
+     * - `UNKNOWN`: The status of the referral program is unknown. This value is not used.
+     * - `DRAFT`: The referral program is in a draft state and is being modified. It is not yet active.
+     * - `ACTIVE`: The referral program is active.
+     * - `PAUSED`: The referral program is paused.
      * @readonly
      */
     status?: ProgramStatus$1;
-    /** 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 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;
     /**
      * Date and time the program was created.
@@ -19,7 +24,7 @@ interface ReferralProgram$1 {
      */
     createdDate?: Date;
     /**
-     * Date and time the program was updated.
+     * Date and time the program was last updated.
      * @readonly
      */
     updatedDate?: Date;
@@ -34,7 +39,7 @@ interface ReferralProgram$1 {
      */
     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.
+     * 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:
      *
@@ -48,8 +53,12 @@ interface ReferralProgram$1 {
     successfulReferralActions?: Action$1[];
     /**
      * Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @readonly
      * @deprecated Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @replacedBy GetReferralProgramPremiumFeatures
      * @targetRemovalDate 2024-09-01
      */
@@ -200,7 +209,7 @@ declare enum Action$1 {
 }
 interface Emails$1 {
     /**
-     * Encourage customers to refer their friends via email. Select which apps to enable.
+     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
      *
      * Available apps:
      *
@@ -231,7 +240,7 @@ declare enum App$1 {
 }
 interface PremiumFeatures$1 {
     /**
-     * Whether the user has the referral program feature.
+     * Whether the user has access to the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -454,16 +463,21 @@ interface ReferralProgram {
     /** Referral program name. */
     name?: string | null;
     /**
-     * The status of the referral program. Possible values:
+     * Status of the referral program.
+     *
+     * Possible values:
      *
-     * - `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.
+     * - `UNKNOWN`: The status of the referral program is unknown. This value is not used.
+     * - `DRAFT`: The referral program is in a draft state and is being modified. It is not yet active.
+     * - `ACTIVE`: The referral program is active.
+     * - `PAUSED`: The referral program is paused.
      * @readonly
      */
     status?: ProgramStatus;
-    /** 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 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;
     /**
      * Date and time the program was created.
@@ -471,7 +485,7 @@ interface ReferralProgram {
      */
     _createdDate?: Date;
     /**
-     * Date and time the program was updated.
+     * Date and time the program was last updated.
      * @readonly
      */
     _updatedDate?: Date;
@@ -486,7 +500,7 @@ interface ReferralProgram {
      */
     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.
+     * 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:
      *
@@ -500,8 +514,12 @@ interface ReferralProgram {
     successfulReferralActions?: Action[];
     /**
      * Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @readonly
      * @deprecated Whether the user has the required plan to use the referral program.
+     *
+     * Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
      * @replacedBy GetReferralProgramPremiumFeatures
      * @targetRemovalDate 2024-09-01
      */
@@ -652,7 +670,7 @@ declare enum Action {
 }
 interface Emails {
     /**
-     * Encourage customers to refer their friends via email. Select which apps to enable.
+     * Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
      *
      * Available apps:
      *
@@ -683,7 +701,7 @@ declare enum App {
 }
 interface PremiumFeatures {
     /**
-     * Whether the user has the referral program feature.
+     * Whether the user has access to the referral program feature.
      * @readonly
      */
     referralProgram?: boolean;
@@ -3057,55 +3075,58 @@ declare namespace meta$1 {
 /** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer$1 {
     /**
-     * ReferringCustomer id.
+     * ID of the referring customer.
      * @readonly
      */
     id?: string;
     /**
-     * Contact id.
+     * Contact ID associated with the referring customer.
      * @readonly
      */
     contactId?: string;
     /**
-     * Referral code.
+     * Unique code for the referral. For example, `GxpxwAoMqxH8`.
      * @readonly
      */
     referralCode?: string;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. */
+    /**
+     * Revision number, which increments by 1 each time the referring customer is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referring customer.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferringCustomer was created.
+     * Date and time the referring customer was created.
      * @readonly
      */
     createdDate?: Date;
     /**
-     * Represents the time this ReferringCustomer was last updated.
+     * Date and time the referring customer was last updated.
      * @readonly
      */
     updatedDate?: Date;
 }
 interface GenerateReferringCustomerForContactRequest$1 {
-    /** Contact id or "me" to generate current identity's referring customer. */
+    /** Contact ID or `"me"` to generate the current identity's referring customer. */
     contactId: string;
 }
 interface GenerateReferringCustomerForContactResponse$1 {
-    /** The created ReferringCustomer. */
+    /** Created referring customer. */
     referringCustomer?: ReferringCustomer$1;
 }
 interface GetReferringCustomerRequest$1 {
-    /** Id of the ReferringCustomer to retrieve. */
+    /** ID of the referring customer to retrieve. */
     referringCustomerId: string;
 }
 interface GetReferringCustomerResponse$1 {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer$1;
 }
 interface GetReferringCustomerByReferralCodeRequest$1 {
-    /** Referral Code of the ReferringCustomer to retrieve. */
+    /** Referral code of the referring customer to retrieve. */
     referralCode: string;
 }
 interface GetReferringCustomerByReferralCodeResponse$1 {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer$1;
 }
 interface QueryReferringCustomersRequest$1 {
@@ -3113,26 +3134,32 @@ interface QueryReferringCustomersRequest$1 {
     query: CursorQuery$1;
 }
 interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
-    /** 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$1;
     /**
-     * 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$1[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf$1 {
-    /** 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$1;
 }
 interface Sorting$1 {
@@ -3157,13 +3184,13 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 interface QueryReferringCustomersResponse$1 {
-    /** The retrieved ReferringCustomers. */
+    /** List of retrieved referring customers. */
     referringCustomers?: ReferringCustomer$1[];
     /** Paging metadata. */
     metadata?: CursorPagingMetadata$1;
 }
 interface CursorPagingMetadata$1 {
-    /** 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$1;
@@ -3182,9 +3209,9 @@ interface Cursors$1 {
     prev?: string | null;
 }
 interface DeleteReferringCustomerRequest$1 {
-    /** Id of the ReferringCustomer to delete. */
+    /** ID of the referring customer to delete. */
     referringCustomerId: string;
-    /** The revision of the ReferringCustomer. */
+    /** Revision number of the referring customer. */
     revision?: string;
 }
 interface DeleteReferringCustomerResponse$1 {
@@ -3210,55 +3237,58 @@ interface QueryReferringCustomersResponseNonNullableFields$1 {
 /** ReferringCustomer is the main entity of ReferringCustomers. */
 interface ReferringCustomer {
     /**
-     * ReferringCustomer id.
+     * ID of the referring customer.
      * @readonly
      */
     _id?: string;
     /**
-     * Contact id.
+     * Contact ID associated with the referring customer.
      * @readonly
      */
     contactId?: string;
     /**
-     * Referral code.
+     * Unique code for the referral. For example, `GxpxwAoMqxH8`.
      * @readonly
      */
     referralCode?: string;
-    /** Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. */
+    /**
+     * Revision number, which increments by 1 each time the referring customer is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the referring customer.
+     */
     revision?: string | null;
     /**
-     * Represents the time this ReferringCustomer was created.
+     * Date and time the referring customer was created.
      * @readonly
      */
     _createdDate?: Date;
     /**
-     * Represents the time this ReferringCustomer was last updated.
+     * Date and time the referring customer was last updated.
      * @readonly
      */
     _updatedDate?: Date;
 }
 interface GenerateReferringCustomerForContactRequest {
-    /** Contact id or "me" to generate current identity's referring customer. */
+    /** Contact ID or `"me"` to generate the current identity's referring customer. */
     contactId: string;
 }
 interface GenerateReferringCustomerForContactResponse {
-    /** The created ReferringCustomer. */
+    /** Created referring customer. */
     referringCustomer?: ReferringCustomer;
 }
 interface GetReferringCustomerRequest {
-    /** Id of the ReferringCustomer to retrieve. */
+    /** ID of the referring customer to retrieve. */
     referringCustomerId: string;
 }
 interface GetReferringCustomerResponse {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer;
 }
 interface GetReferringCustomerByReferralCodeRequest {
-    /** Referral Code of the ReferringCustomer to retrieve. */
+    /** Referral code of the referring customer to retrieve. */
     referralCode: string;
 }
 interface GetReferringCustomerByReferralCodeResponse {
-    /** The retrieved ReferringCustomer. */
+    /** Retrieved referring customer. */
     referringCustomer?: ReferringCustomer;
 }
 interface QueryReferringCustomersRequest {
@@ -3266,26 +3296,32 @@ interface QueryReferringCustomersRequest {
     query: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** 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;
     /**
-     * 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[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf {
-    /** 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;
 }
 interface Sorting {
@@ -3310,13 +3346,13 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QueryReferringCustomersResponse {
-    /** The retrieved ReferringCustomers. */
+    /** List of retrieved referring customers. */
     referringCustomers?: ReferringCustomer[];
     /** Paging metadata. */
     metadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
-    /** 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;
@@ -3335,9 +3371,9 @@ interface Cursors {
     prev?: string | null;
 }
 interface DeleteReferringCustomerRequest {
-    /** Id of the ReferringCustomer to delete. */
+    /** ID of the referring customer to delete. */
     referringCustomerId: string;
-    /** The revision of the ReferringCustomer. */
+    /** Revision number of the referring customer. */
     revision?: string;
 }
 interface DeleteReferringCustomerResponse {