@wix/referral 1.0.10 → 1.0.11

package/build/cjs/index.d.ts

@@ -1,5 +1,6 @@
-export * as programs from '@wix/referral_programs';
-export * as tracker from '@wix/referral_tracker';
-export * as rewards from '@wix/referral_rewards';
-export * as friends from '@wix/referral_friends';
-export * as customers from '@wix/referral_customers';
+import * as programs from '@wix/referral_programs';
+import * as tracker from '@wix/referral_tracker';
+import * as rewards from '@wix/referral_rewards';
+import * as friends from '@wix/referral_friends';
+import * as customers from '@wix/referral_customers';
+export { programs, tracker, rewards, friends, customers };

package/build/cjs/index.js

@@ -24,9 +24,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.customers = exports.friends = exports.rewards = exports.tracker = exports.programs = void 0;
-exports.programs = __importStar(require("@wix/referral_programs"));
-exports.tracker = __importStar(require("@wix/referral_tracker"));
-exports.rewards = __importStar(require("@wix/referral_rewards"));
-exports.friends = __importStar(require("@wix/referral_friends"));
-exports.customers = __importStar(require("@wix/referral_customers"));
+const programs = __importStar(require("@wix/referral_programs"));
+exports.programs = programs;
+const tracker = __importStar(require("@wix/referral_tracker"));
+exports.tracker = tracker;
+const rewards = __importStar(require("@wix/referral_rewards"));
+exports.rewards = rewards;
+const friends = __importStar(require("@wix/referral_friends"));
+exports.friends = friends;
+const customers = __importStar(require("@wix/referral_customers"));
+exports.customers = customers;
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mEAAmD;AACnD,iEAAiD;AACjD,iEAAiD;AACjD,iEAAiD;AACjD,qEAAqD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAM1C,4BAAQ;AALjB,+DAAiD;AAK9B,0BAAO;AAJ1B,+DAAiD;AAIrB,0BAAO;AAHnC,+DAAiD;AAGZ,0BAAO;AAF5C,mEAAqD;AAEP,8BAAS"}

package/build/es/index.d.ts

@@ -1,5 +1,6 @@
-export * as programs from '@wix/referral_programs';
-export * as tracker from '@wix/referral_tracker';
-export * as rewards from '@wix/referral_rewards';
-export * as friends from '@wix/referral_friends';
-export * as customers from '@wix/referral_customers';
+import * as programs from '@wix/referral_programs';
+import * as tracker from '@wix/referral_tracker';
+import * as rewards from '@wix/referral_rewards';
+import * as friends from '@wix/referral_friends';
+import * as customers from '@wix/referral_customers';
+export { programs, tracker, rewards, friends, customers };

package/build/es/index.js

@@ -1,6 +1,7 @@
-export * as programs from '@wix/referral_programs';
-export * as tracker from '@wix/referral_tracker';
-export * as rewards from '@wix/referral_rewards';
-export * as friends from '@wix/referral_friends';
-export * as customers from '@wix/referral_customers';
+import * as programs from '@wix/referral_programs';
+import * as tracker from '@wix/referral_tracker';
+import * as rewards from '@wix/referral_rewards';
+import * as friends from '@wix/referral_friends';
+import * as customers from '@wix/referral_customers';
+export { programs, tracker, rewards, friends, customers };
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,SAAS,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,SAAS,MAAM,yBAAyB,CAAC;AAErD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/referral",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -20,7 +20,7 @@
   "dependencies": {
     "@wix/referral_customers": "1.0.3",
     "@wix/referral_friends": "1.0.3",
-    "@wix/referral_programs": "1.0.4",
+    "@wix/referral_programs": "1.0.5",
     "@wix/referral_rewards": "1.0.3",
     "@wix/referral_tracker": "1.0.8"
   },
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "3157b97850c8040506d7db3153f29f173e0eb0edc668b0d8072543c0"
+  "falconPackageHash": "cb8fb04410a2d63adac1d1080c0a161c6ae88f349cededb46d3e1b25"
 }

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

@@ -2,12 +2,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;
@@ -23,20 +23,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[];
     /**
@@ -193,9 +200,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.
@@ -230,19 +239,19 @@ interface PremiumFeatures {
 interface GetReferralProgramRequest {
 }
 interface GetReferralProgramResponse {
-    /** The retrieved referral program. */
+    /** Retrieved referral program. */
     referralProgram?: ReferralProgram;
 }
 interface BulkGetReferralProgramRequest {
 }
 interface BulkGetReferralProgramResponse {
-    /** The retrieved referral programs. */
+    /** Retrieved referral programs. */
     programInSites?: ProgramInSite[];
 }
 interface ProgramInSite {
     /** Metasite ID. */
     metaSiteId?: string;
-    /** The retrieved referral program. */
+    /** Retrieved referral program. */
     referralProgram?: ReferralProgram;
 }
 interface QueryReferralProgramsRequest {
@@ -300,7 +309,7 @@ interface CursorPaging$4 {
     cursor?: string | null;
 }
 interface QueryReferralProgramsResponse {
-    /** The referral programs that match the query. */
+    /** Referral programs matching the query. */
     referralPrograms?: ReferralProgram[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$4;
@@ -325,33 +334,33 @@ interface Cursors$4 {
     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 {
@@ -361,7 +370,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 {
@@ -1466,11 +1475,11 @@ interface ReferralProgramsQueryBuilder {
     find: () => Promise<ReferralProgramsQueryResult>;
 }
 interface GetAiSocialMediaPostsSuggestionsOptions {
-    /** The topic to generate socia media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GenerateAiSocialMediaPostsSuggestionsOptions {
-    /** The topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 

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

@@ -2,12 +2,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;
@@ -23,20 +23,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[];
     /**
@@ -193,9 +200,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.
@@ -230,19 +239,19 @@ interface PremiumFeatures {
 interface GetReferralProgramRequest {
 }
 interface GetReferralProgramResponse {
-    /** The retrieved referral program. */
+    /** Retrieved referral program. */
     referralProgram?: ReferralProgram;
 }
 interface BulkGetReferralProgramRequest {
 }
 interface BulkGetReferralProgramResponse {
-    /** The retrieved referral programs. */
+    /** Retrieved referral programs. */
     programInSites?: ProgramInSite[];
 }
 interface ProgramInSite {
     /** Metasite ID. */
     metaSiteId?: string;
-    /** The retrieved referral program. */
+    /** Retrieved referral program. */
     referralProgram?: ReferralProgram;
 }
 interface QueryReferralProgramsRequest {
@@ -300,7 +309,7 @@ interface CursorPaging$4 {
     cursor?: string | null;
 }
 interface QueryReferralProgramsResponse {
-    /** The referral programs that match the query. */
+    /** Referral programs matching the query. */
     referralPrograms?: ReferralProgram[];
     /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata$4;
@@ -325,33 +334,33 @@ interface Cursors$4 {
     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 {
@@ -361,7 +370,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 {
@@ -1466,11 +1475,11 @@ interface ReferralProgramsQueryBuilder {
     find: () => Promise<ReferralProgramsQueryResult>;
 }
 interface GetAiSocialMediaPostsSuggestionsOptions {
-    /** The topic to generate socia media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 interface GenerateAiSocialMediaPostsSuggestionsOptions {
-    /** The topic to generate social media post suggestions for. */
+    /** Topic to generate social media post suggestions for. */
     topic?: string;
 }
 

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 {