@wix/auto_sdk_referral_programs 1.0.24 → 1.0.26

package/build/internal/es/{loyalty-referral-v1-program-programs.universal-C3JvbwiY.d.mts → index.typings.d.mts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface ReferralProgram {
     /**
      * Referral program name.
@@ -1097,6 +1099,13 @@ interface Subscription {
      * format.
      */
     countryCode?: string | null;
+    /**
+     * Seats of the product that the subscription was purchased for.
+     * Will be Null for products that don't support seats.
+     * @min 1
+     * @max 500
+     */
+    seats?: number | null;
 }
 interface BillingReference {
     /**
@@ -1600,6 +1609,92 @@ interface ProgramUpdatedEnvelope {
     entity: ReferralProgram;
     metadata: EventMetadata;
 }
+/**
+ * Triggered when a referral program is updated.
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage Referrals
+ * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
+ * @permissionId REFERRALS.READ_PROGRAM
+ * @webhook
+ * @eventType wix.loyalty.referral.v1.program_updated
+ * @serviceIdentifier wix.loyalty.referral.program.v1.ReferralPrograms
+ * @slug updated
+ */
+declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise<void>): void;
+type ProgramNonNullablePaths = `status` | `referredFriendReward.couponOptions.fixedAmountOptions.amount` | `referredFriendReward.couponOptions.percentageOptions.percentage` | `referredFriendReward.couponOptions.minimumSubtotal` | `referredFriendReward.couponOptions.scope.namespace` | `referredFriendReward.couponOptions.scope.group.name` | `referredFriendReward.couponOptions.name` | `referredFriendReward.couponOptions.discountType` | `referredFriendReward.loyaltyPointsOptions.amount` | `referredFriendReward.type` | `referringCustomerReward.couponOptions.fixedAmountOptions.amount` | `referringCustomerReward.couponOptions.percentageOptions.percentage` | `referringCustomerReward.couponOptions.minimumSubtotal` | `referringCustomerReward.couponOptions.scope.namespace` | `referringCustomerReward.couponOptions.scope.group.name` | `referringCustomerReward.couponOptions.name` | `referringCustomerReward.couponOptions.discountType` | `referringCustomerReward.loyaltyPointsOptions.amount` | `referringCustomerReward.type` | `successfulReferralActions` | `emails.encourageToReferFriends` | `emails.notifyCustomersAboutReward` | `premiumFeatures.referralProgram`;
+/**
+ * Retrieves the referral program.
+ * @public
+ * @permissionId REFERRALS.READ_PROGRAM
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GetReferralProgram
+ */
+declare function getReferralProgram(): Promise<NonNullablePaths<GetReferralProgramResponse, {
+    [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Retrieves multiple referral programs for all metasites that the caller is the member of.
+ *
+ * Must be called with a [user identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#identity-types).
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId REFERRALS.PROGRAM_BULK_READ
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.BulkGetReferralProgram
+ */
+declare function bulkGetReferralProgram(): Promise<NonNullablePaths<BulkGetReferralProgramResponse, `programInSites` | `programInSites.${number}.metaSiteId` | {
+    [P in ProgramNonNullablePaths]: `programInSites.${number}.referralProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Updates a referral program. Supports partial updates.
+ *
+ * Revision number, which increments by 1 each time the referral program is updated.
+ * To prevent conflicting changes, the current revision must be passed when updating the referral program.
+ * @param referralProgram - Referral program to update. Include the latest `revision` for a successful update.
+ * @public
+ * @requiredField referralProgram
+ * @requiredField referralProgram.revision
+ * @permissionId REFERRALS.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.UpdateReferralProgram
+ */
+declare function updateReferralProgram(referralProgram: NonNullablePaths<ReferralProgram, `revision`>): Promise<NonNullablePaths<UpdateReferralProgramResponse, {
+    [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Activates the referral program, changing its status to `ACTIVE`.
+ * @public
+ * @permissionId REFERRALS.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.ActivateReferralProgram
+ */
+declare function activateReferralProgram(): Promise<NonNullablePaths<ActivateReferralProgramResponse, {
+    [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Pauses the referral program, changing its status to `PAUSED`.
+ * @public
+ * @permissionId REFERRALS.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.PauseReferralProgram
+ */
+declare function pauseReferralProgram(): Promise<NonNullablePaths<PauseReferralProgramResponse, {
+    [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
+}[ProgramNonNullablePaths]>>;
+/**
+ * Retrieves pre-generated AI social media post suggestions for promoting 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 to allow referring customers to easily copy and share them on their preferred social media platforms.
+ *
+ * >**Note**: This method retrieves existing suggestions. To generate new ones,
+ * use Generate AI Social Media Posts Suggestions.
+ * @public
+ * @permissionId REFERRALS.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GetAISocialMediaPostsSuggestions
+ */
+declare function getAiSocialMediaPostsSuggestions(options?: GetAiSocialMediaPostsSuggestionsOptions): Promise<NonNullablePaths<GetAISocialMediaPostsSuggestionsResponse, `suggestions` | `suggestions.${number}.postContent`>>;
 interface GetAiSocialMediaPostsSuggestionsOptions {
     /**
      * Topic to generate social media post suggestions for. For example, fitness, education, or technology.
@@ -1607,6 +1702,18 @@ interface GetAiSocialMediaPostsSuggestionsOptions {
      */
     topic?: string;
 }
+/**
+ * Creates new AI-generated social media post suggestions for promoting the referral program.
+ *
+ * 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 method generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use Get AI Social Media Posts Suggestions.
+ * @public
+ * @permissionId REFERRALS.MANAGE_PROGRAM
+ * @applicableIdentity APP
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GenerateAISocialMediaPostsSuggestions
+ */
+declare function generateAiSocialMediaPostsSuggestions(options?: GenerateAiSocialMediaPostsSuggestionsOptions): Promise<NonNullablePaths<GenerateAISocialMediaPostsSuggestionsResponse, `suggestions` | `suggestions.${number}.postContent`>>;
 interface GenerateAiSocialMediaPostsSuggestionsOptions {
     /**
      * Topic to generate social media post suggestions for. For example, fitness, education, or technology.
@@ -1614,5 +1721,14 @@ interface GenerateAiSocialMediaPostsSuggestionsOptions {
      */
     topic?: string;
 }
+/**
+ * Retrieves information about the enabled premium features for the referral program.
+ * @public
+ * @permissionId REFERRALS.READ_PROGRAM
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GetReferralProgramPremiumFeatures
+ */
+declare function getReferralProgramPremiumFeatures(): Promise<NonNullablePaths<GetReferralProgramPremiumFeaturesResponse, `referralProgram`>>;
 
-export { type GetReferralProgramPremiumFeaturesRequest as $, type ActivateReferralProgramResponse as A, type BulkGetReferralProgramResponse as B, ContractSwitchType as C, DiscountType as D, type Group as E, type FixedAmountDiscount as F, type GetReferralProgramResponse as G, type Emails as H, IntervalUnit as I, type PremiumFeatures as J, type GetReferralProgramRequest as K, type LoyaltyPoints as L, type BulkGetReferralProgramRequest as M, Namespace as N, type ProgramInSite as O, type PauseReferralProgramResponse as P, type UpdateReferralProgramRequest as Q, type ReferralProgram as R, State as S, Type as T, type UpdateReferralProgramResponse as U, type ActivateReferralProgramRequest as V, WebhookIdentityType as W, type PauseReferralProgramRequest as X, type GetAISocialMediaPostsSuggestionsRequest as Y, type AISocialMediaPostSuggestion as Z, type GenerateAISocialMediaPostsSuggestionsRequest as _, type GetAiSocialMediaPostsSuggestionsOptions as a, type DomainEvent as a0, type DomainEventBodyOneOf as a1, type EntityCreatedEvent as a2, type RestoreInfo as a3, type EntityUpdatedEvent as a4, type EntityDeletedEvent as a5, type ActionEvent as a6, type Empty as a7, type MetaSiteSpecialEvent as a8, type MetaSiteSpecialEventPayloadOneOf as a9, type SubscriptionEventEventOneOf as aA, type SubscriptionCreated as aB, type Subscription as aC, type BillingReference as aD, type Cycle as aE, type CycleCycleSelectorOneOf as aF, type Interval as aG, type OneTime as aH, type ReactivationData as aI, type SubscriptionAssigned as aJ, type SubscriptionCancelled as aK, type CancellationDetails as aL, type SubscriptionAutoRenewTurnedOn as aM, type SubscriptionAutoRenewTurnedOff as aN, type SubscriptionUnassigned as aO, type SubscriptionTransferred as aP, type RecurringChargeSucceeded as aQ, type ContractSwitched as aR, type ProductPriceIncreaseData as aS, type SubscriptionNearEndOfPeriod as aT, type SubscriptionPendingChange as aU, type RecurringChargeAttemptFailed as aV, type MessageEnvelope as aW, type IdentificationData as aX, type IdentificationDataIdOneOf as aY, type BaseEventMetadata as aZ, type EventMetadata as a_, type Asset as aa, type SiteCreated as ab, type SiteTransferred as ac, type SiteDeleted as ad, type DeleteContext as ae, type SiteUndeleted as af, type SitePublished as ag, type SiteUnpublished as ah, type SiteMarkedAsTemplate as ai, type SiteMarkedAsWixSite as aj, type ServiceProvisioned as ak, type ServiceRemoved as al, type SiteRenamed as am, type SiteHardDeleted as an, type NamespaceChanged as ao, type StudioAssigned as ap, type StudioUnassigned as aq, type SiteUrlChanged as ar, type SitePurgedExternally as as, type OdeditorAssigned as at, type OdeditorUnassigned as au, type PicassoAssigned as av, type PicassoUnassigned as aw, type HtmlSitePublished as ax, type Page as ay, type SubscriptionEvent as az, type GetAISocialMediaPostsSuggestionsResponse as b, type GenerateAiSocialMediaPostsSuggestionsOptions as c, type GenerateAISocialMediaPostsSuggestionsResponse as d, type GetReferralProgramPremiumFeaturesResponse as e, type ProgramUpdatedEnvelope as f, ProgramStatus as g, Action as h, App as i, SiteCreatedContext as j, DeleteStatus as k, ProviderName as l, SubscriptionStatus as m, ReactivationReasonEnum as n, Initiator as o, UnassignReason as p, ContractSwitchReason as q, PriceIncreaseTrigger as r, ProductAdjustment as s, type Reward as t, type RewardOptionsOneOf as u, type Coupon as v, type CouponDiscountTypeOptionsOneOf as w, type CouponScopeOrMinSubtotalOneOf as x, type PercentageDiscount as y, type CouponScope as z };
+export { type AISocialMediaPostSuggestion, Action, type ActionEvent, type ActionWithLiterals, type ActivateReferralProgramRequest, type ActivateReferralProgramResponse, App, type AppWithLiterals, type Asset, type BaseEventMetadata, type BillingReference, type BulkGetReferralProgramRequest, type BulkGetReferralProgramResponse, type CancellationDetails, ContractSwitchReason, type ContractSwitchReasonWithLiterals, ContractSwitchType, type ContractSwitchTypeWithLiterals, type ContractSwitched, type Coupon, type CouponDiscountTypeOptionsOneOf, type CouponScope, type CouponScopeOrMinSubtotalOneOf, type Cycle, type CycleCycleSelectorOneOf, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Emails, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FixedAmountDiscount, type GenerateAISocialMediaPostsSuggestionsRequest, type GenerateAISocialMediaPostsSuggestionsResponse, type GenerateAiSocialMediaPostsSuggestionsOptions, type GetAISocialMediaPostsSuggestionsRequest, type GetAISocialMediaPostsSuggestionsResponse, type GetAiSocialMediaPostsSuggestionsOptions, type GetReferralProgramPremiumFeaturesRequest, type GetReferralProgramPremiumFeaturesResponse, type GetReferralProgramRequest, type GetReferralProgramResponse, type Group, type HtmlSitePublished, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type Interval, IntervalUnit, type IntervalUnitWithLiterals, type LoyaltyPoints, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type OneTime, type Page, type PauseReferralProgramRequest, type PauseReferralProgramResponse, type PercentageDiscount, type PicassoAssigned, type PicassoUnassigned, type PremiumFeatures, PriceIncreaseTrigger, type PriceIncreaseTriggerWithLiterals, ProductAdjustment, type ProductAdjustmentWithLiterals, type ProductPriceIncreaseData, type ProgramInSite, ProgramStatus, type ProgramStatusWithLiterals, type ProgramUpdatedEnvelope, ProviderName, type ProviderNameWithLiterals, type ReactivationData, ReactivationReasonEnum, type ReactivationReasonEnumWithLiterals, type RecurringChargeAttemptFailed, type RecurringChargeSucceeded, type ReferralProgram, type RestoreInfo, type Reward, type RewardOptionsOneOf, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, type Subscription, type SubscriptionAssigned, type SubscriptionAutoRenewTurnedOff, type SubscriptionAutoRenewTurnedOn, type SubscriptionCancelled, type SubscriptionCreated, type SubscriptionEvent, type SubscriptionEventEventOneOf, type SubscriptionNearEndOfPeriod, type SubscriptionPendingChange, SubscriptionStatus, type SubscriptionStatusWithLiterals, type SubscriptionTransferred, type SubscriptionUnassigned, Type, type TypeWithLiterals, UnassignReason, type UnassignReasonWithLiterals, type UpdateReferralProgramRequest, type UpdateReferralProgramResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, activateReferralProgram, bulkGetReferralProgram, generateAiSocialMediaPostsSuggestions, getAiSocialMediaPostsSuggestions, getReferralProgram, getReferralProgramPremiumFeatures, onProgramUpdated, pauseReferralProgram, updateReferralProgram };