@wix/referral 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -493,7 +493,7 @@ interface DomainEventBodyOneOf$4 {
493
493
  interface EntityCreatedEvent$4 {
494
494
  entity?: string;
495
495
  }
496
- interface RestoreInfo$3 {
496
+ interface RestoreInfo$4 {
497
497
  deletedDate?: Date;
498
498
  }
499
499
  interface EntityUpdatedEvent$4 {
@@ -1761,7 +1761,7 @@ declare const index_d$4_pauseReferralProgram: typeof pauseReferralProgram;
1761
1761
  declare const index_d$4_queryReferralPrograms: typeof queryReferralPrograms;
1762
1762
  declare const index_d$4_updateReferralProgram: typeof updateReferralProgram;
1763
1763
  declare namespace index_d$4 {
1764
- export { type index_d$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, index_d$4_Action as Action, type ActionEvent$4 as ActionEvent, type index_d$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type index_d$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type index_d$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, index_d$4_App as App, type index_d$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BillingReference as BillingReference, type index_d$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type index_d$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type index_d$4_CancellationDetails as CancellationDetails, index_d$4_ContractSwitchReason as ContractSwitchReason, index_d$4_ContractSwitchType as ContractSwitchType, type index_d$4_ContractSwitched as ContractSwitched, type Coupon$2 as Coupon, type CouponDiscountTypeOptionsOneOf$2 as CouponDiscountTypeOptionsOneOf, type CouponScope$2 as CouponScope, type CouponScopeOrMinSubtotalOneOf$2 as CouponScopeOrMinSubtotalOneOf, type CursorPaging$4 as CursorPaging, type CursorPagingMetadata$4 as CursorPagingMetadata, type CursorQuery$4 as CursorQuery, type CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf, type Cursors$4 as Cursors, type index_d$4_Cycle as Cycle, type index_d$4_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, type index_d$4_DeleteContext as DeleteContext, index_d$4_DeleteStatus as DeleteStatus, DiscountType$2 as DiscountType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type index_d$4_Emails as Emails, type Empty$3 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$3 as EventMetadata, type FixedAmountDiscount$2 as FixedAmountDiscount, type index_d$4_GenerateAISocialMediaPostsSuggestionsRequest as GenerateAISocialMediaPostsSuggestionsRequest, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponse as GenerateAISocialMediaPostsSuggestionsResponse, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields as GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GenerateAiSocialMediaPostsSuggestionsOptions as GenerateAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetAISocialMediaPostsSuggestionsRequest as GetAISocialMediaPostsSuggestionsRequest, type index_d$4_GetAISocialMediaPostsSuggestionsResponse as GetAISocialMediaPostsSuggestionsResponse, type index_d$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields as GetAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GetAiSocialMediaPostsSuggestionsOptions as GetAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetReferralProgramPremiumFeaturesRequest as GetReferralProgramPremiumFeaturesRequest, type index_d$4_GetReferralProgramPremiumFeaturesResponse as GetReferralProgramPremiumFeaturesResponse, type index_d$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields as GetReferralProgramPremiumFeaturesResponseNonNullableFields, type index_d$4_GetReferralProgramRequest as GetReferralProgramRequest, type index_d$4_GetReferralProgramResponse as GetReferralProgramResponse, type index_d$4_GetReferralProgramResponseNonNullableFields as GetReferralProgramResponseNonNullableFields, type Group$2 as Group, type index_d$4_HtmlSitePublished as HtmlSitePublished, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, index_d$4_Initiator as Initiator, type index_d$4_Interval as Interval, index_d$4_IntervalUnit as IntervalUnit, type LoyaltyPoints$2 as LoyaltyPoints, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d$4_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, index_d$4_Namespace as Namespace, type index_d$4_NamespaceChanged as NamespaceChanged, type index_d$4_OneTime as OneTime, type index_d$4_Page as Page, type index_d$4_PauseReferralProgramRequest as PauseReferralProgramRequest, type index_d$4_PauseReferralProgramResponse as PauseReferralProgramResponse, type index_d$4_PauseReferralProgramResponseNonNullableFields as PauseReferralProgramResponseNonNullableFields, type PercentageDiscount$2 as PercentageDiscount, type index_d$4_PremiumFeatures as PremiumFeatures, index_d$4_PriceIncreaseTrigger as PriceIncreaseTrigger, index_d$4_ProductAdjustment as ProductAdjustment, type index_d$4_ProductPriceIncreaseData as ProductPriceIncreaseData, type index_d$4_ProgramInSite as ProgramInSite, index_d$4_ProgramStatus as ProgramStatus, type index_d$4_ProgramUpdatedEnvelope as ProgramUpdatedEnvelope, index_d$4_ProviderName as ProviderName, type index_d$4_QueryReferralProgramsRequest as QueryReferralProgramsRequest, type index_d$4_QueryReferralProgramsResponse as QueryReferralProgramsResponse, type index_d$4_QueryReferralProgramsResponseNonNullableFields as QueryReferralProgramsResponseNonNullableFields, type index_d$4_ReactivationData as ReactivationData, index_d$4_ReactivationReasonEnum as ReactivationReasonEnum, type index_d$4_RecurringChargeSucceeded as RecurringChargeSucceeded, type index_d$4_ReferralProgram as ReferralProgram, type index_d$4_ReferralProgramsQueryBuilder as ReferralProgramsQueryBuilder, type index_d$4_ReferralProgramsQueryResult as ReferralProgramsQueryResult, type RestoreInfo$3 as RestoreInfo, type Reward$2 as Reward, type RewardOptionsOneOf$1 as RewardOptionsOneOf, type index_d$4_ServiceProvisioned as ServiceProvisioned, type index_d$4_ServiceRemoved as ServiceRemoved, type index_d$4_SiteCreated as SiteCreated, index_d$4_SiteCreatedContext as SiteCreatedContext, type index_d$4_SiteDeleted as SiteDeleted, type index_d$4_SiteHardDeleted as SiteHardDeleted, type index_d$4_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d$4_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d$4_SitePublished as SitePublished, type index_d$4_SiteRenamed as SiteRenamed, type index_d$4_SiteTransferred as SiteTransferred, type index_d$4_SiteUndeleted as SiteUndeleted, type index_d$4_SiteUnpublished as SiteUnpublished, SortOrder$4 as SortOrder, type Sorting$4 as Sorting, index_d$4_State as State, type index_d$4_StudioAssigned as StudioAssigned, type index_d$4_StudioUnassigned as StudioUnassigned, type index_d$4_Subscription as Subscription, type index_d$4_SubscriptionAssigned as SubscriptionAssigned, type index_d$4_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type index_d$4_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type index_d$4_SubscriptionCancelled as SubscriptionCancelled, type index_d$4_SubscriptionCreated as SubscriptionCreated, type index_d$4_SubscriptionEvent as SubscriptionEvent, type index_d$4_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type index_d$4_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type index_d$4_SubscriptionPendingChange as SubscriptionPendingChange, index_d$4_SubscriptionStatus as SubscriptionStatus, type index_d$4_SubscriptionTransferred as SubscriptionTransferred, type index_d$4_SubscriptionUnassigned as SubscriptionUnassigned, Type$1 as Type, index_d$4_UnassignReason as UnassignReason, type index_d$4_UpdateReferralProgramRequest as UpdateReferralProgramRequest, type index_d$4_UpdateReferralProgramResponse as UpdateReferralProgramResponse, type index_d$4_UpdateReferralProgramResponseNonNullableFields as UpdateReferralProgramResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, type index_d$4__publicActivateReferralProgramType as _publicActivateReferralProgramType, type index_d$4__publicGenerateAiSocialMediaPostsSuggestionsType as _publicGenerateAiSocialMediaPostsSuggestionsType, type index_d$4__publicGetAiSocialMediaPostsSuggestionsType as _publicGetAiSocialMediaPostsSuggestionsType, type index_d$4__publicGetReferralProgramPremiumFeaturesType as _publicGetReferralProgramPremiumFeaturesType, type index_d$4__publicGetReferralProgramType as _publicGetReferralProgramType, type index_d$4__publicOnProgramUpdatedType as _publicOnProgramUpdatedType, type index_d$4__publicPauseReferralProgramType as _publicPauseReferralProgramType, type index_d$4__publicQueryReferralProgramsType as _publicQueryReferralProgramsType, type index_d$4__publicUpdateReferralProgramType as _publicUpdateReferralProgramType, index_d$4_activateReferralProgram as activateReferralProgram, index_d$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, index_d$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, index_d$4_getReferralProgram as getReferralProgram, index_d$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, index_d$4_onProgramUpdated as onProgramUpdated, index_d$4_pauseReferralProgram as pauseReferralProgram, onProgramUpdated$1 as publicOnProgramUpdated, index_d$4_queryReferralPrograms as queryReferralPrograms, index_d$4_updateReferralProgram as updateReferralProgram };
1764
+ export { type index_d$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, index_d$4_Action as Action, type ActionEvent$4 as ActionEvent, type index_d$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type index_d$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type index_d$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, index_d$4_App as App, type index_d$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BillingReference as BillingReference, type index_d$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type index_d$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type index_d$4_CancellationDetails as CancellationDetails, index_d$4_ContractSwitchReason as ContractSwitchReason, index_d$4_ContractSwitchType as ContractSwitchType, type index_d$4_ContractSwitched as ContractSwitched, type Coupon$2 as Coupon, type CouponDiscountTypeOptionsOneOf$2 as CouponDiscountTypeOptionsOneOf, type CouponScope$2 as CouponScope, type CouponScopeOrMinSubtotalOneOf$2 as CouponScopeOrMinSubtotalOneOf, type CursorPaging$4 as CursorPaging, type CursorPagingMetadata$4 as CursorPagingMetadata, type CursorQuery$4 as CursorQuery, type CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf, type Cursors$4 as Cursors, type index_d$4_Cycle as Cycle, type index_d$4_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, type index_d$4_DeleteContext as DeleteContext, index_d$4_DeleteStatus as DeleteStatus, DiscountType$2 as DiscountType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type index_d$4_Emails as Emails, type Empty$3 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$3 as EventMetadata, type FixedAmountDiscount$2 as FixedAmountDiscount, type index_d$4_GenerateAISocialMediaPostsSuggestionsRequest as GenerateAISocialMediaPostsSuggestionsRequest, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponse as GenerateAISocialMediaPostsSuggestionsResponse, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields as GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GenerateAiSocialMediaPostsSuggestionsOptions as GenerateAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetAISocialMediaPostsSuggestionsRequest as GetAISocialMediaPostsSuggestionsRequest, type index_d$4_GetAISocialMediaPostsSuggestionsResponse as GetAISocialMediaPostsSuggestionsResponse, type index_d$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields as GetAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GetAiSocialMediaPostsSuggestionsOptions as GetAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetReferralProgramPremiumFeaturesRequest as GetReferralProgramPremiumFeaturesRequest, type index_d$4_GetReferralProgramPremiumFeaturesResponse as GetReferralProgramPremiumFeaturesResponse, type index_d$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields as GetReferralProgramPremiumFeaturesResponseNonNullableFields, type index_d$4_GetReferralProgramRequest as GetReferralProgramRequest, type index_d$4_GetReferralProgramResponse as GetReferralProgramResponse, type index_d$4_GetReferralProgramResponseNonNullableFields as GetReferralProgramResponseNonNullableFields, type Group$2 as Group, type index_d$4_HtmlSitePublished as HtmlSitePublished, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, index_d$4_Initiator as Initiator, type index_d$4_Interval as Interval, index_d$4_IntervalUnit as IntervalUnit, type LoyaltyPoints$2 as LoyaltyPoints, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d$4_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, index_d$4_Namespace as Namespace, type index_d$4_NamespaceChanged as NamespaceChanged, type index_d$4_OneTime as OneTime, type index_d$4_Page as Page, type index_d$4_PauseReferralProgramRequest as PauseReferralProgramRequest, type index_d$4_PauseReferralProgramResponse as PauseReferralProgramResponse, type index_d$4_PauseReferralProgramResponseNonNullableFields as PauseReferralProgramResponseNonNullableFields, type PercentageDiscount$2 as PercentageDiscount, type index_d$4_PremiumFeatures as PremiumFeatures, index_d$4_PriceIncreaseTrigger as PriceIncreaseTrigger, index_d$4_ProductAdjustment as ProductAdjustment, type index_d$4_ProductPriceIncreaseData as ProductPriceIncreaseData, type index_d$4_ProgramInSite as ProgramInSite, index_d$4_ProgramStatus as ProgramStatus, type index_d$4_ProgramUpdatedEnvelope as ProgramUpdatedEnvelope, index_d$4_ProviderName as ProviderName, type index_d$4_QueryReferralProgramsRequest as QueryReferralProgramsRequest, type index_d$4_QueryReferralProgramsResponse as QueryReferralProgramsResponse, type index_d$4_QueryReferralProgramsResponseNonNullableFields as QueryReferralProgramsResponseNonNullableFields, type index_d$4_ReactivationData as ReactivationData, index_d$4_ReactivationReasonEnum as ReactivationReasonEnum, type index_d$4_RecurringChargeSucceeded as RecurringChargeSucceeded, type index_d$4_ReferralProgram as ReferralProgram, type index_d$4_ReferralProgramsQueryBuilder as ReferralProgramsQueryBuilder, type index_d$4_ReferralProgramsQueryResult as ReferralProgramsQueryResult, type RestoreInfo$4 as RestoreInfo, type Reward$2 as Reward, type RewardOptionsOneOf$1 as RewardOptionsOneOf, type index_d$4_ServiceProvisioned as ServiceProvisioned, type index_d$4_ServiceRemoved as ServiceRemoved, type index_d$4_SiteCreated as SiteCreated, index_d$4_SiteCreatedContext as SiteCreatedContext, type index_d$4_SiteDeleted as SiteDeleted, type index_d$4_SiteHardDeleted as SiteHardDeleted, type index_d$4_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d$4_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d$4_SitePublished as SitePublished, type index_d$4_SiteRenamed as SiteRenamed, type index_d$4_SiteTransferred as SiteTransferred, type index_d$4_SiteUndeleted as SiteUndeleted, type index_d$4_SiteUnpublished as SiteUnpublished, SortOrder$4 as SortOrder, type Sorting$4 as Sorting, index_d$4_State as State, type index_d$4_StudioAssigned as StudioAssigned, type index_d$4_StudioUnassigned as StudioUnassigned, type index_d$4_Subscription as Subscription, type index_d$4_SubscriptionAssigned as SubscriptionAssigned, type index_d$4_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type index_d$4_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type index_d$4_SubscriptionCancelled as SubscriptionCancelled, type index_d$4_SubscriptionCreated as SubscriptionCreated, type index_d$4_SubscriptionEvent as SubscriptionEvent, type index_d$4_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type index_d$4_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type index_d$4_SubscriptionPendingChange as SubscriptionPendingChange, index_d$4_SubscriptionStatus as SubscriptionStatus, type index_d$4_SubscriptionTransferred as SubscriptionTransferred, type index_d$4_SubscriptionUnassigned as SubscriptionUnassigned, Type$1 as Type, index_d$4_UnassignReason as UnassignReason, type index_d$4_UpdateReferralProgramRequest as UpdateReferralProgramRequest, type index_d$4_UpdateReferralProgramResponse as UpdateReferralProgramResponse, type index_d$4_UpdateReferralProgramResponseNonNullableFields as UpdateReferralProgramResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, type index_d$4__publicActivateReferralProgramType as _publicActivateReferralProgramType, type index_d$4__publicGenerateAiSocialMediaPostsSuggestionsType as _publicGenerateAiSocialMediaPostsSuggestionsType, type index_d$4__publicGetAiSocialMediaPostsSuggestionsType as _publicGetAiSocialMediaPostsSuggestionsType, type index_d$4__publicGetReferralProgramPremiumFeaturesType as _publicGetReferralProgramPremiumFeaturesType, type index_d$4__publicGetReferralProgramType as _publicGetReferralProgramType, type index_d$4__publicOnProgramUpdatedType as _publicOnProgramUpdatedType, type index_d$4__publicPauseReferralProgramType as _publicPauseReferralProgramType, type index_d$4__publicQueryReferralProgramsType as _publicQueryReferralProgramsType, type index_d$4__publicUpdateReferralProgramType as _publicUpdateReferralProgramType, index_d$4_activateReferralProgram as activateReferralProgram, index_d$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, index_d$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, index_d$4_getReferralProgram as getReferralProgram, index_d$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, index_d$4_onProgramUpdated as onProgramUpdated, index_d$4_pauseReferralProgram as pauseReferralProgram, onProgramUpdated$1 as publicOnProgramUpdated, index_d$4_queryReferralPrograms as queryReferralPrograms, index_d$4_updateReferralProgram as updateReferralProgram };
1765
1765
  }
1766
1766
 
1767
1767
  interface ReferralEvent extends ReferralEventEventTypeOneOf {
@@ -2272,7 +2272,7 @@ interface DomainEventBodyOneOf$3 {
2272
2272
  interface EntityCreatedEvent$3 {
2273
2273
  entity?: string;
2274
2274
  }
2275
- interface RestoreInfo$2 {
2275
+ interface RestoreInfo$3 {
2276
2276
  deletedDate?: Date;
2277
2277
  }
2278
2278
  interface EntityUpdatedEvent$3 {
@@ -2721,163 +2721,205 @@ declare const index_d$3_queryReferralEvent: typeof queryReferralEvent;
2721
2721
  declare const index_d$3_queryReferredFriendActions: typeof queryReferredFriendActions;
2722
2722
  declare const index_d$3_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
2723
2723
  declare namespace index_d$3 {
2724
- export { type ActionEvent$3 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type Coupon$1 as Coupon, type CouponDiscountTypeOptionsOneOf$1 as CouponDiscountTypeOptionsOneOf, type CouponScope$1 as CouponScope, type CouponScopeOrMinSubtotalOneOf$1 as CouponScopeOrMinSubtotalOneOf, type index_d$3_CreateReferralEventRequest as CreateReferralEventRequest, type index_d$3_CreateReferralEventResponse as CreateReferralEventResponse, type CursorPaging$3 as CursorPaging, type CursorPagingMetadata$3 as CursorPagingMetadata, type CursorQuery$3 as CursorQuery, type CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf, type Cursors$3 as Cursors, DiscountType$1 as DiscountType, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type FixedAmountDiscount$1 as FixedAmountDiscount, type index_d$3_GetReferralEventRequest as GetReferralEventRequest, type index_d$3_GetReferralEventResponse as GetReferralEventResponse, type index_d$3_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type index_d$3_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type index_d$3_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type index_d$3_GetReferralStatisticsResponseNonNullableFields as GetReferralStatisticsResponseNonNullableFields, type Group$1 as Group, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type LoyaltyPoints$1 as LoyaltyPoints, type MessageEnvelope$3 as MessageEnvelope, type PercentageDiscount$1 as PercentageDiscount, type index_d$3_QueryReferralEventRequest as QueryReferralEventRequest, type index_d$3_QueryReferralEventResponse as QueryReferralEventResponse, type index_d$3_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type index_d$3_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type index_d$3_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type index_d$3_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type index_d$3_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type index_d$3_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type index_d$3_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type index_d$3_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type index_d$3_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type index_d$3_ReferralEvent as ReferralEvent, type index_d$3_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type index_d$3_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type index_d$3_ReferralEventNonNullableFields as ReferralEventNonNullableFields, type index_d$3_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type index_d$3_ReferralEventsQueryResult as ReferralEventsQueryResult, type index_d$3_ReferredFriendAction as ReferredFriendAction, type index_d$3_ReferredFriendActionEvent as ReferredFriendActionEvent, type index_d$3_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type ReferredFriendDetails$2 as ReferredFriendDetails, type index_d$3_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type index_d$3_ReferringCustomerTotal as ReferringCustomerTotal, type RestoreInfo$2 as RestoreInfo, Reward$1 as Reward, type index_d$3_RewardEvent as RewardEvent, type index_d$3_RewardEventReceiverOneOf as RewardEventReceiverOneOf, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, Status$2 as Status, type SuccessfulReferralEvent$2 as SuccessfulReferralEvent, type index_d$3_Trigger as Trigger, type index_d$3_V1ActionEvent as V1ActionEvent, type V1Coupon$1 as V1Coupon, type index_d$3_V1SuccessfulReferralEvent as V1SuccessfulReferralEvent, type index_d$3_V1Trigger as V1Trigger, WebhookIdentityType$3 as WebhookIdentityType, type index_d$3__publicGetReferralEventType as _publicGetReferralEventType, type index_d$3__publicGetReferralStatisticsType as _publicGetReferralStatisticsType, type index_d$3__publicOnReferralEventCreatedType as _publicOnReferralEventCreatedType, type index_d$3__publicQueryReferralEventType as _publicQueryReferralEventType, type index_d$3__publicQueryReferredFriendActionsType as _publicQueryReferredFriendActionsType, type index_d$3__publicQueryReferringCustomerTotalsType as _publicQueryReferringCustomerTotalsType, index_d$3_getReferralEvent as getReferralEvent, index_d$3_getReferralStatistics as getReferralStatistics, index_d$3_onReferralEventCreated as onReferralEventCreated, onReferralEventCreated$1 as publicOnReferralEventCreated, index_d$3_queryReferralEvent as queryReferralEvent, index_d$3_queryReferredFriendActions as queryReferredFriendActions, index_d$3_queryReferringCustomerTotals as queryReferringCustomerTotals };
2724
+ export { type ActionEvent$3 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type Coupon$1 as Coupon, type CouponDiscountTypeOptionsOneOf$1 as CouponDiscountTypeOptionsOneOf, type CouponScope$1 as CouponScope, type CouponScopeOrMinSubtotalOneOf$1 as CouponScopeOrMinSubtotalOneOf, type index_d$3_CreateReferralEventRequest as CreateReferralEventRequest, type index_d$3_CreateReferralEventResponse as CreateReferralEventResponse, type CursorPaging$3 as CursorPaging, type CursorPagingMetadata$3 as CursorPagingMetadata, type CursorQuery$3 as CursorQuery, type CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf, type Cursors$3 as Cursors, DiscountType$1 as DiscountType, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type FixedAmountDiscount$1 as FixedAmountDiscount, type index_d$3_GetReferralEventRequest as GetReferralEventRequest, type index_d$3_GetReferralEventResponse as GetReferralEventResponse, type index_d$3_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type index_d$3_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type index_d$3_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type index_d$3_GetReferralStatisticsResponseNonNullableFields as GetReferralStatisticsResponseNonNullableFields, type Group$1 as Group, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type LoyaltyPoints$1 as LoyaltyPoints, type MessageEnvelope$3 as MessageEnvelope, type PercentageDiscount$1 as PercentageDiscount, type index_d$3_QueryReferralEventRequest as QueryReferralEventRequest, type index_d$3_QueryReferralEventResponse as QueryReferralEventResponse, type index_d$3_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type index_d$3_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type index_d$3_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type index_d$3_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type index_d$3_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type index_d$3_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type index_d$3_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type index_d$3_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type index_d$3_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type index_d$3_ReferralEvent as ReferralEvent, type index_d$3_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type index_d$3_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type index_d$3_ReferralEventNonNullableFields as ReferralEventNonNullableFields, type index_d$3_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type index_d$3_ReferralEventsQueryResult as ReferralEventsQueryResult, type index_d$3_ReferredFriendAction as ReferredFriendAction, type index_d$3_ReferredFriendActionEvent as ReferredFriendActionEvent, type index_d$3_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type ReferredFriendDetails$2 as ReferredFriendDetails, type index_d$3_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type index_d$3_ReferringCustomerTotal as ReferringCustomerTotal, type RestoreInfo$3 as RestoreInfo, Reward$1 as Reward, type index_d$3_RewardEvent as RewardEvent, type index_d$3_RewardEventReceiverOneOf as RewardEventReceiverOneOf, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, Status$2 as Status, type SuccessfulReferralEvent$2 as SuccessfulReferralEvent, type index_d$3_Trigger as Trigger, type index_d$3_V1ActionEvent as V1ActionEvent, type V1Coupon$1 as V1Coupon, type index_d$3_V1SuccessfulReferralEvent as V1SuccessfulReferralEvent, type index_d$3_V1Trigger as V1Trigger, WebhookIdentityType$3 as WebhookIdentityType, type index_d$3__publicGetReferralEventType as _publicGetReferralEventType, type index_d$3__publicGetReferralStatisticsType as _publicGetReferralStatisticsType, type index_d$3__publicOnReferralEventCreatedType as _publicOnReferralEventCreatedType, type index_d$3__publicQueryReferralEventType as _publicQueryReferralEventType, type index_d$3__publicQueryReferredFriendActionsType as _publicQueryReferredFriendActionsType, type index_d$3__publicQueryReferringCustomerTotalsType as _publicQueryReferringCustomerTotalsType, index_d$3_getReferralEvent as getReferralEvent, index_d$3_getReferralStatistics as getReferralStatistics, index_d$3_onReferralEventCreated as onReferralEventCreated, onReferralEventCreated$1 as publicOnReferralEventCreated, index_d$3_queryReferralEvent as queryReferralEvent, index_d$3_queryReferredFriendActions as queryReferredFriendActions, index_d$3_queryReferringCustomerTotals as queryReferringCustomerTotals };
2725
2725
  }
2726
2726
 
2727
- /** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
2728
2727
  interface ReferralReward extends ReferralRewardReceiverOneOf, ReferralRewardRewardTypeOptionsOneOf {
2729
2728
  /**
2730
- * Referring customer ID.
2729
+ * ID of the referring customer who received the reward.
2731
2730
  * @readonly
2732
2731
  */
2733
2732
  rewardedReferringCustomerId?: string;
2734
2733
  /**
2735
- * Referred friend ID.
2734
+ * ID of the referred friend who received the reward.
2736
2735
  * @readonly
2737
2736
  */
2738
2737
  rewardedReferredFriendId?: string;
2739
- /** Coupon reward type options. */
2738
+ /** Details of a coupon reward. Present when `reward_type` is `COUPON`. */
2740
2739
  coupon?: V1Coupon;
2741
- /** Loyalty points reward type options. */
2740
+ /** Details of a loyalty points reward. Present when `reward_type` is `LOYALTY_POINTS`. */
2742
2741
  loyaltyPoints?: V1LoyaltyPoints;
2743
2742
  /**
2744
- * ReferralReward ID.
2743
+ * Referral reward ID.
2745
2744
  * @readonly
2746
2745
  */
2747
2746
  _id?: string | null;
2748
- /** 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. */
2747
+ /**
2748
+ * Revision number, which increments by 1 each time the referral reward is updated.
2749
+ * To prevent conflicting changes, the current revision must be passed when updating the referral reward.
2750
+ */
2749
2751
  revision?: string | null;
2750
2752
  /**
2751
- * Represents the time this ReferralReward was created.
2753
+ * Date and time the referral reward was created.
2752
2754
  * @readonly
2753
2755
  */
2754
2756
  _createdDate?: Date;
2755
2757
  /**
2756
- * Represents the time this ReferralReward was last updated.
2758
+ * Date and time the referral reward was last updated.
2757
2759
  * @readonly
2758
2760
  */
2759
2761
  _updatedDate?: Date;
2760
- /** Reward type. */
2762
+ /**
2763
+ * Type of reward given.
2764
+ *
2765
+ * Possible values:
2766
+ * - `UNKNOWN`: Unknown reward.
2767
+ * - `COUPON`: A loyalty coupon is given.
2768
+ * - `LOYALTY_POINTS`: Loyalty points are awarded.
2769
+ * - `NOTHING`: No reward is given.
2770
+ */
2761
2771
  rewardType?: RewardTypeType;
2762
2772
  }
2763
2773
  /** @oneof */
2764
2774
  interface ReferralRewardReceiverOneOf {
2765
2775
  /**
2766
- * Referring customer ID.
2776
+ * ID of the referring customer who received the reward.
2767
2777
  * @readonly
2768
2778
  */
2769
2779
  rewardedReferringCustomerId?: string;
2770
2780
  /**
2771
- * Referred friend ID.
2781
+ * ID of the referred friend who received the reward.
2772
2782
  * @readonly
2773
2783
  */
2774
2784
  rewardedReferredFriendId?: string;
2775
2785
  }
2776
2786
  /** @oneof */
2777
2787
  interface ReferralRewardRewardTypeOptionsOneOf {
2778
- /** Coupon reward type options. */
2788
+ /** Details of a coupon reward. Present when `reward_type` is `COUPON`. */
2779
2789
  coupon?: V1Coupon;
2780
- /** Loyalty points reward type options. */
2790
+ /** Details of a loyalty points reward. Present when `reward_type` is `LOYALTY_POINTS`. */
2781
2791
  loyaltyPoints?: V1LoyaltyPoints;
2782
2792
  }
2783
2793
  declare enum RewardTypeType {
2784
- /** Unknown reward type. */
2794
+ /** Unknown reward. */
2785
2795
  UNKNOWN = "UNKNOWN",
2786
- /** Coupon reward type. */
2796
+ /** A loyalty coupon is given. */
2787
2797
  COUPON = "COUPON",
2788
- /** Loyalty points reward type. */
2798
+ /** Loyalty points are awarded. */
2789
2799
  LOYALTY_POINTS = "LOYALTY_POINTS",
2790
- /** No reward. */
2800
+ /** No reward is given. */
2791
2801
  NOTHING = "NOTHING"
2792
2802
  }
2793
2803
  interface V1Coupon {
2794
2804
  /**
2795
- * Coupon ID.
2805
+ * Coupon ID. Example: `8934b045-7052-4a90-be2b-832c70afc9da`.
2796
2806
  * @readonly
2797
2807
  */
2798
2808
  _id?: string;
2799
2809
  /**
2800
- * Coupon code.
2810
+ * The code that customers can use to apply the coupon. Example: `6RFD2A3HSPXW`.
2801
2811
  * @readonly
2802
2812
  */
2803
2813
  code?: string;
2804
2814
  /**
2805
- * Coupon status.
2815
+ * Current status of the coupon.
2816
+ *
2817
+ * Possible values:
2818
+ *
2819
+ * - `UNKNOWN`: Unknown coupon status.
2820
+ * - `ACTIVE`: Coupon is active and can be applied.
2821
+ * - `APPLIED`: Coupon was already applied and can't be used anymore.
2822
+ * - `DELETED`: Coupon was deleted.
2806
2823
  * @readonly
2807
2824
  */
2808
2825
  status?: Status$1;
2809
2826
  /**
2810
- * Coupon specification.
2827
+ * Detailed specifications of the coupon.
2811
2828
  * @readonly
2812
2829
  */
2813
2830
  couponSpecification?: Coupon;
2814
2831
  }
2815
2832
  declare enum Status$1 {
2816
- /** Unknown coupon status. */
2833
+ /** The coupon status is unknown or not specified. */
2817
2834
  UNKNOWN = "UNKNOWN",
2818
- /** Coupon is active and can be applied. */
2835
+ /** The coupon is active and can be applied to purchases. */
2819
2836
  ACTIVE = "ACTIVE",
2820
- /** Coupon was already applied and can not be used anymore. */
2837
+ /** The coupon has been applied and can't be used again. */
2821
2838
  APPLIED = "APPLIED",
2822
- /** Coupon was deleted. */
2839
+ /** The coupon has been deleted and is no longer valid. */
2823
2840
  DELETED = "DELETED"
2824
2841
  }
2825
2842
  interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
2826
- /** Options for fixed amount discount type */
2843
+ /** Options for fixed amount discount. */
2827
2844
  fixedAmountOptions?: FixedAmountDiscount;
2828
- /** Options for percentage discount type */
2845
+ /** Options for percentage discount. */
2829
2846
  percentageOptions?: PercentageDiscount;
2830
2847
  /** Limit the coupon to carts with a subtotal above this number. */
2831
2848
  minimumSubtotal?: number;
2832
- /** Specifies the type of line items this coupon will apply to. */
2849
+ /** 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). */
2833
2850
  scope?: CouponScope;
2834
- /** Coupon name */
2851
+ /** Coupon name. */
2835
2852
  name?: string;
2836
- /** Coupon discount type */
2853
+ /**
2854
+ * Coupon discount type.
2855
+ *
2856
+ * - `UNKNOWN`: Unknown discount type.
2857
+ * - `FIXED_AMOUNT`: Discount as a fixed amount.
2858
+ * - `PERCENTAGE`: Discount as a perctange.
2859
+ * - `FREE_SHIPPING`: Free shipping. If `true`, the coupon applies to all items in all `namespaces`.
2860
+ */
2837
2861
  discountType?: DiscountType;
2838
- /** Limit the coupon to only apply to one item in cart. */
2862
+ /**
2863
+ * Whether the coupon is limited to one item.
2864
+ * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
2865
+ * Coupons with a bookings `scope.namespace` are always limited to one item.
2866
+ */
2839
2867
  limitedToOneItem?: boolean | null;
2840
- /** If true, coupon also applies to subscriptions. */
2868
+ /** Whether the coupon applies to subscription products. */
2841
2869
  appliesToSubscriptions?: boolean | null;
2842
- /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
2870
+ /**
2871
+ * Specifies the amount of discounted cycles for a subscription item.
2872
+ *
2873
+ * - Can only be set when `scope.namespace = pricingPlans`.
2874
+ * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
2875
+ * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
2876
+ *
2877
+ * Max: `999`
2878
+ */
2843
2879
  discountedCycleCount?: number | null;
2844
2880
  }
2845
2881
  /** @oneof */
2846
2882
  interface CouponDiscountTypeOptionsOneOf {
2847
- /** Options for fixed amount discount type */
2883
+ /** Options for fixed amount discount. */
2848
2884
  fixedAmountOptions?: FixedAmountDiscount;
2849
- /** Options for percentage discount type */
2885
+ /** Options for percentage discount. */
2850
2886
  percentageOptions?: PercentageDiscount;
2851
2887
  }
2852
2888
  /** @oneof */
2853
2889
  interface CouponScopeOrMinSubtotalOneOf {
2854
2890
  /** Limit the coupon to carts with a subtotal above this number. */
2855
2891
  minimumSubtotal?: number;
2856
- /** Specifies the type of line items this coupon will apply to. */
2892
+ /** 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). */
2857
2893
  scope?: CouponScope;
2858
2894
  }
2859
2895
  declare enum DiscountType {
2896
+ /** Unknown discount type. */
2860
2897
  UNKNOWN = "UNKNOWN",
2861
- /** Discount as a fixed amount */
2898
+ /** Discount as a fixed amount. */
2862
2899
  FIXED_AMOUNT = "FIXED_AMOUNT",
2863
- /** Discount as a percentage */
2900
+ /** Discount as a percentage. */
2864
2901
  PERCENTAGE = "PERCENTAGE",
2865
- /** Free shipping */
2902
+ /** Free shipping. */
2866
2903
  FREE_SHIPPING = "FREE_SHIPPING"
2867
2904
  }
2868
2905
  interface FixedAmountDiscount {
2869
- /** Fixed amount to discount */
2906
+ /** Amount of discount as a fixed value. */
2870
2907
  amount?: number;
2871
2908
  }
2872
2909
  interface PercentageDiscount {
2910
+ /** Percentage of discount. */
2873
2911
  percentage?: number;
2874
2912
  }
2875
2913
  interface CouponScope {
2914
+ /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
2876
2915
  namespace?: string;
2916
+ /** Coupon scope's applied group, for example: Event or ticket in Wix Events */
2877
2917
  group?: Group;
2878
2918
  }
2879
2919
  interface Group {
2920
+ /** Name of the group. */
2880
2921
  name?: string;
2922
+ /** Entity ID of the group. */
2881
2923
  entityId?: string | null;
2882
2924
  }
2883
2925
  interface V1LoyaltyPoints {
@@ -2887,46 +2929,52 @@ interface V1LoyaltyPoints {
2887
2929
  */
2888
2930
  transactionId?: string;
2889
2931
  /**
2890
- * Loyalty points amount given.
2932
+ * The number of loyalty points awarded.
2891
2933
  * @readonly
2892
2934
  */
2893
2935
  amount?: number;
2894
2936
  }
2895
2937
  interface GetReferralRewardRequest {
2896
- /** Id of the ReferralReward to retrieve. */
2938
+ /** Referral reward ID. */
2897
2939
  _id: string;
2898
2940
  }
2899
2941
  interface GetReferralRewardResponse {
2900
- /** The retrieved ReferralReward. */
2942
+ /** Retrieved referral reward. */
2901
2943
  referralReward?: ReferralReward;
2902
2944
  }
2903
2945
  interface QueryReferralRewardsRequest {
2904
- /** Query to filter ReferralRewards. */
2946
+ /** Query to filter referral rewards. */
2905
2947
  query: CursorQuery$2;
2906
- /** Filter by contact id or set to "me" for current identity's rewards. */
2948
+ /** Contact ID to filter rewards by. Use `"me"` for current identity's rewards. */
2907
2949
  contactId?: string | null;
2908
2950
  }
2909
2951
  interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
2910
- /** 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`. */
2952
+ /**
2953
+ * Cursor paging options.
2954
+ *
2955
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2956
+ */
2911
2957
  cursorPaging?: CursorPaging$2;
2912
2958
  /**
2913
- * Filter object in the following format:
2914
- * `"filter" : {
2915
- * "fieldName1": "value1",
2916
- * "fieldName2":{"$operator":"value2"}
2917
- * }`
2918
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2959
+ * Filter object.
2960
+ *
2961
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2919
2962
  */
2920
2963
  filter?: Record<string, any> | null;
2921
2964
  /**
2922
- * Sort object in the following format:
2923
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2965
+ * Sort object.
2966
+ *
2967
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2924
2968
  */
2925
2969
  sort?: Sorting$2[];
2926
2970
  }
2927
2971
  /** @oneof */
2928
2972
  interface CursorQueryPagingMethodOneOf$2 {
2929
- /** 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`. */
2973
+ /**
2974
+ * Cursor paging options.
2975
+ *
2976
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
2977
+ */
2930
2978
  cursorPaging?: CursorPaging$2;
2931
2979
  }
2932
2980
  interface Sorting$2 {
@@ -2951,13 +2999,13 @@ interface CursorPaging$2 {
2951
2999
  cursor?: string | null;
2952
3000
  }
2953
3001
  interface QueryReferralRewardsResponse {
2954
- /** The retrieved ReferralRewards. */
3002
+ /** Retrieved referral rewards. */
2955
3003
  referralRewards?: ReferralReward[];
2956
3004
  /** Metadata for paging. */
2957
3005
  metadata?: CursorPagingMetadata$2;
2958
3006
  }
2959
3007
  interface CursorPagingMetadata$2 {
2960
- /** Number of items returned in the response. */
3008
+ /** Number of items returned in current page. */
2961
3009
  count?: number | null;
2962
3010
  /** Cursor strings that point to the next page, previous page, or both. */
2963
3011
  cursors?: Cursors$2;
@@ -2980,31 +3028,32 @@ interface ValidateReferralRewardRequest {
2980
3028
  reward?: Reward;
2981
3029
  }
2982
3030
  interface Reward extends RewardOptionsOneOf {
2983
- /** Options for coupon reward type */
3031
+ /** Options for coupon reward type. */
2984
3032
  couponOptions?: Coupon;
2985
- /** Options for Loyalty points reward type */
3033
+ /** Options for Loyalty points reward type. */
2986
3034
  loyaltyPointsOptions?: LoyaltyPoints;
2987
- /** Type of the reward */
3035
+ /** Type of the reward. */
2988
3036
  type?: Type;
2989
3037
  }
2990
3038
  /** @oneof */
2991
3039
  interface RewardOptionsOneOf {
2992
- /** Options for coupon reward type */
3040
+ /** Options for coupon reward type. */
2993
3041
  couponOptions?: Coupon;
2994
- /** Options for Loyalty points reward type */
3042
+ /** Options for Loyalty points reward type. */
2995
3043
  loyaltyPointsOptions?: LoyaltyPoints;
2996
3044
  }
2997
3045
  declare enum Type {
3046
+ /** Unknown reward type. */
2998
3047
  UNKNOWN = "UNKNOWN",
2999
- /** Coupon reward type */
3048
+ /** Coupon reward type. */
3000
3049
  COUPON = "COUPON",
3001
- /** Loyalty points reward type */
3050
+ /** Loyalty points reward type. */
3002
3051
  LOYALTY_POINTS = "LOYALTY_POINTS",
3003
- /** No reward type */
3052
+ /** No reward type. */
3004
3053
  NOTHING = "NOTHING"
3005
3054
  }
3006
3055
  interface LoyaltyPoints {
3007
- /** Amount of points to give */
3056
+ /** Number of loyalty points to give. */
3008
3057
  amount?: number;
3009
3058
  }
3010
3059
  interface ValidateReferralRewardResponse {
@@ -3012,13 +3061,13 @@ interface ValidateReferralRewardResponse {
3012
3061
  interface BulkGetReferralRewardsRequest {
3013
3062
  }
3014
3063
  interface BulkGetReferralRewardsResponse {
3015
- /** Found rewards per site. */
3064
+ /** Rewards grouped by site. */
3016
3065
  rewardsInSite?: RewardsInSite[];
3017
3066
  }
3018
3067
  interface RewardsInSite {
3019
3068
  /** Metasite ID. */
3020
3069
  metaSiteId?: string;
3021
- /** Rewards. */
3070
+ /** List of rewards for the site. */
3022
3071
  rewards?: ReferralReward[];
3023
3072
  }
3024
3073
  interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
@@ -3044,7 +3093,7 @@ interface DomainEvent$2 extends DomainEventBodyOneOf$2 {
3044
3093
  slug?: string;
3045
3094
  /** ID of the entity associated with the event. */
3046
3095
  entityId?: string;
3047
- /** Event timestamp. */
3096
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3048
3097
  eventTime?: Date;
3049
3098
  /**
3050
3099
  * Whether the event was triggered as a result of a privacy regulation application
@@ -3073,7 +3122,7 @@ interface DomainEventBodyOneOf$2 {
3073
3122
  interface EntityCreatedEvent$2 {
3074
3123
  entity?: string;
3075
3124
  }
3076
- interface UndeleteInfo {
3125
+ interface RestoreInfo$2 {
3077
3126
  deletedDate?: Date;
3078
3127
  }
3079
3128
  interface EntityUpdatedEvent$2 {
@@ -3094,22 +3143,22 @@ interface ActionEvent$2 {
3094
3143
  interface Empty$1 {
3095
3144
  }
3096
3145
  interface SuccessfulReferralEvent$1 {
3097
- /** ReferredFriend that completed his referral details. */
3146
+ /** Details of the referred friend who completed their referral. */
3098
3147
  referredFriendDetails?: ReferredFriendDetails$1;
3099
3148
  }
3100
3149
  interface ReferredFriendDetails$1 {
3101
3150
  /**
3102
- * ReferredFriend ID.
3151
+ * ID of the referred friend.
3103
3152
  * @readonly
3104
3153
  */
3105
3154
  referredFriendId?: string;
3106
3155
  /**
3107
- * ReferredFriend Contact ID.
3156
+ * Contact ID of the referred friend.
3108
3157
  * @readonly
3109
3158
  */
3110
3159
  contactId?: string;
3111
3160
  /**
3112
- * Customer who referred this ReferredFriend.
3161
+ * ID of the customer who referred this friend.
3113
3162
  * @readonly
3114
3163
  */
3115
3164
  referringCustomerId?: string;
@@ -3199,27 +3248,34 @@ interface QueryReferralRewardsResponseNonNullableFields {
3199
3248
  referralRewards: ReferralRewardNonNullableFields[];
3200
3249
  }
3201
3250
  interface QueryReferralRewardsOptions {
3202
- /** Filter by contact id or set to "me" for current identity's rewards. */
3251
+ /** Contact ID to filter rewards by. Use `"me"` for current identity's rewards. */
3203
3252
  contactId?: string | null;
3204
3253
  }
3205
3254
 
3206
3255
  declare function getReferralReward$1(httpClient: HttpClient): GetReferralRewardSignature;
3207
3256
  interface GetReferralRewardSignature {
3208
3257
  /**
3209
- * Get a ReferralReward by id.
3210
- * @param - Id of the ReferralReward to retrieve.
3211
- * @returns The retrieved ReferralReward.
3258
+ * Retrieves a referral reward.
3259
+ * @param - Referral reward ID.
3260
+ * @returns Retrieved referral reward.
3212
3261
  */
3213
3262
  (_id: string): Promise<ReferralReward & ReferralRewardNonNullableFields>;
3214
3263
  }
3215
3264
  declare function queryReferralRewards$1(httpClient: HttpClient): QueryReferralRewardsSignature;
3216
3265
  interface QueryReferralRewardsSignature {
3217
3266
  /**
3218
- * Query ReferralRewards.
3267
+ * Retrieves a list of referral rewards, given the provided paging, filtering, and sorting.
3268
+ *
3269
+ * You can filter the results by:
3270
+ * - `contact_id`: Set to `me` to return rewards for the current identity.
3271
+ * - `owner_type`.
3272
+ * - `reward_type`.
3219
3273
  *
3220
- * Can be filtered by `contact_id`. If it's set to `me` current identity's rewards are returned.
3221
- * Supports filtering on `owner_type`, `reward_type` fields.
3222
- * @param - Query to filter ReferralRewards.
3274
+ * To learn about working with _Query_ endpoints, see
3275
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
3276
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
3277
+ * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3278
+ * @param - Query to filter referral rewards.
3223
3279
  */
3224
3280
  (query: CursorQuery$2, options?: QueryReferralRewardsOptions | undefined): Promise<QueryReferralRewardsResponse & QueryReferralRewardsResponseNonNullableFields>;
3225
3281
  }
@@ -3261,7 +3317,6 @@ declare const index_d$2_RewardTypeType: typeof RewardTypeType;
3261
3317
  type index_d$2_RewardsInSite = RewardsInSite;
3262
3318
  type index_d$2_Type = Type;
3263
3319
  declare const index_d$2_Type: typeof Type;
3264
- type index_d$2_UndeleteInfo = UndeleteInfo;
3265
3320
  type index_d$2_V1Coupon = V1Coupon;
3266
3321
  type index_d$2_V1LoyaltyPoints = V1LoyaltyPoints;
3267
3322
  type index_d$2_ValidateReferralRewardRequest = ValidateReferralRewardRequest;
@@ -3271,39 +3326,40 @@ type index_d$2__publicQueryReferralRewardsType = _publicQueryReferralRewardsType
3271
3326
  declare const index_d$2_getReferralReward: typeof getReferralReward;
3272
3327
  declare const index_d$2_queryReferralRewards: typeof queryReferralRewards;
3273
3328
  declare namespace index_d$2 {
3274
- export { type ActionEvent$2 as ActionEvent, type index_d$2_BulkGetReferralRewardsRequest as BulkGetReferralRewardsRequest, type index_d$2_BulkGetReferralRewardsResponse as BulkGetReferralRewardsResponse, type index_d$2_Coupon as Coupon, type index_d$2_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type index_d$2_CouponScope as CouponScope, type index_d$2_CouponScopeOrMinSubtotalOneOf as CouponScopeOrMinSubtotalOneOf, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, index_d$2_DiscountType as DiscountType, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$2_FixedAmountDiscount as FixedAmountDiscount, type index_d$2_GetReferralRewardRequest as GetReferralRewardRequest, type index_d$2_GetReferralRewardResponse as GetReferralRewardResponse, type index_d$2_GetReferralRewardResponseNonNullableFields as GetReferralRewardResponseNonNullableFields, type index_d$2_Group as Group, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$2_LoyaltyPoints as LoyaltyPoints, type MessageEnvelope$2 as MessageEnvelope, type index_d$2_PercentageDiscount as PercentageDiscount, type index_d$2_QueryReferralRewardsOptions as QueryReferralRewardsOptions, type index_d$2_QueryReferralRewardsRequest as QueryReferralRewardsRequest, type index_d$2_QueryReferralRewardsResponse as QueryReferralRewardsResponse, type index_d$2_QueryReferralRewardsResponseNonNullableFields as QueryReferralRewardsResponseNonNullableFields, type index_d$2_ReferralReward as ReferralReward, type index_d$2_ReferralRewardNonNullableFields as ReferralRewardNonNullableFields, type index_d$2_ReferralRewardReceiverOneOf as ReferralRewardReceiverOneOf, type index_d$2_ReferralRewardRewardTypeOptionsOneOf as ReferralRewardRewardTypeOptionsOneOf, type ReferredFriendDetails$1 as ReferredFriendDetails, type index_d$2_Reward as Reward, type index_d$2_RewardOptionsOneOf as RewardOptionsOneOf, index_d$2_RewardTypeType as RewardTypeType, type index_d$2_RewardsInSite as RewardsInSite, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Status$1 as Status, type SuccessfulReferralEvent$1 as SuccessfulReferralEvent, index_d$2_Type as Type, type index_d$2_UndeleteInfo as UndeleteInfo, type index_d$2_V1Coupon as V1Coupon, type index_d$2_V1LoyaltyPoints as V1LoyaltyPoints, type index_d$2_ValidateReferralRewardRequest as ValidateReferralRewardRequest, type index_d$2_ValidateReferralRewardResponse as ValidateReferralRewardResponse, WebhookIdentityType$2 as WebhookIdentityType, type index_d$2__publicGetReferralRewardType as _publicGetReferralRewardType, type index_d$2__publicQueryReferralRewardsType as _publicQueryReferralRewardsType, index_d$2_getReferralReward as getReferralReward, index_d$2_queryReferralRewards as queryReferralRewards };
3329
+ export { type ActionEvent$2 as ActionEvent, type index_d$2_BulkGetReferralRewardsRequest as BulkGetReferralRewardsRequest, type index_d$2_BulkGetReferralRewardsResponse as BulkGetReferralRewardsResponse, type index_d$2_Coupon as Coupon, type index_d$2_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type index_d$2_CouponScope as CouponScope, type index_d$2_CouponScopeOrMinSubtotalOneOf as CouponScopeOrMinSubtotalOneOf, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, index_d$2_DiscountType as DiscountType, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$2_FixedAmountDiscount as FixedAmountDiscount, type index_d$2_GetReferralRewardRequest as GetReferralRewardRequest, type index_d$2_GetReferralRewardResponse as GetReferralRewardResponse, type index_d$2_GetReferralRewardResponseNonNullableFields as GetReferralRewardResponseNonNullableFields, type index_d$2_Group as Group, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$2_LoyaltyPoints as LoyaltyPoints, type MessageEnvelope$2 as MessageEnvelope, type index_d$2_PercentageDiscount as PercentageDiscount, type index_d$2_QueryReferralRewardsOptions as QueryReferralRewardsOptions, type index_d$2_QueryReferralRewardsRequest as QueryReferralRewardsRequest, type index_d$2_QueryReferralRewardsResponse as QueryReferralRewardsResponse, type index_d$2_QueryReferralRewardsResponseNonNullableFields as QueryReferralRewardsResponseNonNullableFields, type index_d$2_ReferralReward as ReferralReward, type index_d$2_ReferralRewardNonNullableFields as ReferralRewardNonNullableFields, type index_d$2_ReferralRewardReceiverOneOf as ReferralRewardReceiverOneOf, type index_d$2_ReferralRewardRewardTypeOptionsOneOf as ReferralRewardRewardTypeOptionsOneOf, type ReferredFriendDetails$1 as ReferredFriendDetails, type RestoreInfo$2 as RestoreInfo, type index_d$2_Reward as Reward, type index_d$2_RewardOptionsOneOf as RewardOptionsOneOf, index_d$2_RewardTypeType as RewardTypeType, type index_d$2_RewardsInSite as RewardsInSite, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Status$1 as Status, type SuccessfulReferralEvent$1 as SuccessfulReferralEvent, index_d$2_Type as Type, type index_d$2_V1Coupon as V1Coupon, type index_d$2_V1LoyaltyPoints as V1LoyaltyPoints, type index_d$2_ValidateReferralRewardRequest as ValidateReferralRewardRequest, type index_d$2_ValidateReferralRewardResponse as ValidateReferralRewardResponse, WebhookIdentityType$2 as WebhookIdentityType, type index_d$2__publicGetReferralRewardType as _publicGetReferralRewardType, type index_d$2__publicQueryReferralRewardsType as _publicQueryReferralRewardsType, index_d$2_getReferralReward as getReferralReward, index_d$2_queryReferralRewards as queryReferralRewards };
3275
3330
  }
3276
3331
 
3277
3332
  interface ReferredFriend {
3278
3333
  /**
3279
- * ReferredFriend ID.
3334
+ * ID of the referred friend.
3280
3335
  * @readonly
3281
3336
  */
3282
3337
  _id?: string;
3283
3338
  /**
3284
- * ReferredFriend Contact ID.
3339
+ * Contact ID of the referred friend.
3285
3340
  * @readonly
3286
3341
  */
3287
3342
  contactId?: string;
3288
3343
  /**
3289
- * Customer who referred.
3344
+ * ID of the customer who referred this friend.
3290
3345
  * @readonly
3291
3346
  */
3292
3347
  referringCustomerId?: string;
3293
- /** Status of the ReferredFriend. */
3348
+ /** Status of the referred friend. */
3294
3349
  status?: Status;
3295
3350
  /**
3296
- * 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.
3351
+ * Revision number, which increments by 1 each time the referred friend is updated.
3352
+ * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
3297
3353
  * @readonly
3298
3354
  */
3299
3355
  revision?: string | null;
3300
3356
  /**
3301
- * Represents the time this ReferredFriend was created.
3357
+ * Date and time the referred friend was created.
3302
3358
  * @readonly
3303
3359
  */
3304
3360
  _createdDate?: Date;
3305
3361
  /**
3306
- * Represents the time this ReferredFriend was last updated.
3362
+ * Date and time the referred friend was last updated.
3307
3363
  * @readonly
3308
3364
  */
3309
3365
  _updatedDate?: Date;
@@ -3311,47 +3367,49 @@ interface ReferredFriend {
3311
3367
  declare enum Status {
3312
3368
  /** Unknown status. */
3313
3369
  UNKNOWN = "UNKNOWN",
3314
- /** Initial status, when Referred friend joins site as member. */
3370
+ /** Initial status when the referred friend joins the site as a member. */
3315
3371
  SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
3316
- /** After complete some actions (eg. Purchase Order), Action Completed Status is used. */
3372
+ /** Status after the referred friend completes specific actions, such as making a purchase. */
3317
3373
  ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
3318
3374
  }
3319
3375
  interface CreateReferredFriendRequest {
3320
- /** Referral code for referred friend */
3376
+ /** Referral code for the referred friend. */
3321
3377
  referralCode?: string | null;
3322
3378
  }
3323
3379
  interface CreateReferredFriendResponse {
3324
- /** The created ReferredFriend. */
3380
+ /** Created referred friend. */
3325
3381
  referredFriend?: ReferredFriend;
3326
3382
  }
3327
3383
  interface GetReferredFriendRequest {
3328
- /** Id of the ReferredFriend to retrieve. */
3384
+ /** ID of the referred friend to retrieve. */
3329
3385
  referredFriendId: string;
3330
3386
  }
3331
3387
  interface GetReferredFriendResponse {
3332
- /** The retrieved ReferredFriend. */
3388
+ /** Retrieved referred friend. */
3333
3389
  referredFriend?: ReferredFriend;
3334
3390
  }
3335
3391
  interface GetReferredFriendByContactIdRequest {
3336
- /** Contact id or "me" to get current identity's Contact. */
3392
+ /** Contact ID or "me" to get the current identity's contact. */
3337
3393
  contactId: string;
3338
3394
  }
3339
3395
  interface GetReferredFriendByContactIdResponse {
3340
- /** The retrieved ReferredFriend. */
3396
+ /** Retrieved referred friend. */
3341
3397
  referredFriend?: ReferredFriend;
3342
3398
  }
3343
3399
  interface UpdateReferredFriendRequest {
3344
- /** ReferredFriend to be updated, may be partial. */
3400
+ /** Referred friend to be updated. May be partial. */
3345
3401
  referredFriend: ReferredFriend;
3346
3402
  }
3347
3403
  interface UpdateReferredFriendResponse {
3348
- /** The updated ReferredFriend. */
3404
+ /** Updated referred friend. */
3349
3405
  referredFriend?: ReferredFriend;
3350
3406
  }
3351
3407
  interface DeleteReferredFriendRequest {
3352
- /** Id of the ReferredFriend to delete. */
3353
3408
  referredFriendId: string;
3354
- /** The revision of the ReferredFriend. */
3409
+ /**
3410
+ * Revision number, which increments by 1 each time the referred friend is updated.
3411
+ * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
3412
+ */
3355
3413
  revision?: string;
3356
3414
  }
3357
3415
  interface DeleteReferredFriendResponse {
@@ -3411,9 +3469,9 @@ interface CursorPaging$1 {
3411
3469
  cursor?: string | null;
3412
3470
  }
3413
3471
  interface QueryReferredFriendResponse {
3414
- /** The retrieved ReferredFriends. */
3472
+ /** Retrieved referred friends. */
3415
3473
  referredFriends?: ReferredFriend[];
3416
- /** CursorPagingMetadata. */
3474
+ /** Cursor paging metadata. */
3417
3475
  metadata?: CursorPagingMetadata$1;
3418
3476
  }
3419
3477
  interface CursorPagingMetadata$1 {
@@ -3647,45 +3705,49 @@ interface ReferredFriendDeletedEnvelope {
3647
3705
  metadata: EventMetadata$1;
3648
3706
  }
3649
3707
  interface CreateReferredFriendOptions {
3650
- /** Referral code for referred friend */
3708
+ /** Referral code for the referred friend. */
3651
3709
  referralCode?: string | null;
3652
3710
  }
3653
3711
  interface UpdateReferredFriend {
3654
3712
  /**
3655
- * ReferredFriend ID.
3713
+ * ID of the referred friend.
3656
3714
  * @readonly
3657
3715
  */
3658
3716
  _id?: string;
3659
3717
  /**
3660
- * ReferredFriend Contact ID.
3718
+ * Contact ID of the referred friend.
3661
3719
  * @readonly
3662
3720
  */
3663
3721
  contactId?: string;
3664
3722
  /**
3665
- * Customer who referred.
3723
+ * ID of the customer who referred this friend.
3666
3724
  * @readonly
3667
3725
  */
3668
3726
  referringCustomerId?: string;
3669
- /** Status of the ReferredFriend. */
3727
+ /** Status of the referred friend. */
3670
3728
  status?: Status;
3671
3729
  /**
3672
- * 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.
3730
+ * Revision number, which increments by 1 each time the referred friend is updated.
3731
+ * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
3673
3732
  * @readonly
3674
3733
  */
3675
3734
  revision?: string | null;
3676
3735
  /**
3677
- * Represents the time this ReferredFriend was created.
3736
+ * Date and time the referred friend was created.
3678
3737
  * @readonly
3679
3738
  */
3680
3739
  _createdDate?: Date;
3681
3740
  /**
3682
- * Represents the time this ReferredFriend was last updated.
3741
+ * Date and time the referred friend was last updated.
3683
3742
  * @readonly
3684
3743
  */
3685
3744
  _updatedDate?: Date;
3686
3745
  }
3687
3746
  interface DeleteReferredFriendOptions {
3688
- /** The revision of the ReferredFriend. */
3747
+ /**
3748
+ * Revision number, which increments by 1 each time the referred friend is updated.
3749
+ * To prevent conflicting changes, the current revision must be passed when updating the referred friend.
3750
+ */
3689
3751
  revision?: string;
3690
3752
  }
3691
3753
  interface QueryCursorResult$1 {
@@ -3769,56 +3831,69 @@ interface ReferredFriendsQueryBuilder {
3769
3831
  declare function createReferredFriend$1(httpClient: HttpClient): CreateReferredFriendSignature;
3770
3832
  interface CreateReferredFriendSignature {
3771
3833
  /**
3772
- * Try to create the ReferredFriend or return existing entity if it already exists.
3834
+ * Creates a new referred friend or returns an existing entity if it already exists.
3835
+ *
3836
+ * This method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#site-members).
3837
+ *
3838
+ * A referral code must be provided either in the request or via scope.
3773
3839
  *
3774
- * Must be called with member identity.
3775
- * Referral code must be provided either in the request or via scope.
3776
- * Member must be eligible to become referred friend.
3840
+ * The member must be eligible to become a referred friend.
3777
3841
  */
3778
3842
  (options?: CreateReferredFriendOptions | undefined): Promise<CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields>;
3779
3843
  }
3780
3844
  declare function getReferredFriend$1(httpClient: HttpClient): GetReferredFriendSignature;
3781
3845
  interface GetReferredFriendSignature {
3782
3846
  /**
3783
- * Get a ReferredFriend by id.
3784
- * @param - Id of the ReferredFriend to retrieve.
3847
+ * Retrieves a referred friend by ID.
3848
+ * @param - ID of the referred friend to retrieve.
3785
3849
  */
3786
3850
  (referredFriendId: string): Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
3787
3851
  }
3788
3852
  declare function getReferredFriendByContactId$1(httpClient: HttpClient): GetReferredFriendByContactIdSignature;
3789
3853
  interface GetReferredFriendByContactIdSignature {
3790
3854
  /**
3791
- * Get a ReferredFriend by contactId.
3855
+ * Retrieves a referred friend by contact ID.
3792
3856
  *
3793
- * You can provide "me" instead of specific contact id to get referring friend for current identity's contact.
3794
- * @param - Contact id or "me" to get current identity's Contact.
3795
- * @returns The retrieved ReferredFriend.
3857
+ * You can use `"me"` instead of a specific contact ID to get the referred friend for the current identity's contact.
3858
+ * @param - Contact ID or "me" to get the current identity's contact.
3859
+ * @returns Retrieved referred friend.
3796
3860
  */
3797
3861
  (contactId: string): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
3798
3862
  }
3799
3863
  declare function updateReferredFriend$1(httpClient: HttpClient): UpdateReferredFriendSignature;
3800
3864
  interface UpdateReferredFriendSignature {
3801
3865
  /**
3802
- * Update a ReferredFriend, supports partial update.
3866
+ * Updates a referred friend. Supports partial updates.
3803
3867
  *
3804
- * Pass the latest `revision` for a successful update.
3805
- * @param - ReferredFriend ID.
3806
- * @returns The updated ReferredFriend.
3868
+ * You must pass the latest revision for a successful update.
3869
+ * @param - ID of the referred friend.
3870
+ * @returns Updated referred friend.
3807
3871
  */
3808
3872
  (_id: string, referredFriend: UpdateReferredFriend): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
3809
3873
  }
3810
3874
  declare function deleteReferredFriend$1(httpClient: HttpClient): DeleteReferredFriendSignature;
3811
3875
  interface DeleteReferredFriendSignature {
3812
3876
  /**
3813
- * Delete a ReferredFriend.
3814
- * @param - Id of the ReferredFriend to delete.
3877
+ * Deletes a referred friend.
3815
3878
  */
3816
3879
  (referredFriendId: string, options?: DeleteReferredFriendOptions | undefined): Promise<void>;
3817
3880
  }
3818
3881
  declare function queryReferredFriend$1(httpClient: HttpClient): QueryReferredFriendSignature;
3819
3882
  interface QueryReferredFriendSignature {
3820
3883
  /**
3821
- * Query ReferredFriends using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
3884
+ * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
3885
+ *
3886
+ * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language).
3887
+ *
3888
+ * You can filter by:
3889
+ * - `referring_customer_id`
3890
+ * - `status`
3891
+ * - `created_date`
3892
+ *
3893
+ * To learn about working with _Query_ endpoints, see
3894
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
3895
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
3896
+ * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3822
3897
  */
3823
3898
  (): ReferredFriendsQueryBuilder;
3824
3899
  }
@@ -4320,9 +4395,9 @@ interface GenerateReferringCustomerForContactSignature {
4320
4395
  /**
4321
4396
  * Creates a new referring customer or returns an existing one for the provided contact ID.
4322
4397
  *
4323
- * You can use "me" instead of a specific contact ID to generate a referring customer for the current identity's contact.
4398
+ * You can use `"me"`` instead of a specific contact ID to generate a referring customer for the current identity's contact.
4324
4399
  *
4325
- * See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) to learn more about identies.
4400
+ * See the [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) article to learn more about identies.
4326
4401
  * @param - Contact ID or `"me"` to generate the current identity's referring customer.
4327
4402
  */
4328
4403
  (contactId: string): Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
@@ -4349,7 +4424,7 @@ interface QueryReferringCustomersSignature {
4349
4424
  /**
4350
4425
  * Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
4351
4426
  *
4352
- * TODO: This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
4427
+ * This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
4353
4428
  * `contact_id`, `referral_code`, `created_date`, `updated_date`.
4354
4429
  *
4355
4430
  * To learn about working with _Query_ endpoints, see