@wix/referral 1.0.20 → 1.0.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/referral",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,9 +18,9 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/referral_customers": "1.0.9",
+    "@wix/referral_customers": "1.0.10",
     "@wix/referral_friends": "1.0.7",
-    "@wix/referral_programs": "1.0.9",
+    "@wix/referral_programs": "1.0.11",
     "@wix/referral_rewards": "1.0.9",
     "@wix/referral_tracker": "1.0.12"
   },
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "ef20cb5036f8b43430134fb4780b30ddd9fe9a74d1e2a2e6a5c1538f"
+  "falconPackageHash": "28896ffca80e0f980ededfd93279d4cb284f81cd39c74d66ba7a6838"
 }

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

@@ -98,11 +98,11 @@ interface ReferralProgram {
     /**
      * 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.
+     * Deprecated: Use [Get Referral Program Premium Features](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.
+     * Deprecated: Use [Get Referral Program Premium Features](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
      */
@@ -697,7 +697,12 @@ declare enum Namespace {
      */
     BRANDED_FIRST = "BRANDED_FIRST",
     /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
-    NOWNIA = "NOWNIA"
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE"
 }
 /** Site transferred to another user. */
 interface SiteTransferred {
@@ -1551,7 +1556,7 @@ interface QueryReferralProgramsSignature {
     /**
      * Retrieves a list of referral programs, given the provided paging, filtering, and sorting.
      *
-     * To learn about working with _Query_ endpoints, see
+     * To learn about working with _Query_ method, see
      * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
      * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
      * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
@@ -1589,13 +1594,10 @@ interface GetAiSocialMediaPostsSuggestionsSignature {
     /**
      * Retrieves pre-generated AI social media post suggestions for promoting the referral program.
      *
-     * Use this method to get a list of AI-generated social media post suggestions
-     * that site owners or members can use to promote the referral program.
+     * This method returns a list of AI-generated social media post suggestions that site owners or members can use to promote the referral program. You can display these suggestions in your app's UI, allowing users to easily copy and share them on their preferred social media platforms.
      *
-     * These suggestions can be displayed to users in your app's UI, allowing them to easily copy and share on their preferred social media platforms.
-     *
-     * >**Note**: This endpoint retrieves existing suggestions. To generate new ones,
-     * use the [Generate AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/generate-ai-social-media-posts-suggestions) endpoint.
+     * >**Note**: This method retrieves existing suggestions. To generate new ones,
+     * use the [Generate AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/generate-ai-social-media-posts-suggestions) method.
      */
     (options?: GetAiSocialMediaPostsSuggestionsOptions | undefined): Promise<GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields>;
 }
@@ -1604,17 +1606,16 @@ interface GenerateAiSocialMediaPostsSuggestionsSignature {
     /**
      * Creates new AI-generated social media post suggestions for promoting the referral program.
      *
-     * Use this method to generate fresh AI-powered social media post suggestions for promoting the referral program. This is useful when you want to refresh
-     * the content or generate alternatives to the existing suggestions.
+     * This method generates new AI-powered social media post suggestions for promoting the referral program. Use it to refresh content or create alternatives to existing suggestions.
      *
-     * >**Note**: This endpoint generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use the [Get AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-ai-social-media-posts-suggestions) method.
+     * >**Note**: This method generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use the [Get AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-ai-social-media-posts-suggestions) method.
      */
     (options?: GenerateAiSocialMediaPostsSuggestionsOptions | undefined): Promise<GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields>;
 }
 declare function getReferralProgramPremiumFeatures$1(httpClient: HttpClient): GetReferralProgramPremiumFeaturesSignature;
 interface GetReferralProgramPremiumFeaturesSignature {
     /**
-     * Retrieves information about enabled premium features for the referral program.
+     * Retrieves information about the enabled premium features for the referral program.
      */
     (): Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
 }
@@ -4380,9 +4381,6 @@ interface QueryReferringCustomersSignature {
     /**
      * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
      *
-     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
-     * `contact_id`, `referral_code`, `created_date`, `updated_date`.
-     *
      * To learn about working with _Query_ endpoints, see
      * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
      * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),

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

@@ -98,11 +98,11 @@ interface ReferralProgram {
     /**
      * 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.
+     * Deprecated: Use [Get Referral Program Premium Features](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.
+     * Deprecated: Use [Get Referral Program Premium Features](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
      */
@@ -697,7 +697,12 @@ declare enum Namespace {
      */
     BRANDED_FIRST = "BRANDED_FIRST",
     /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
-    NOWNIA = "NOWNIA"
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE"
 }
 /** Site transferred to another user. */
 interface SiteTransferred {
@@ -1551,7 +1556,7 @@ interface QueryReferralProgramsSignature {
     /**
      * Retrieves a list of referral programs, given the provided paging, filtering, and sorting.
      *
-     * To learn about working with _Query_ endpoints, see
+     * To learn about working with _Query_ method, see
      * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
      * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
      * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
@@ -1589,13 +1594,10 @@ interface GetAiSocialMediaPostsSuggestionsSignature {
     /**
      * Retrieves pre-generated AI social media post suggestions for promoting the referral program.
      *
-     * Use this method to get a list of AI-generated social media post suggestions
-     * that site owners or members can use to promote the referral program.
+     * This method returns a list of AI-generated social media post suggestions that site owners or members can use to promote the referral program. You can display these suggestions in your app's UI, allowing users to easily copy and share them on their preferred social media platforms.
      *
-     * These suggestions can be displayed to users in your app's UI, allowing them to easily copy and share on their preferred social media platforms.
-     *
-     * >**Note**: This endpoint retrieves existing suggestions. To generate new ones,
-     * use the [Generate AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/generate-ai-social-media-posts-suggestions) endpoint.
+     * >**Note**: This method retrieves existing suggestions. To generate new ones,
+     * use the [Generate AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/generate-ai-social-media-posts-suggestions) method.
      */
     (options?: GetAiSocialMediaPostsSuggestionsOptions | undefined): Promise<GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields>;
 }
@@ -1604,17 +1606,16 @@ interface GenerateAiSocialMediaPostsSuggestionsSignature {
     /**
      * Creates new AI-generated social media post suggestions for promoting the referral program.
      *
-     * Use this method to generate fresh AI-powered social media post suggestions for promoting the referral program. This is useful when you want to refresh
-     * the content or generate alternatives to the existing suggestions.
+     * This method generates new AI-powered social media post suggestions for promoting the referral program. Use it to refresh content or create alternatives to existing suggestions.
      *
-     * >**Note**: This endpoint generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use the [Get AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-ai-social-media-posts-suggestions) method.
+     * >**Note**: This method generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use the [Get AI Social Media Posts Suggestions](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-ai-social-media-posts-suggestions) method.
      */
     (options?: GenerateAiSocialMediaPostsSuggestionsOptions | undefined): Promise<GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields>;
 }
 declare function getReferralProgramPremiumFeatures$1(httpClient: HttpClient): GetReferralProgramPremiumFeaturesSignature;
 interface GetReferralProgramPremiumFeaturesSignature {
     /**
-     * Retrieves information about enabled premium features for the referral program.
+     * Retrieves information about the enabled premium features for the referral program.
      */
     (): Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
 }
@@ -4380,9 +4381,6 @@ interface QueryReferringCustomersSignature {
     /**
      * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
      *
-     * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
-     * `contact_id`, `referral_code`, `created_date`, `updated_date`.
-     *
      * To learn about working with _Query_ endpoints, see
      * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
      * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),

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

@@ -54,11 +54,11 @@ interface ReferralProgram$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.
+     * Deprecated: Use [Get Referral Program Premium Features](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.
+     * Deprecated: Use [Get Referral Program Premium Features](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
      */
@@ -518,11 +518,11 @@ interface ReferralProgram {
     /**
      * 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.
+     * Deprecated: Use [Get Referral Program Premium Features](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.
+     * Deprecated: Use [Get Referral Program Premium Features](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
      */