@wix/referral 1.0.12 → 1.0.14
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.
- package/package.json +5 -5
- package/type-bundles/context.bundle.d.ts +181 -138
- package/type-bundles/index.bundle.d.ts +181 -138
- package/type-bundles/meta.bundle.d.ts +234 -194
|
@@ -46,16 +46,21 @@ interface ReferralProgram {
|
|
|
46
46
|
/** Referral program name. */
|
|
47
47
|
name?: string | null;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Status of the referral program.
|
|
50
50
|
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* - `
|
|
54
|
-
* - `
|
|
51
|
+
* Possible values:
|
|
52
|
+
*
|
|
53
|
+
* - `UNKNOWN`: The status of the referral program is unknown. This value is not used.
|
|
54
|
+
* - `DRAFT`: The referral program is in a draft state and is being modified. It is not yet active.
|
|
55
|
+
* - `ACTIVE`: The referral program is active.
|
|
56
|
+
* - `PAUSED`: The referral program is paused.
|
|
55
57
|
* @readonly
|
|
56
58
|
*/
|
|
57
59
|
status?: ProgramStatus;
|
|
58
|
-
/**
|
|
60
|
+
/**
|
|
61
|
+
* Revision number, which increments by 1 each time the program is updated.
|
|
62
|
+
* To prevent conflicting changes, the current `revision` must be passed when updating the program.
|
|
63
|
+
*/
|
|
59
64
|
revision?: string | null;
|
|
60
65
|
/**
|
|
61
66
|
* Date and time the program was created.
|
|
@@ -63,7 +68,7 @@ interface ReferralProgram {
|
|
|
63
68
|
*/
|
|
64
69
|
_createdDate?: Date;
|
|
65
70
|
/**
|
|
66
|
-
* Date and time the program was updated.
|
|
71
|
+
* Date and time the program was last updated.
|
|
67
72
|
* @readonly
|
|
68
73
|
*/
|
|
69
74
|
_updatedDate?: Date;
|
|
@@ -78,7 +83,7 @@ interface ReferralProgram {
|
|
|
78
83
|
*/
|
|
79
84
|
referringCustomerReward?: Reward$2;
|
|
80
85
|
/**
|
|
81
|
-
*
|
|
86
|
+
* List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
|
|
82
87
|
*
|
|
83
88
|
* Possible values:
|
|
84
89
|
*
|
|
@@ -92,8 +97,12 @@ interface ReferralProgram {
|
|
|
92
97
|
successfulReferralActions?: Action[];
|
|
93
98
|
/**
|
|
94
99
|
* Whether the user has the required plan to use the referral program.
|
|
100
|
+
*
|
|
101
|
+
* Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
|
|
95
102
|
* @readonly
|
|
96
103
|
* @deprecated Whether the user has the required plan to use the referral program.
|
|
104
|
+
*
|
|
105
|
+
* Deprecated: Use `[GetReferralProgramPremiumFeatures](https://dev.wix.com/docs/velo/api-reference/wix-marketing-v2/referral-program/programs/get-referral-program-premium-features)` instead.
|
|
97
106
|
* @replacedBy GetReferralProgramPremiumFeatures
|
|
98
107
|
* @targetRemovalDate 2024-09-01
|
|
99
108
|
*/
|
|
@@ -244,7 +253,7 @@ declare enum Action {
|
|
|
244
253
|
}
|
|
245
254
|
interface Emails {
|
|
246
255
|
/**
|
|
247
|
-
*
|
|
256
|
+
* Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled.
|
|
248
257
|
*
|
|
249
258
|
* Available apps:
|
|
250
259
|
*
|
|
@@ -275,7 +284,7 @@ declare enum App {
|
|
|
275
284
|
}
|
|
276
285
|
interface PremiumFeatures {
|
|
277
286
|
/**
|
|
278
|
-
* Whether the user has the referral program feature.
|
|
287
|
+
* Whether the user has access to the referral program feature.
|
|
279
288
|
* @readonly
|
|
280
289
|
*/
|
|
281
290
|
referralProgram?: boolean;
|
|
@@ -484,7 +493,7 @@ interface DomainEventBodyOneOf$4 {
|
|
|
484
493
|
interface EntityCreatedEvent$4 {
|
|
485
494
|
entity?: string;
|
|
486
495
|
}
|
|
487
|
-
interface RestoreInfo$
|
|
496
|
+
interface RestoreInfo$3 {
|
|
488
497
|
deletedDate?: Date;
|
|
489
498
|
}
|
|
490
499
|
interface EntityUpdatedEvent$4 {
|
|
@@ -1752,110 +1761,113 @@ declare const context$4_pauseReferralProgram: typeof pauseReferralProgram;
|
|
|
1752
1761
|
declare const context$4_queryReferralPrograms: typeof queryReferralPrograms;
|
|
1753
1762
|
declare const context$4_updateReferralProgram: typeof updateReferralProgram;
|
|
1754
1763
|
declare namespace context$4 {
|
|
1755
|
-
export { type context$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, context$4_Action as Action, type ActionEvent$4 as ActionEvent, type context$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type context$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type context$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, context$4_App as App, type context$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type context$4_BillingReference as BillingReference, type context$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type context$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type context$4_CancellationDetails as CancellationDetails, context$4_ContractSwitchReason as ContractSwitchReason, context$4_ContractSwitchType as ContractSwitchType, type context$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 context$4_Cycle as Cycle, type context$4_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, type context$4_DeleteContext as DeleteContext, context$4_DeleteStatus as DeleteStatus, DiscountType$2 as DiscountType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type context$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 context$4_GenerateAISocialMediaPostsSuggestionsRequest as GenerateAISocialMediaPostsSuggestionsRequest, type context$4_GenerateAISocialMediaPostsSuggestionsResponse as GenerateAISocialMediaPostsSuggestionsResponse, type context$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields as GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, type context$4_GenerateAiSocialMediaPostsSuggestionsOptions as GenerateAiSocialMediaPostsSuggestionsOptions, type context$4_GetAISocialMediaPostsSuggestionsRequest as GetAISocialMediaPostsSuggestionsRequest, type context$4_GetAISocialMediaPostsSuggestionsResponse as GetAISocialMediaPostsSuggestionsResponse, type context$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields as GetAISocialMediaPostsSuggestionsResponseNonNullableFields, type context$4_GetAiSocialMediaPostsSuggestionsOptions as GetAiSocialMediaPostsSuggestionsOptions, type context$4_GetReferralProgramPremiumFeaturesRequest as GetReferralProgramPremiumFeaturesRequest, type context$4_GetReferralProgramPremiumFeaturesResponse as GetReferralProgramPremiumFeaturesResponse, type context$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields as GetReferralProgramPremiumFeaturesResponseNonNullableFields, type context$4_GetReferralProgramRequest as GetReferralProgramRequest, type context$4_GetReferralProgramResponse as GetReferralProgramResponse, type context$4_GetReferralProgramResponseNonNullableFields as GetReferralProgramResponseNonNullableFields, type Group$2 as Group, type context$4_HtmlSitePublished as HtmlSitePublished, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, context$4_Initiator as Initiator, type context$4_Interval as Interval, context$4_IntervalUnit as IntervalUnit, type LoyaltyPoints$2 as LoyaltyPoints, type MessageEnvelope$4 as MessageEnvelope, type context$4_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context$4_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, context$4_Namespace as Namespace, type context$4_NamespaceChanged as NamespaceChanged, type context$4_OneTime as OneTime, type context$4_Page as Page, type context$4_PauseReferralProgramRequest as PauseReferralProgramRequest, type context$4_PauseReferralProgramResponse as PauseReferralProgramResponse, type context$4_PauseReferralProgramResponseNonNullableFields as PauseReferralProgramResponseNonNullableFields, type PercentageDiscount$2 as PercentageDiscount, type context$4_PremiumFeatures as PremiumFeatures, context$4_PriceIncreaseTrigger as PriceIncreaseTrigger, context$4_ProductAdjustment as ProductAdjustment, type context$4_ProductPriceIncreaseData as ProductPriceIncreaseData, type context$4_ProgramInSite as ProgramInSite, context$4_ProgramStatus as ProgramStatus, type context$4_ProgramUpdatedEnvelope as ProgramUpdatedEnvelope, context$4_ProviderName as ProviderName, type context$4_QueryReferralProgramsRequest as QueryReferralProgramsRequest, type context$4_QueryReferralProgramsResponse as QueryReferralProgramsResponse, type context$4_QueryReferralProgramsResponseNonNullableFields as QueryReferralProgramsResponseNonNullableFields, type context$4_ReactivationData as ReactivationData, context$4_ReactivationReasonEnum as ReactivationReasonEnum, type context$4_RecurringChargeSucceeded as RecurringChargeSucceeded, type context$4_ReferralProgram as ReferralProgram, type context$4_ReferralProgramsQueryBuilder as ReferralProgramsQueryBuilder, type context$4_ReferralProgramsQueryResult as ReferralProgramsQueryResult, type RestoreInfo$
|
|
1764
|
+
export { type context$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, context$4_Action as Action, type ActionEvent$4 as ActionEvent, type context$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type context$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type context$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, context$4_App as App, type context$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type context$4_BillingReference as BillingReference, type context$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type context$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type context$4_CancellationDetails as CancellationDetails, context$4_ContractSwitchReason as ContractSwitchReason, context$4_ContractSwitchType as ContractSwitchType, type context$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 context$4_Cycle as Cycle, type context$4_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, type context$4_DeleteContext as DeleteContext, context$4_DeleteStatus as DeleteStatus, DiscountType$2 as DiscountType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type context$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 context$4_GenerateAISocialMediaPostsSuggestionsRequest as GenerateAISocialMediaPostsSuggestionsRequest, type context$4_GenerateAISocialMediaPostsSuggestionsResponse as GenerateAISocialMediaPostsSuggestionsResponse, type context$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields as GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, type context$4_GenerateAiSocialMediaPostsSuggestionsOptions as GenerateAiSocialMediaPostsSuggestionsOptions, type context$4_GetAISocialMediaPostsSuggestionsRequest as GetAISocialMediaPostsSuggestionsRequest, type context$4_GetAISocialMediaPostsSuggestionsResponse as GetAISocialMediaPostsSuggestionsResponse, type context$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields as GetAISocialMediaPostsSuggestionsResponseNonNullableFields, type context$4_GetAiSocialMediaPostsSuggestionsOptions as GetAiSocialMediaPostsSuggestionsOptions, type context$4_GetReferralProgramPremiumFeaturesRequest as GetReferralProgramPremiumFeaturesRequest, type context$4_GetReferralProgramPremiumFeaturesResponse as GetReferralProgramPremiumFeaturesResponse, type context$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields as GetReferralProgramPremiumFeaturesResponseNonNullableFields, type context$4_GetReferralProgramRequest as GetReferralProgramRequest, type context$4_GetReferralProgramResponse as GetReferralProgramResponse, type context$4_GetReferralProgramResponseNonNullableFields as GetReferralProgramResponseNonNullableFields, type Group$2 as Group, type context$4_HtmlSitePublished as HtmlSitePublished, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, context$4_Initiator as Initiator, type context$4_Interval as Interval, context$4_IntervalUnit as IntervalUnit, type LoyaltyPoints$2 as LoyaltyPoints, type MessageEnvelope$4 as MessageEnvelope, type context$4_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context$4_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, context$4_Namespace as Namespace, type context$4_NamespaceChanged as NamespaceChanged, type context$4_OneTime as OneTime, type context$4_Page as Page, type context$4_PauseReferralProgramRequest as PauseReferralProgramRequest, type context$4_PauseReferralProgramResponse as PauseReferralProgramResponse, type context$4_PauseReferralProgramResponseNonNullableFields as PauseReferralProgramResponseNonNullableFields, type PercentageDiscount$2 as PercentageDiscount, type context$4_PremiumFeatures as PremiumFeatures, context$4_PriceIncreaseTrigger as PriceIncreaseTrigger, context$4_ProductAdjustment as ProductAdjustment, type context$4_ProductPriceIncreaseData as ProductPriceIncreaseData, type context$4_ProgramInSite as ProgramInSite, context$4_ProgramStatus as ProgramStatus, type context$4_ProgramUpdatedEnvelope as ProgramUpdatedEnvelope, context$4_ProviderName as ProviderName, type context$4_QueryReferralProgramsRequest as QueryReferralProgramsRequest, type context$4_QueryReferralProgramsResponse as QueryReferralProgramsResponse, type context$4_QueryReferralProgramsResponseNonNullableFields as QueryReferralProgramsResponseNonNullableFields, type context$4_ReactivationData as ReactivationData, context$4_ReactivationReasonEnum as ReactivationReasonEnum, type context$4_RecurringChargeSucceeded as RecurringChargeSucceeded, type context$4_ReferralProgram as ReferralProgram, type context$4_ReferralProgramsQueryBuilder as ReferralProgramsQueryBuilder, type context$4_ReferralProgramsQueryResult as ReferralProgramsQueryResult, type RestoreInfo$3 as RestoreInfo, type Reward$2 as Reward, type RewardOptionsOneOf$1 as RewardOptionsOneOf, type context$4_ServiceProvisioned as ServiceProvisioned, type context$4_ServiceRemoved as ServiceRemoved, type context$4_SiteCreated as SiteCreated, context$4_SiteCreatedContext as SiteCreatedContext, type context$4_SiteDeleted as SiteDeleted, type context$4_SiteHardDeleted as SiteHardDeleted, type context$4_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type context$4_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type context$4_SitePublished as SitePublished, type context$4_SiteRenamed as SiteRenamed, type context$4_SiteTransferred as SiteTransferred, type context$4_SiteUndeleted as SiteUndeleted, type context$4_SiteUnpublished as SiteUnpublished, SortOrder$4 as SortOrder, type Sorting$4 as Sorting, context$4_State as State, type context$4_StudioAssigned as StudioAssigned, type context$4_StudioUnassigned as StudioUnassigned, type context$4_Subscription as Subscription, type context$4_SubscriptionAssigned as SubscriptionAssigned, type context$4_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type context$4_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type context$4_SubscriptionCancelled as SubscriptionCancelled, type context$4_SubscriptionCreated as SubscriptionCreated, type context$4_SubscriptionEvent as SubscriptionEvent, type context$4_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type context$4_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type context$4_SubscriptionPendingChange as SubscriptionPendingChange, context$4_SubscriptionStatus as SubscriptionStatus, type context$4_SubscriptionTransferred as SubscriptionTransferred, type context$4_SubscriptionUnassigned as SubscriptionUnassigned, Type$1 as Type, context$4_UnassignReason as UnassignReason, type context$4_UpdateReferralProgramRequest as UpdateReferralProgramRequest, type context$4_UpdateReferralProgramResponse as UpdateReferralProgramResponse, type context$4_UpdateReferralProgramResponseNonNullableFields as UpdateReferralProgramResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, type context$4__publicActivateReferralProgramType as _publicActivateReferralProgramType, type context$4__publicGenerateAiSocialMediaPostsSuggestionsType as _publicGenerateAiSocialMediaPostsSuggestionsType, type context$4__publicGetAiSocialMediaPostsSuggestionsType as _publicGetAiSocialMediaPostsSuggestionsType, type context$4__publicGetReferralProgramPremiumFeaturesType as _publicGetReferralProgramPremiumFeaturesType, type context$4__publicGetReferralProgramType as _publicGetReferralProgramType, type context$4__publicOnProgramUpdatedType as _publicOnProgramUpdatedType, type context$4__publicPauseReferralProgramType as _publicPauseReferralProgramType, type context$4__publicQueryReferralProgramsType as _publicQueryReferralProgramsType, type context$4__publicUpdateReferralProgramType as _publicUpdateReferralProgramType, context$4_activateReferralProgram as activateReferralProgram, context$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, context$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, context$4_getReferralProgram as getReferralProgram, context$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, context$4_onProgramUpdated as onProgramUpdated, context$4_pauseReferralProgram as pauseReferralProgram, onProgramUpdated$1 as publicOnProgramUpdated, context$4_queryReferralPrograms as queryReferralPrograms, context$4_updateReferralProgram as updateReferralProgram };
|
|
1756
1765
|
}
|
|
1757
1766
|
|
|
1758
1767
|
interface ReferralEvent extends ReferralEventEventTypeOneOf {
|
|
1759
|
-
/**
|
|
1768
|
+
/** Event triggered when a referred friend signs up. */
|
|
1760
1769
|
referredFriendSignupEvent?: ReferredFriendSignupEvent;
|
|
1761
|
-
/**
|
|
1770
|
+
/** Event triggered when a referral is successful. For example, customer places and pays for an order. */
|
|
1762
1771
|
successfulReferralEvent?: V1SuccessfulReferralEvent;
|
|
1763
|
-
/**
|
|
1772
|
+
/** Event triggered when an action is performed. For example, placing an order. */
|
|
1764
1773
|
actionEvent?: V1ActionEvent;
|
|
1765
|
-
/**
|
|
1774
|
+
/** Event triggered when a reward is given. */
|
|
1766
1775
|
rewardEvent?: RewardEvent;
|
|
1767
1776
|
/**
|
|
1768
|
-
*
|
|
1777
|
+
* Referral event ID.
|
|
1769
1778
|
* @readonly
|
|
1770
1779
|
*/
|
|
1771
1780
|
_id?: string | null;
|
|
1772
|
-
/**
|
|
1781
|
+
/**
|
|
1782
|
+
* Revision number, which increments by 1 each time the referral event is updated.
|
|
1783
|
+
* To prevent conflicting changes, the current revision must be passed when updating the referral event.
|
|
1784
|
+
*/
|
|
1773
1785
|
revision?: string | null;
|
|
1774
1786
|
/**
|
|
1775
|
-
*
|
|
1787
|
+
* Date and time the referral event was created.
|
|
1776
1788
|
* @readonly
|
|
1777
1789
|
*/
|
|
1778
1790
|
_createdDate?: Date;
|
|
1779
1791
|
/**
|
|
1780
|
-
*
|
|
1792
|
+
* Date and time the referral event was last updated.
|
|
1781
1793
|
* @readonly
|
|
1782
1794
|
*/
|
|
1783
1795
|
_updatedDate?: Date;
|
|
1784
1796
|
}
|
|
1785
1797
|
/** @oneof */
|
|
1786
1798
|
interface ReferralEventEventTypeOneOf {
|
|
1787
|
-
/**
|
|
1799
|
+
/** Event triggered when a referred friend signs up. */
|
|
1788
1800
|
referredFriendSignupEvent?: ReferredFriendSignupEvent;
|
|
1789
|
-
/**
|
|
1801
|
+
/** Event triggered when a referral is successful. For example, customer places and pays for an order. */
|
|
1790
1802
|
successfulReferralEvent?: V1SuccessfulReferralEvent;
|
|
1791
|
-
/**
|
|
1803
|
+
/** Event triggered when an action is performed. For example, placing an order. */
|
|
1792
1804
|
actionEvent?: V1ActionEvent;
|
|
1793
|
-
/**
|
|
1805
|
+
/** Event triggered when a reward is given. */
|
|
1794
1806
|
rewardEvent?: RewardEvent;
|
|
1795
1807
|
}
|
|
1796
1808
|
interface ReferredFriendSignupEvent {
|
|
1797
|
-
/**
|
|
1809
|
+
/** ID of the referred friend */
|
|
1798
1810
|
referredFriendId?: string;
|
|
1799
1811
|
}
|
|
1800
1812
|
interface V1SuccessfulReferralEvent {
|
|
1801
|
-
/**
|
|
1813
|
+
/** ID of the referred friend */
|
|
1802
1814
|
referredFriendId?: string;
|
|
1803
|
-
/**
|
|
1815
|
+
/** ID of the referring customer */
|
|
1804
1816
|
referringCustomerId?: string;
|
|
1805
1817
|
}
|
|
1806
1818
|
interface V1ActionEvent {
|
|
1807
|
-
/**
|
|
1819
|
+
/** ID of the referred friend */
|
|
1808
1820
|
referredFriendId?: string;
|
|
1809
|
-
/**
|
|
1821
|
+
/** ID of the referring customer */
|
|
1810
1822
|
referringCustomerId?: string;
|
|
1811
|
-
/**
|
|
1823
|
+
/** Trigger for the action */
|
|
1812
1824
|
trigger?: V1Trigger;
|
|
1813
|
-
/** Amount. */
|
|
1825
|
+
/** Amount associated with the action. */
|
|
1814
1826
|
amount?: string | null;
|
|
1815
|
-
/** Currency. */
|
|
1827
|
+
/** Currency of the amount. */
|
|
1816
1828
|
currency?: string | null;
|
|
1817
|
-
/**
|
|
1829
|
+
/** ID of the associated order. */
|
|
1818
1830
|
orderId?: string | null;
|
|
1819
1831
|
}
|
|
1820
1832
|
interface V1Trigger {
|
|
1821
|
-
/**
|
|
1833
|
+
/** ID of the app that triggered the event */
|
|
1822
1834
|
appId?: string;
|
|
1823
|
-
/**
|
|
1835
|
+
/** Type of activity that triggered the event */
|
|
1824
1836
|
activityType?: string;
|
|
1825
1837
|
}
|
|
1826
1838
|
interface RewardEvent extends RewardEventReceiverOneOf {
|
|
1827
1839
|
/**
|
|
1828
|
-
*
|
|
1840
|
+
* ID of the rewarded referring customer.
|
|
1829
1841
|
* @readonly
|
|
1830
1842
|
*/
|
|
1831
1843
|
rewardedReferringCustomerId?: string;
|
|
1832
1844
|
/**
|
|
1833
|
-
*
|
|
1845
|
+
* ID of the rewarded referred friend.
|
|
1834
1846
|
* @readonly
|
|
1835
1847
|
*/
|
|
1836
1848
|
rewardedReferredFriendId?: string;
|
|
1837
|
-
/**
|
|
1849
|
+
/** ID of the referral reward. */
|
|
1838
1850
|
referralRewardId?: string;
|
|
1839
|
-
/**
|
|
1851
|
+
/** Type of reward. */
|
|
1840
1852
|
rewardType?: Reward$1;
|
|
1841
1853
|
}
|
|
1842
1854
|
/** @oneof */
|
|
1843
1855
|
interface RewardEventReceiverOneOf {
|
|
1844
1856
|
/**
|
|
1845
|
-
*
|
|
1857
|
+
* ID of the rewarded referring customer.
|
|
1846
1858
|
* @readonly
|
|
1847
1859
|
*/
|
|
1848
1860
|
rewardedReferringCustomerId?: string;
|
|
1849
1861
|
/**
|
|
1850
|
-
*
|
|
1862
|
+
* ID of the rewarded referred friend.
|
|
1851
1863
|
* @readonly
|
|
1852
1864
|
*/
|
|
1853
1865
|
rewardedReferredFriendId?: string;
|
|
1854
1866
|
}
|
|
1855
1867
|
declare enum Reward$1 {
|
|
1856
|
-
/** Unknown reward
|
|
1868
|
+
/** Unknown reward. This field is not used. */
|
|
1857
1869
|
UNKNOWN = "UNKNOWN",
|
|
1858
|
-
/** Reward is a coupon
|
|
1870
|
+
/** Reward is a coupon */
|
|
1859
1871
|
COUPON = "COUPON",
|
|
1860
1872
|
/** Reward is loyalty points. */
|
|
1861
1873
|
LOYALTY_POINTS = "LOYALTY_POINTS",
|
|
@@ -1863,23 +1875,23 @@ declare enum Reward$1 {
|
|
|
1863
1875
|
NOTHING = "NOTHING"
|
|
1864
1876
|
}
|
|
1865
1877
|
interface CreateReferralEventRequest {
|
|
1866
|
-
/**
|
|
1878
|
+
/** Referral event to create */
|
|
1867
1879
|
referralEvent?: ReferralEvent;
|
|
1868
1880
|
}
|
|
1869
1881
|
interface CreateReferralEventResponse {
|
|
1870
|
-
/**
|
|
1882
|
+
/** Created referral event */
|
|
1871
1883
|
referralEvent?: ReferralEvent;
|
|
1872
1884
|
}
|
|
1873
1885
|
interface GetReferralEventRequest {
|
|
1874
|
-
/**
|
|
1886
|
+
/** ID of the referral event to retrieve. */
|
|
1875
1887
|
referralEventId: string;
|
|
1876
1888
|
}
|
|
1877
1889
|
interface GetReferralEventResponse {
|
|
1878
|
-
/**
|
|
1890
|
+
/** Retrieved referral event. */
|
|
1879
1891
|
referralEvent?: ReferralEvent;
|
|
1880
1892
|
}
|
|
1881
1893
|
interface QueryReferralEventRequest {
|
|
1882
|
-
/** Query to filter
|
|
1894
|
+
/** Query to filter referral events */
|
|
1883
1895
|
query: CursorQuery$3;
|
|
1884
1896
|
}
|
|
1885
1897
|
interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
|
|
@@ -1933,9 +1945,9 @@ interface CursorPaging$3 {
|
|
|
1933
1945
|
cursor?: string | null;
|
|
1934
1946
|
}
|
|
1935
1947
|
interface QueryReferralEventResponse {
|
|
1936
|
-
/** List of
|
|
1948
|
+
/** List of referral events. */
|
|
1937
1949
|
referralEvents?: ReferralEvent[];
|
|
1938
|
-
/**
|
|
1950
|
+
/** Metadata for the paginated results. */
|
|
1939
1951
|
metadata?: CursorPagingMetadata$3;
|
|
1940
1952
|
}
|
|
1941
1953
|
interface CursorPagingMetadata$3 {
|
|
@@ -1960,72 +1972,71 @@ interface Cursors$3 {
|
|
|
1960
1972
|
interface GetReferralStatisticsRequest {
|
|
1961
1973
|
}
|
|
1962
1974
|
interface GetReferralStatisticsResponse {
|
|
1963
|
-
/** Total sign
|
|
1975
|
+
/** Total number of sign-ups completed by referred friends. */
|
|
1964
1976
|
totalSignUpsCompleted?: number;
|
|
1965
|
-
/** Total actions completed by referred friends */
|
|
1977
|
+
/** Total number of actions completed by referred friends. */
|
|
1966
1978
|
totalActionsCompleted?: number;
|
|
1967
|
-
/** Total amount of purchases made by referred friends */
|
|
1979
|
+
/** Total amount of purchases made by referred friends. */
|
|
1968
1980
|
totalAmountGenerated?: string;
|
|
1969
1981
|
}
|
|
1970
1982
|
interface QueryReferringCustomerTotalsRequest {
|
|
1971
|
-
/** Query to filter
|
|
1983
|
+
/** Query to filter referring customer totals. */
|
|
1972
1984
|
query?: CursorQuery$3;
|
|
1973
|
-
/** List of contact
|
|
1985
|
+
/** List of contact IDs to filter referring customer totals. */
|
|
1974
1986
|
contactIds?: string[];
|
|
1975
1987
|
}
|
|
1976
1988
|
interface QueryReferringCustomerTotalsResponse {
|
|
1977
|
-
/** List of ReferringCustomerTotals that match the query. */
|
|
1978
1989
|
referringCustomerTotals?: ReferringCustomerTotal[];
|
|
1979
|
-
/** Paging metadata
|
|
1990
|
+
/** Paging metadata */
|
|
1980
1991
|
metadata?: CursorPagingMetadata$3;
|
|
1981
1992
|
}
|
|
1982
1993
|
interface ReferringCustomerTotal {
|
|
1983
1994
|
/**
|
|
1984
|
-
*
|
|
1995
|
+
* ID of the referring customer.
|
|
1985
1996
|
* @readonly
|
|
1986
1997
|
*/
|
|
1987
1998
|
referringCustomerId?: string;
|
|
1988
1999
|
/**
|
|
1989
|
-
* Contact
|
|
2000
|
+
* Contact ID.
|
|
1990
2001
|
* @readonly
|
|
1991
2002
|
*/
|
|
1992
2003
|
contactId?: string;
|
|
1993
2004
|
/**
|
|
1994
|
-
*
|
|
2005
|
+
* Date and time of the last successful referral.
|
|
1995
2006
|
* @readonly
|
|
1996
2007
|
*/
|
|
1997
2008
|
lastSuccessfulReferral?: Date;
|
|
1998
2009
|
/**
|
|
1999
|
-
* Total successful referrals made by this customer.
|
|
2010
|
+
* Total number of successful referrals made by this customer.
|
|
2000
2011
|
* @readonly
|
|
2001
2012
|
*/
|
|
2002
2013
|
totalSuccessfulReferrals?: number;
|
|
2003
2014
|
/**
|
|
2004
|
-
* Total amount generated by friends referred by this customer.
|
|
2015
|
+
* Total amount of revenue generated by friends referred by this customer.
|
|
2005
2016
|
* @readonly
|
|
2006
2017
|
*/
|
|
2007
2018
|
totalAmountGenerated?: string;
|
|
2008
2019
|
/**
|
|
2009
|
-
*
|
|
2020
|
+
* Date and time of the last friend action.
|
|
2010
2021
|
* @readonly
|
|
2011
2022
|
*/
|
|
2012
2023
|
lastFriendAction?: Date;
|
|
2013
2024
|
/**
|
|
2014
|
-
*
|
|
2025
|
+
* Number of friends who have completed actions.
|
|
2015
2026
|
* @readonly
|
|
2016
2027
|
*/
|
|
2017
2028
|
totalFriendsWithActions?: number;
|
|
2018
2029
|
}
|
|
2019
2030
|
interface QueryReferredFriendActionsRequest {
|
|
2020
|
-
/** Query to filter
|
|
2031
|
+
/** Query to filter referred friend actions. */
|
|
2021
2032
|
query?: CursorQuery$3;
|
|
2022
|
-
/** List of contact
|
|
2033
|
+
/** List of contact IDs to filter referred friend actions. */
|
|
2023
2034
|
contactIds?: string[];
|
|
2024
2035
|
}
|
|
2025
2036
|
interface QueryReferredFriendActionsResponse {
|
|
2026
|
-
/** List of
|
|
2037
|
+
/** List of referred friend actions matching the query. */
|
|
2027
2038
|
referredFriendActions?: ReferredFriendAction[];
|
|
2028
|
-
/** Paging metadata
|
|
2039
|
+
/** Paging metadata */
|
|
2029
2040
|
metadata?: CursorPagingMetadata$3;
|
|
2030
2041
|
}
|
|
2031
2042
|
interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
|
|
@@ -2034,28 +2045,28 @@ interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneO
|
|
|
2034
2045
|
/** Loyalty points reward type options. */
|
|
2035
2046
|
loyaltyPoints?: LoyaltyPoints$1;
|
|
2036
2047
|
/**
|
|
2037
|
-
* Referred friend
|
|
2048
|
+
* Referred friend ID.
|
|
2038
2049
|
* @readonly
|
|
2039
2050
|
*/
|
|
2040
2051
|
referredFriendId?: string;
|
|
2041
2052
|
/**
|
|
2042
|
-
* Contact
|
|
2053
|
+
* Contact ID.
|
|
2043
2054
|
* @readonly
|
|
2044
2055
|
*/
|
|
2045
2056
|
contactId?: string;
|
|
2046
2057
|
/**
|
|
2047
|
-
*
|
|
2058
|
+
* Trigger for the first action.
|
|
2048
2059
|
* @readonly
|
|
2049
2060
|
*/
|
|
2050
2061
|
trigger?: V1Trigger;
|
|
2051
2062
|
/**
|
|
2052
|
-
*
|
|
2063
|
+
* Date and time of the first action.
|
|
2053
2064
|
* @readonly
|
|
2054
2065
|
*/
|
|
2055
2066
|
actionDate?: Date;
|
|
2056
|
-
/**
|
|
2067
|
+
/** Type of issued reward. */
|
|
2057
2068
|
rewardType?: Reward$1;
|
|
2058
|
-
/**
|
|
2069
|
+
/** Number of actions completed. */
|
|
2059
2070
|
totalActions?: number;
|
|
2060
2071
|
/**
|
|
2061
2072
|
* Total amount spent by this referred friend.
|
|
@@ -2063,7 +2074,7 @@ interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneO
|
|
|
2063
2074
|
*/
|
|
2064
2075
|
totalAmountSpent?: string;
|
|
2065
2076
|
/**
|
|
2066
|
-
* friend signup
|
|
2077
|
+
* Date and time of friend signup.
|
|
2067
2078
|
* @readonly
|
|
2068
2079
|
*/
|
|
2069
2080
|
signupDate?: Date;
|
|
@@ -2261,7 +2272,7 @@ interface DomainEventBodyOneOf$3 {
|
|
|
2261
2272
|
interface EntityCreatedEvent$3 {
|
|
2262
2273
|
entity?: string;
|
|
2263
2274
|
}
|
|
2264
|
-
interface RestoreInfo$
|
|
2275
|
+
interface RestoreInfo$2 {
|
|
2265
2276
|
deletedDate?: Date;
|
|
2266
2277
|
}
|
|
2267
2278
|
interface EntityUpdatedEvent$3 {
|
|
@@ -2576,52 +2587,67 @@ interface ReferralEventsQueryBuilder {
|
|
|
2576
2587
|
find: () => Promise<ReferralEventsQueryResult>;
|
|
2577
2588
|
}
|
|
2578
2589
|
interface QueryReferringCustomerTotalsOptions {
|
|
2579
|
-
/** Query to filter
|
|
2590
|
+
/** Query to filter referring customer totals. */
|
|
2580
2591
|
query?: CursorQuery$3;
|
|
2581
|
-
/** List of contact
|
|
2592
|
+
/** List of contact IDs to filter referring customer totals. */
|
|
2582
2593
|
contactIds?: string[];
|
|
2583
2594
|
}
|
|
2584
2595
|
interface QueryReferredFriendActionsOptions {
|
|
2585
|
-
/** Query to filter
|
|
2596
|
+
/** Query to filter referred friend actions. */
|
|
2586
2597
|
query?: CursorQuery$3;
|
|
2587
|
-
/** List of contact
|
|
2598
|
+
/** List of contact IDs to filter referred friend actions. */
|
|
2588
2599
|
contactIds?: string[];
|
|
2589
2600
|
}
|
|
2590
2601
|
|
|
2591
2602
|
declare function getReferralEvent$1(httpClient: HttpClient): GetReferralEventSignature;
|
|
2592
2603
|
interface GetReferralEventSignature {
|
|
2593
2604
|
/**
|
|
2594
|
-
*
|
|
2595
|
-
* @param -
|
|
2596
|
-
* @returns
|
|
2605
|
+
* Retrieves a referral event by ID.
|
|
2606
|
+
* @param - ID of the referral event to retrieve.
|
|
2607
|
+
* @returns Retrieved referral event.
|
|
2597
2608
|
*/
|
|
2598
2609
|
(referralEventId: string): Promise<ReferralEvent & ReferralEventNonNullableFields>;
|
|
2599
2610
|
}
|
|
2600
2611
|
declare function queryReferralEvent$1(httpClient: HttpClient): QueryReferralEventSignature;
|
|
2601
2612
|
interface QueryReferralEventSignature {
|
|
2602
2613
|
/**
|
|
2603
|
-
*
|
|
2614
|
+
* Retrieves a list of referral events, given the provided paging, filtering, and sorting.
|
|
2615
|
+
*
|
|
2616
|
+
* To learn about working with Query endpoints, see
|
|
2617
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
2618
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
2619
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
2604
2620
|
*/
|
|
2605
2621
|
(): ReferralEventsQueryBuilder;
|
|
2606
2622
|
}
|
|
2607
2623
|
declare function getReferralStatistics$1(httpClient: HttpClient): GetReferralStatisticsSignature;
|
|
2608
2624
|
interface GetReferralStatisticsSignature {
|
|
2609
2625
|
/**
|
|
2610
|
-
*
|
|
2626
|
+
* Retrieves referral statistics.
|
|
2611
2627
|
*/
|
|
2612
2628
|
(): Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
|
|
2613
2629
|
}
|
|
2614
2630
|
declare function queryReferringCustomerTotals$1(httpClient: HttpClient): QueryReferringCustomerTotalsSignature;
|
|
2615
2631
|
interface QueryReferringCustomerTotalsSignature {
|
|
2616
2632
|
/**
|
|
2617
|
-
*
|
|
2633
|
+
* Retrieves a list of referring customer totals, given the provided paging, filtering, and sorting.
|
|
2634
|
+
*
|
|
2635
|
+
* To learn about working with Query endpoints, see
|
|
2636
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
2637
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
2638
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
2618
2639
|
*/
|
|
2619
2640
|
(options?: QueryReferringCustomerTotalsOptions | undefined): Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
|
|
2620
2641
|
}
|
|
2621
2642
|
declare function queryReferredFriendActions$1(httpClient: HttpClient): QueryReferredFriendActionsSignature;
|
|
2622
2643
|
interface QueryReferredFriendActionsSignature {
|
|
2623
2644
|
/**
|
|
2624
|
-
*
|
|
2645
|
+
* Retrieves a list of referred friend actions, given the provided paging, filtering, and sorting.
|
|
2646
|
+
*
|
|
2647
|
+
* To learn about working with Query endpoints, see
|
|
2648
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
2649
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
2650
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
2625
2651
|
*/
|
|
2626
2652
|
(options?: QueryReferredFriendActionsOptions | undefined): Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
|
|
2627
2653
|
}
|
|
@@ -2695,7 +2721,7 @@ declare const context$3_queryReferralEvent: typeof queryReferralEvent;
|
|
|
2695
2721
|
declare const context$3_queryReferredFriendActions: typeof queryReferredFriendActions;
|
|
2696
2722
|
declare const context$3_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
|
|
2697
2723
|
declare namespace context$3 {
|
|
2698
|
-
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 context$3_CreateReferralEventRequest as CreateReferralEventRequest, type context$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 context$3_GetReferralEventRequest as GetReferralEventRequest, type context$3_GetReferralEventResponse as GetReferralEventResponse, type context$3_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type context$3_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type context$3_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type context$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 context$3_QueryReferralEventRequest as QueryReferralEventRequest, type context$3_QueryReferralEventResponse as QueryReferralEventResponse, type context$3_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type context$3_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type context$3_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type context$3_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type context$3_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type context$3_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type context$3_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type context$3_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type context$3_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type context$3_ReferralEvent as ReferralEvent, type context$3_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type context$3_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type context$3_ReferralEventNonNullableFields as ReferralEventNonNullableFields, type context$3_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type context$3_ReferralEventsQueryResult as ReferralEventsQueryResult, type context$3_ReferredFriendAction as ReferredFriendAction, type context$3_ReferredFriendActionEvent as ReferredFriendActionEvent, type context$3_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type ReferredFriendDetails$2 as ReferredFriendDetails, type context$3_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type context$3_ReferringCustomerTotal as ReferringCustomerTotal, type RestoreInfo$
|
|
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 context$3_CreateReferralEventRequest as CreateReferralEventRequest, type context$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 context$3_GetReferralEventRequest as GetReferralEventRequest, type context$3_GetReferralEventResponse as GetReferralEventResponse, type context$3_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type context$3_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type context$3_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type context$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 context$3_QueryReferralEventRequest as QueryReferralEventRequest, type context$3_QueryReferralEventResponse as QueryReferralEventResponse, type context$3_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type context$3_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type context$3_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type context$3_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type context$3_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type context$3_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type context$3_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type context$3_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type context$3_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type context$3_ReferralEvent as ReferralEvent, type context$3_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type context$3_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type context$3_ReferralEventNonNullableFields as ReferralEventNonNullableFields, type context$3_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type context$3_ReferralEventsQueryResult as ReferralEventsQueryResult, type context$3_ReferredFriendAction as ReferredFriendAction, type context$3_ReferredFriendActionEvent as ReferredFriendActionEvent, type context$3_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type ReferredFriendDetails$2 as ReferredFriendDetails, type context$3_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type context$3_ReferringCustomerTotal as ReferringCustomerTotal, type RestoreInfo$2 as RestoreInfo, Reward$1 as Reward, type context$3_RewardEvent as RewardEvent, type context$3_RewardEventReceiverOneOf as RewardEventReceiverOneOf, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, Status$2 as Status, type SuccessfulReferralEvent$2 as SuccessfulReferralEvent, type context$3_Trigger as Trigger, type context$3_V1ActionEvent as V1ActionEvent, type V1Coupon$1 as V1Coupon, type context$3_V1SuccessfulReferralEvent as V1SuccessfulReferralEvent, type context$3_V1Trigger as V1Trigger, WebhookIdentityType$3 as WebhookIdentityType, type context$3__publicGetReferralEventType as _publicGetReferralEventType, type context$3__publicGetReferralStatisticsType as _publicGetReferralStatisticsType, type context$3__publicOnReferralEventCreatedType as _publicOnReferralEventCreatedType, type context$3__publicQueryReferralEventType as _publicQueryReferralEventType, type context$3__publicQueryReferredFriendActionsType as _publicQueryReferredFriendActionsType, type context$3__publicQueryReferringCustomerTotalsType as _publicQueryReferringCustomerTotalsType, context$3_getReferralEvent as getReferralEvent, context$3_getReferralStatistics as getReferralStatistics, context$3_onReferralEventCreated as onReferralEventCreated, onReferralEventCreated$1 as publicOnReferralEventCreated, context$3_queryReferralEvent as queryReferralEvent, context$3_queryReferredFriendActions as queryReferredFriendActions, context$3_queryReferringCustomerTotals as queryReferringCustomerTotals };
|
|
2699
2725
|
}
|
|
2700
2726
|
|
|
2701
2727
|
/** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
|
|
@@ -3047,7 +3073,7 @@ interface DomainEventBodyOneOf$2 {
|
|
|
3047
3073
|
interface EntityCreatedEvent$2 {
|
|
3048
3074
|
entity?: string;
|
|
3049
3075
|
}
|
|
3050
|
-
interface UndeleteInfo
|
|
3076
|
+
interface UndeleteInfo {
|
|
3051
3077
|
deletedDate?: Date;
|
|
3052
3078
|
}
|
|
3053
3079
|
interface EntityUpdatedEvent$2 {
|
|
@@ -3235,6 +3261,7 @@ declare const context$2_RewardTypeType: typeof RewardTypeType;
|
|
|
3235
3261
|
type context$2_RewardsInSite = RewardsInSite;
|
|
3236
3262
|
type context$2_Type = Type;
|
|
3237
3263
|
declare const context$2_Type: typeof Type;
|
|
3264
|
+
type context$2_UndeleteInfo = UndeleteInfo;
|
|
3238
3265
|
type context$2_V1Coupon = V1Coupon;
|
|
3239
3266
|
type context$2_V1LoyaltyPoints = V1LoyaltyPoints;
|
|
3240
3267
|
type context$2_ValidateReferralRewardRequest = ValidateReferralRewardRequest;
|
|
@@ -3244,7 +3271,7 @@ type context$2__publicQueryReferralRewardsType = _publicQueryReferralRewardsType
|
|
|
3244
3271
|
declare const context$2_getReferralReward: typeof getReferralReward;
|
|
3245
3272
|
declare const context$2_queryReferralRewards: typeof queryReferralRewards;
|
|
3246
3273
|
declare namespace context$2 {
|
|
3247
|
-
export { type ActionEvent$2 as ActionEvent, type context$2_BulkGetReferralRewardsRequest as BulkGetReferralRewardsRequest, type context$2_BulkGetReferralRewardsResponse as BulkGetReferralRewardsResponse, type context$2_Coupon as Coupon, type context$2_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type context$2_CouponScope as CouponScope, type context$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, context$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 context$2_FixedAmountDiscount as FixedAmountDiscount, type context$2_GetReferralRewardRequest as GetReferralRewardRequest, type context$2_GetReferralRewardResponse as GetReferralRewardResponse, type context$2_GetReferralRewardResponseNonNullableFields as GetReferralRewardResponseNonNullableFields, type context$2_Group as Group, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type context$2_LoyaltyPoints as LoyaltyPoints, type MessageEnvelope$2 as MessageEnvelope, type context$2_PercentageDiscount as PercentageDiscount, type context$2_QueryReferralRewardsOptions as QueryReferralRewardsOptions, type context$2_QueryReferralRewardsRequest as QueryReferralRewardsRequest, type context$2_QueryReferralRewardsResponse as QueryReferralRewardsResponse, type context$2_QueryReferralRewardsResponseNonNullableFields as QueryReferralRewardsResponseNonNullableFields, type context$2_ReferralReward as ReferralReward, type context$2_ReferralRewardNonNullableFields as ReferralRewardNonNullableFields, type context$2_ReferralRewardReceiverOneOf as ReferralRewardReceiverOneOf, type context$2_ReferralRewardRewardTypeOptionsOneOf as ReferralRewardRewardTypeOptionsOneOf, type ReferredFriendDetails$1 as ReferredFriendDetails, type context$2_Reward as Reward, type context$2_RewardOptionsOneOf as RewardOptionsOneOf, context$2_RewardTypeType as RewardTypeType, type context$2_RewardsInSite as RewardsInSite, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Status$1 as Status, type SuccessfulReferralEvent$1 as SuccessfulReferralEvent, context$2_Type as Type, type
|
|
3274
|
+
export { type ActionEvent$2 as ActionEvent, type context$2_BulkGetReferralRewardsRequest as BulkGetReferralRewardsRequest, type context$2_BulkGetReferralRewardsResponse as BulkGetReferralRewardsResponse, type context$2_Coupon as Coupon, type context$2_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type context$2_CouponScope as CouponScope, type context$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, context$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 context$2_FixedAmountDiscount as FixedAmountDiscount, type context$2_GetReferralRewardRequest as GetReferralRewardRequest, type context$2_GetReferralRewardResponse as GetReferralRewardResponse, type context$2_GetReferralRewardResponseNonNullableFields as GetReferralRewardResponseNonNullableFields, type context$2_Group as Group, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type context$2_LoyaltyPoints as LoyaltyPoints, type MessageEnvelope$2 as MessageEnvelope, type context$2_PercentageDiscount as PercentageDiscount, type context$2_QueryReferralRewardsOptions as QueryReferralRewardsOptions, type context$2_QueryReferralRewardsRequest as QueryReferralRewardsRequest, type context$2_QueryReferralRewardsResponse as QueryReferralRewardsResponse, type context$2_QueryReferralRewardsResponseNonNullableFields as QueryReferralRewardsResponseNonNullableFields, type context$2_ReferralReward as ReferralReward, type context$2_ReferralRewardNonNullableFields as ReferralRewardNonNullableFields, type context$2_ReferralRewardReceiverOneOf as ReferralRewardReceiverOneOf, type context$2_ReferralRewardRewardTypeOptionsOneOf as ReferralRewardRewardTypeOptionsOneOf, type ReferredFriendDetails$1 as ReferredFriendDetails, type context$2_Reward as Reward, type context$2_RewardOptionsOneOf as RewardOptionsOneOf, context$2_RewardTypeType as RewardTypeType, type context$2_RewardsInSite as RewardsInSite, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Status$1 as Status, type SuccessfulReferralEvent$1 as SuccessfulReferralEvent, context$2_Type as Type, type context$2_UndeleteInfo as UndeleteInfo, type context$2_V1Coupon as V1Coupon, type context$2_V1LoyaltyPoints as V1LoyaltyPoints, type context$2_ValidateReferralRewardRequest as ValidateReferralRewardRequest, type context$2_ValidateReferralRewardResponse as ValidateReferralRewardResponse, WebhookIdentityType$2 as WebhookIdentityType, type context$2__publicGetReferralRewardType as _publicGetReferralRewardType, type context$2__publicQueryReferralRewardsType as _publicQueryReferralRewardsType, context$2_getReferralReward as getReferralReward, context$2_queryReferralRewards as queryReferralRewards };
|
|
3248
3275
|
}
|
|
3249
3276
|
|
|
3250
3277
|
interface ReferredFriend {
|
|
@@ -3460,7 +3487,7 @@ interface DomainEventBodyOneOf$1 {
|
|
|
3460
3487
|
interface EntityCreatedEvent$1 {
|
|
3461
3488
|
entity?: string;
|
|
3462
3489
|
}
|
|
3463
|
-
interface RestoreInfo {
|
|
3490
|
+
interface RestoreInfo$1 {
|
|
3464
3491
|
deletedDate?: Date;
|
|
3465
3492
|
}
|
|
3466
3493
|
interface EntityUpdatedEvent$1 {
|
|
@@ -3853,7 +3880,6 @@ type context$1_ReferredFriendNonNullableFields = ReferredFriendNonNullableFields
|
|
|
3853
3880
|
type context$1_ReferredFriendUpdatedEnvelope = ReferredFriendUpdatedEnvelope;
|
|
3854
3881
|
type context$1_ReferredFriendsQueryBuilder = ReferredFriendsQueryBuilder;
|
|
3855
3882
|
type context$1_ReferredFriendsQueryResult = ReferredFriendsQueryResult;
|
|
3856
|
-
type context$1_RestoreInfo = RestoreInfo;
|
|
3857
3883
|
type context$1_Status = Status;
|
|
3858
3884
|
declare const context$1_Status: typeof Status;
|
|
3859
3885
|
type context$1_SuccessfulReferralEvent = SuccessfulReferralEvent;
|
|
@@ -3880,61 +3906,64 @@ declare const context$1_onReferredFriendUpdated: typeof onReferredFriendUpdated;
|
|
|
3880
3906
|
declare const context$1_queryReferredFriend: typeof queryReferredFriend;
|
|
3881
3907
|
declare const context$1_updateReferredFriend: typeof updateReferredFriend;
|
|
3882
3908
|
declare namespace context$1 {
|
|
3883
|
-
export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type context$1_CreateReferredFriendOptions as CreateReferredFriendOptions, type context$1_CreateReferredFriendRequest as CreateReferredFriendRequest, type context$1_CreateReferredFriendResponse as CreateReferredFriendResponse, type context$1_CreateReferredFriendResponseNonNullableFields as CreateReferredFriendResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type context$1_DeleteReferredFriendOptions as DeleteReferredFriendOptions, type context$1_DeleteReferredFriendRequest as DeleteReferredFriendRequest, type context$1_DeleteReferredFriendResponse as DeleteReferredFriendResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type context$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type context$1_GetReferredFriendByContactIdRequest as GetReferredFriendByContactIdRequest, type context$1_GetReferredFriendByContactIdResponse as GetReferredFriendByContactIdResponse, type context$1_GetReferredFriendByContactIdResponseNonNullableFields as GetReferredFriendByContactIdResponseNonNullableFields, type context$1_GetReferredFriendRequest as GetReferredFriendRequest, type context$1_GetReferredFriendResponse as GetReferredFriendResponse, type context$1_GetReferredFriendResponseNonNullableFields as GetReferredFriendResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type context$1_QueryReferredFriendRequest as QueryReferredFriendRequest, type context$1_QueryReferredFriendResponse as QueryReferredFriendResponse, type context$1_QueryReferredFriendResponseNonNullableFields as QueryReferredFriendResponseNonNullableFields, type context$1_ReferredFriend as ReferredFriend, type context$1_ReferredFriendCreatedEnvelope as ReferredFriendCreatedEnvelope, type context$1_ReferredFriendDeletedEnvelope as ReferredFriendDeletedEnvelope, type context$1_ReferredFriendDetails as ReferredFriendDetails, type context$1_ReferredFriendNonNullableFields as ReferredFriendNonNullableFields, type context$1_ReferredFriendUpdatedEnvelope as ReferredFriendUpdatedEnvelope, type context$1_ReferredFriendsQueryBuilder as ReferredFriendsQueryBuilder, type context$1_ReferredFriendsQueryResult as ReferredFriendsQueryResult, type
|
|
3909
|
+
export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type context$1_CreateReferredFriendOptions as CreateReferredFriendOptions, type context$1_CreateReferredFriendRequest as CreateReferredFriendRequest, type context$1_CreateReferredFriendResponse as CreateReferredFriendResponse, type context$1_CreateReferredFriendResponseNonNullableFields as CreateReferredFriendResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type context$1_DeleteReferredFriendOptions as DeleteReferredFriendOptions, type context$1_DeleteReferredFriendRequest as DeleteReferredFriendRequest, type context$1_DeleteReferredFriendResponse as DeleteReferredFriendResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type context$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type context$1_GetReferredFriendByContactIdRequest as GetReferredFriendByContactIdRequest, type context$1_GetReferredFriendByContactIdResponse as GetReferredFriendByContactIdResponse, type context$1_GetReferredFriendByContactIdResponseNonNullableFields as GetReferredFriendByContactIdResponseNonNullableFields, type context$1_GetReferredFriendRequest as GetReferredFriendRequest, type context$1_GetReferredFriendResponse as GetReferredFriendResponse, type context$1_GetReferredFriendResponseNonNullableFields as GetReferredFriendResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type context$1_QueryReferredFriendRequest as QueryReferredFriendRequest, type context$1_QueryReferredFriendResponse as QueryReferredFriendResponse, type context$1_QueryReferredFriendResponseNonNullableFields as QueryReferredFriendResponseNonNullableFields, type context$1_ReferredFriend as ReferredFriend, type context$1_ReferredFriendCreatedEnvelope as ReferredFriendCreatedEnvelope, type context$1_ReferredFriendDeletedEnvelope as ReferredFriendDeletedEnvelope, type context$1_ReferredFriendDetails as ReferredFriendDetails, type context$1_ReferredFriendNonNullableFields as ReferredFriendNonNullableFields, type context$1_ReferredFriendUpdatedEnvelope as ReferredFriendUpdatedEnvelope, type context$1_ReferredFriendsQueryBuilder as ReferredFriendsQueryBuilder, type context$1_ReferredFriendsQueryResult as ReferredFriendsQueryResult, type RestoreInfo$1 as RestoreInfo, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, context$1_Status as Status, type context$1_SuccessfulReferralEvent as SuccessfulReferralEvent, type context$1_UpdateReferredFriend as UpdateReferredFriend, type context$1_UpdateReferredFriendRequest as UpdateReferredFriendRequest, type context$1_UpdateReferredFriendResponse as UpdateReferredFriendResponse, type context$1_UpdateReferredFriendResponseNonNullableFields as UpdateReferredFriendResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicCreateReferredFriendType as _publicCreateReferredFriendType, type context$1__publicDeleteReferredFriendType as _publicDeleteReferredFriendType, type context$1__publicGetReferredFriendByContactIdType as _publicGetReferredFriendByContactIdType, type context$1__publicGetReferredFriendType as _publicGetReferredFriendType, type context$1__publicOnReferredFriendCreatedType as _publicOnReferredFriendCreatedType, type context$1__publicOnReferredFriendDeletedType as _publicOnReferredFriendDeletedType, type context$1__publicOnReferredFriendUpdatedType as _publicOnReferredFriendUpdatedType, type context$1__publicQueryReferredFriendType as _publicQueryReferredFriendType, type context$1__publicUpdateReferredFriendType as _publicUpdateReferredFriendType, context$1_createReferredFriend as createReferredFriend, context$1_deleteReferredFriend as deleteReferredFriend, context$1_getReferredFriend as getReferredFriend, context$1_getReferredFriendByContactId as getReferredFriendByContactId, context$1_onReferredFriendCreated as onReferredFriendCreated, context$1_onReferredFriendDeleted as onReferredFriendDeleted, context$1_onReferredFriendUpdated as onReferredFriendUpdated, onReferredFriendCreated$1 as publicOnReferredFriendCreated, onReferredFriendDeleted$1 as publicOnReferredFriendDeleted, onReferredFriendUpdated$1 as publicOnReferredFriendUpdated, context$1_queryReferredFriend as queryReferredFriend, context$1_updateReferredFriend as updateReferredFriend };
|
|
3884
3910
|
}
|
|
3885
3911
|
|
|
3886
3912
|
/** ReferringCustomer is the main entity of ReferringCustomers. */
|
|
3887
3913
|
interface ReferringCustomer {
|
|
3888
3914
|
/**
|
|
3889
|
-
*
|
|
3915
|
+
* ID of the referring customer.
|
|
3890
3916
|
* @readonly
|
|
3891
3917
|
*/
|
|
3892
3918
|
_id?: string;
|
|
3893
3919
|
/**
|
|
3894
|
-
* Contact
|
|
3920
|
+
* Contact ID associated with the referring customer.
|
|
3895
3921
|
* @readonly
|
|
3896
3922
|
*/
|
|
3897
3923
|
contactId?: string;
|
|
3898
3924
|
/**
|
|
3899
|
-
*
|
|
3925
|
+
* Unique code for the referral. For example, `GxpxwAoMqxH8`.
|
|
3900
3926
|
* @readonly
|
|
3901
3927
|
*/
|
|
3902
3928
|
referralCode?: string;
|
|
3903
|
-
/**
|
|
3929
|
+
/**
|
|
3930
|
+
* Revision number, which increments by 1 each time the referring customer is updated.
|
|
3931
|
+
* To prevent conflicting changes, the current revision must be passed when updating the referring customer.
|
|
3932
|
+
*/
|
|
3904
3933
|
revision?: string | null;
|
|
3905
3934
|
/**
|
|
3906
|
-
*
|
|
3935
|
+
* Date and time the referring customer was created.
|
|
3907
3936
|
* @readonly
|
|
3908
3937
|
*/
|
|
3909
3938
|
_createdDate?: Date;
|
|
3910
3939
|
/**
|
|
3911
|
-
*
|
|
3940
|
+
* Date and time the referring customer was last updated.
|
|
3912
3941
|
* @readonly
|
|
3913
3942
|
*/
|
|
3914
3943
|
_updatedDate?: Date;
|
|
3915
3944
|
}
|
|
3916
3945
|
interface GenerateReferringCustomerForContactRequest {
|
|
3917
|
-
/** Contact
|
|
3946
|
+
/** Contact ID or `"me"` to generate the current identity's referring customer. */
|
|
3918
3947
|
contactId: string;
|
|
3919
3948
|
}
|
|
3920
3949
|
interface GenerateReferringCustomerForContactResponse {
|
|
3921
|
-
/**
|
|
3950
|
+
/** Created referring customer. */
|
|
3922
3951
|
referringCustomer?: ReferringCustomer;
|
|
3923
3952
|
}
|
|
3924
3953
|
interface GetReferringCustomerRequest {
|
|
3925
|
-
/**
|
|
3954
|
+
/** ID of the referring customer to retrieve. */
|
|
3926
3955
|
referringCustomerId: string;
|
|
3927
3956
|
}
|
|
3928
3957
|
interface GetReferringCustomerResponse {
|
|
3929
|
-
/**
|
|
3958
|
+
/** Retrieved referring customer. */
|
|
3930
3959
|
referringCustomer?: ReferringCustomer;
|
|
3931
3960
|
}
|
|
3932
3961
|
interface GetReferringCustomerByReferralCodeRequest {
|
|
3933
|
-
/** Referral
|
|
3962
|
+
/** Referral code of the referring customer to retrieve. */
|
|
3934
3963
|
referralCode: string;
|
|
3935
3964
|
}
|
|
3936
3965
|
interface GetReferringCustomerByReferralCodeResponse {
|
|
3937
|
-
/**
|
|
3966
|
+
/** Retrieved referring customer. */
|
|
3938
3967
|
referringCustomer?: ReferringCustomer;
|
|
3939
3968
|
}
|
|
3940
3969
|
interface QueryReferringCustomersRequest {
|
|
@@ -3942,26 +3971,32 @@ interface QueryReferringCustomersRequest {
|
|
|
3942
3971
|
query: CursorQuery;
|
|
3943
3972
|
}
|
|
3944
3973
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
3945
|
-
/**
|
|
3974
|
+
/**
|
|
3975
|
+
* Cursor paging options.
|
|
3976
|
+
*
|
|
3977
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
3978
|
+
*/
|
|
3946
3979
|
cursorPaging?: CursorPaging;
|
|
3947
3980
|
/**
|
|
3948
|
-
* Filter object
|
|
3949
|
-
*
|
|
3950
|
-
*
|
|
3951
|
-
* "fieldName2":{"$operator":"value2"}
|
|
3952
|
-
* }`
|
|
3953
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
3981
|
+
* Filter object.
|
|
3982
|
+
*
|
|
3983
|
+
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
3954
3984
|
*/
|
|
3955
3985
|
filter?: Record<string, any> | null;
|
|
3956
3986
|
/**
|
|
3957
|
-
* Sort object
|
|
3958
|
-
*
|
|
3987
|
+
* Sort object.
|
|
3988
|
+
*
|
|
3989
|
+
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
3959
3990
|
*/
|
|
3960
3991
|
sort?: Sorting[];
|
|
3961
3992
|
}
|
|
3962
3993
|
/** @oneof */
|
|
3963
3994
|
interface CursorQueryPagingMethodOneOf {
|
|
3964
|
-
/**
|
|
3995
|
+
/**
|
|
3996
|
+
* Cursor paging options.
|
|
3997
|
+
*
|
|
3998
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
3999
|
+
*/
|
|
3965
4000
|
cursorPaging?: CursorPaging;
|
|
3966
4001
|
}
|
|
3967
4002
|
interface Sorting {
|
|
@@ -3986,13 +4021,13 @@ interface CursorPaging {
|
|
|
3986
4021
|
cursor?: string | null;
|
|
3987
4022
|
}
|
|
3988
4023
|
interface QueryReferringCustomersResponse {
|
|
3989
|
-
/**
|
|
4024
|
+
/** List of retrieved referring customers. */
|
|
3990
4025
|
referringCustomers?: ReferringCustomer[];
|
|
3991
4026
|
/** Paging metadata. */
|
|
3992
4027
|
metadata?: CursorPagingMetadata;
|
|
3993
4028
|
}
|
|
3994
4029
|
interface CursorPagingMetadata {
|
|
3995
|
-
/** Number of items returned in
|
|
4030
|
+
/** Number of items returned in current page. */
|
|
3996
4031
|
count?: number | null;
|
|
3997
4032
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
3998
4033
|
cursors?: Cursors;
|
|
@@ -4011,9 +4046,9 @@ interface Cursors {
|
|
|
4011
4046
|
prev?: string | null;
|
|
4012
4047
|
}
|
|
4013
4048
|
interface DeleteReferringCustomerRequest {
|
|
4014
|
-
/**
|
|
4049
|
+
/** ID of the referring customer to delete. */
|
|
4015
4050
|
referringCustomerId: string;
|
|
4016
|
-
/**
|
|
4051
|
+
/** Revision number of the referring customer. */
|
|
4017
4052
|
revision?: string;
|
|
4018
4053
|
}
|
|
4019
4054
|
interface DeleteReferringCustomerResponse {
|
|
@@ -4041,7 +4076,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4041
4076
|
slug?: string;
|
|
4042
4077
|
/** ID of the entity associated with the event. */
|
|
4043
4078
|
entityId?: string;
|
|
4044
|
-
/** Event timestamp. */
|
|
4079
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
4045
4080
|
eventTime?: Date;
|
|
4046
4081
|
/**
|
|
4047
4082
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -4070,7 +4105,7 @@ interface DomainEventBodyOneOf {
|
|
|
4070
4105
|
interface EntityCreatedEvent {
|
|
4071
4106
|
entity?: string;
|
|
4072
4107
|
}
|
|
4073
|
-
interface
|
|
4108
|
+
interface RestoreInfo {
|
|
4074
4109
|
deletedDate?: Date;
|
|
4075
4110
|
}
|
|
4076
4111
|
interface EntityUpdatedEvent {
|
|
@@ -4172,7 +4207,7 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
4172
4207
|
slug?: string;
|
|
4173
4208
|
/** ID of the entity associated with the event. */
|
|
4174
4209
|
entityId?: string;
|
|
4175
|
-
/** Event timestamp. */
|
|
4210
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
4176
4211
|
eventTime?: Date;
|
|
4177
4212
|
/**
|
|
4178
4213
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -4276,53 +4311,61 @@ interface ReferringCustomersQueryBuilder {
|
|
|
4276
4311
|
find: () => Promise<ReferringCustomersQueryResult>;
|
|
4277
4312
|
}
|
|
4278
4313
|
interface DeleteReferringCustomerOptions {
|
|
4279
|
-
/**
|
|
4314
|
+
/** Revision number of the referring customer. */
|
|
4280
4315
|
revision?: string;
|
|
4281
4316
|
}
|
|
4282
4317
|
|
|
4283
4318
|
declare function generateReferringCustomerForContact$1(httpClient: HttpClient): GenerateReferringCustomerForContactSignature;
|
|
4284
4319
|
interface GenerateReferringCustomerForContactSignature {
|
|
4285
4320
|
/**
|
|
4286
|
-
* Creates a new or returns existing
|
|
4321
|
+
* Creates a new referring customer or returns an existing one for the provided contact ID.
|
|
4322
|
+
*
|
|
4323
|
+
* You can use "me" instead of a specific contact ID to generate a referring customer for the current identity's contact.
|
|
4287
4324
|
*
|
|
4288
|
-
*
|
|
4289
|
-
* @param - Contact
|
|
4325
|
+
* See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities) to learn more about identies.
|
|
4326
|
+
* @param - Contact ID or `"me"` to generate the current identity's referring customer.
|
|
4290
4327
|
*/
|
|
4291
4328
|
(contactId: string): Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
|
|
4292
4329
|
}
|
|
4293
4330
|
declare function getReferringCustomer$1(httpClient: HttpClient): GetReferringCustomerSignature;
|
|
4294
4331
|
interface GetReferringCustomerSignature {
|
|
4295
4332
|
/**
|
|
4296
|
-
*
|
|
4297
|
-
* @param -
|
|
4298
|
-
* @returns
|
|
4333
|
+
* Retrieves a referring customer by ID.
|
|
4334
|
+
* @param - ID of the referring customer to retrieve.
|
|
4335
|
+
* @returns Retrieved referring customer.
|
|
4299
4336
|
*/
|
|
4300
4337
|
(referringCustomerId: string): Promise<ReferringCustomer & ReferringCustomerNonNullableFields>;
|
|
4301
4338
|
}
|
|
4302
4339
|
declare function getReferringCustomerByReferralCode$1(httpClient: HttpClient): GetReferringCustomerByReferralCodeSignature;
|
|
4303
4340
|
interface GetReferringCustomerByReferralCodeSignature {
|
|
4304
4341
|
/**
|
|
4305
|
-
*
|
|
4306
|
-
* @param - Referral
|
|
4342
|
+
* Retrieves a referring customer by referral code.
|
|
4343
|
+
* @param - Referral code of the referring customer to retrieve.
|
|
4307
4344
|
*/
|
|
4308
4345
|
(referralCode: string): Promise<GetReferringCustomerByReferralCodeResponse & GetReferringCustomerByReferralCodeResponseNonNullableFields>;
|
|
4309
4346
|
}
|
|
4310
4347
|
declare function queryReferringCustomers$1(httpClient: HttpClient): QueryReferringCustomersSignature;
|
|
4311
4348
|
interface QueryReferringCustomersSignature {
|
|
4312
4349
|
/**
|
|
4313
|
-
*
|
|
4350
|
+
* Retrieves a list of referred friends, given the provided paging, filtering, and sorting.
|
|
4351
|
+
*
|
|
4352
|
+
* TODO: This endpoint supports [WQL (Wix Query Language)](https://dev.wix.com/api/rest/getting-started/api-query-language) with these properties:
|
|
4353
|
+
* `contact_id`, `referral_code`, `created_date`, `updated_date`.
|
|
4314
4354
|
*
|
|
4315
|
-
*
|
|
4355
|
+
* To learn about working with _Query_ endpoints, see
|
|
4356
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
4357
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
4358
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
4316
4359
|
*/
|
|
4317
4360
|
(): ReferringCustomersQueryBuilder;
|
|
4318
4361
|
}
|
|
4319
4362
|
declare function deleteReferringCustomer$1(httpClient: HttpClient): DeleteReferringCustomerSignature;
|
|
4320
4363
|
interface DeleteReferringCustomerSignature {
|
|
4321
4364
|
/**
|
|
4322
|
-
*
|
|
4365
|
+
* Deletes a referring customer by ID.
|
|
4323
4366
|
*
|
|
4324
|
-
* You must
|
|
4325
|
-
* @param -
|
|
4367
|
+
* You must provide the latest `revision` to prevent conflicting changes.
|
|
4368
|
+
* @param - ID of the referring customer to delete.
|
|
4326
4369
|
*/
|
|
4327
4370
|
(referringCustomerId: string, options?: DeleteReferringCustomerOptions | undefined): Promise<void>;
|
|
4328
4371
|
}
|
|
@@ -4389,10 +4432,10 @@ type context_ReferringCustomerDeletedEnvelope = ReferringCustomerDeletedEnvelope
|
|
|
4389
4432
|
type context_ReferringCustomerNonNullableFields = ReferringCustomerNonNullableFields;
|
|
4390
4433
|
type context_ReferringCustomersQueryBuilder = ReferringCustomersQueryBuilder;
|
|
4391
4434
|
type context_ReferringCustomersQueryResult = ReferringCustomersQueryResult;
|
|
4435
|
+
type context_RestoreInfo = RestoreInfo;
|
|
4392
4436
|
type context_SortOrder = SortOrder;
|
|
4393
4437
|
declare const context_SortOrder: typeof SortOrder;
|
|
4394
4438
|
type context_Sorting = Sorting;
|
|
4395
|
-
type context_UndeleteInfo = UndeleteInfo;
|
|
4396
4439
|
type context_WebhookIdentityType = WebhookIdentityType;
|
|
4397
4440
|
declare const context_WebhookIdentityType: typeof WebhookIdentityType;
|
|
4398
4441
|
type context__publicDeleteReferringCustomerType = _publicDeleteReferringCustomerType;
|
|
@@ -4410,7 +4453,7 @@ declare const context_onReferringCustomerCreated: typeof onReferringCustomerCrea
|
|
|
4410
4453
|
declare const context_onReferringCustomerDeleted: typeof onReferringCustomerDeleted;
|
|
4411
4454
|
declare const context_queryReferringCustomers: typeof queryReferringCustomers;
|
|
4412
4455
|
declare namespace context {
|
|
4413
|
-
export { type context_ActionEvent as ActionEvent, type context_BaseEventMetadata as BaseEventMetadata, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorQuery as CursorQuery, type context_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context_Cursors as Cursors, type context_DeleteReferringCustomerOptions as DeleteReferringCustomerOptions, type context_DeleteReferringCustomerRequest as DeleteReferringCustomerRequest, type context_DeleteReferringCustomerResponse as DeleteReferringCustomerResponse, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_GenerateReferringCustomerForContactRequest as GenerateReferringCustomerForContactRequest, type context_GenerateReferringCustomerForContactResponse as GenerateReferringCustomerForContactResponse, type context_GenerateReferringCustomerForContactResponseNonNullableFields as GenerateReferringCustomerForContactResponseNonNullableFields, type context_GetReferringCustomerByReferralCodeRequest as GetReferringCustomerByReferralCodeRequest, type context_GetReferringCustomerByReferralCodeResponse as GetReferringCustomerByReferralCodeResponse, type context_GetReferringCustomerByReferralCodeResponseNonNullableFields as GetReferringCustomerByReferralCodeResponseNonNullableFields, type context_GetReferringCustomerRequest as GetReferringCustomerRequest, type context_GetReferringCustomerResponse as GetReferringCustomerResponse, type context_GetReferringCustomerResponseNonNullableFields as GetReferringCustomerResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_MessageEnvelope as MessageEnvelope, type context_QueryReferringCustomersRequest as QueryReferringCustomersRequest, type context_QueryReferringCustomersResponse as QueryReferringCustomersResponse, type context_QueryReferringCustomersResponseNonNullableFields as QueryReferringCustomersResponseNonNullableFields, type context_ReferringCustomer as ReferringCustomer, type context_ReferringCustomerCreatedEnvelope as ReferringCustomerCreatedEnvelope, type context_ReferringCustomerDeletedEnvelope as ReferringCustomerDeletedEnvelope, type context_ReferringCustomerNonNullableFields as ReferringCustomerNonNullableFields, type context_ReferringCustomersQueryBuilder as ReferringCustomersQueryBuilder, type context_ReferringCustomersQueryResult as ReferringCustomersQueryResult,
|
|
4456
|
+
export { type context_ActionEvent as ActionEvent, type context_BaseEventMetadata as BaseEventMetadata, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorQuery as CursorQuery, type context_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context_Cursors as Cursors, type context_DeleteReferringCustomerOptions as DeleteReferringCustomerOptions, type context_DeleteReferringCustomerRequest as DeleteReferringCustomerRequest, type context_DeleteReferringCustomerResponse as DeleteReferringCustomerResponse, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_GenerateReferringCustomerForContactRequest as GenerateReferringCustomerForContactRequest, type context_GenerateReferringCustomerForContactResponse as GenerateReferringCustomerForContactResponse, type context_GenerateReferringCustomerForContactResponseNonNullableFields as GenerateReferringCustomerForContactResponseNonNullableFields, type context_GetReferringCustomerByReferralCodeRequest as GetReferringCustomerByReferralCodeRequest, type context_GetReferringCustomerByReferralCodeResponse as GetReferringCustomerByReferralCodeResponse, type context_GetReferringCustomerByReferralCodeResponseNonNullableFields as GetReferringCustomerByReferralCodeResponseNonNullableFields, type context_GetReferringCustomerRequest as GetReferringCustomerRequest, type context_GetReferringCustomerResponse as GetReferringCustomerResponse, type context_GetReferringCustomerResponseNonNullableFields as GetReferringCustomerResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_MessageEnvelope as MessageEnvelope, type context_QueryReferringCustomersRequest as QueryReferringCustomersRequest, type context_QueryReferringCustomersResponse as QueryReferringCustomersResponse, type context_QueryReferringCustomersResponseNonNullableFields as QueryReferringCustomersResponseNonNullableFields, type context_ReferringCustomer as ReferringCustomer, type context_ReferringCustomerCreatedEnvelope as ReferringCustomerCreatedEnvelope, type context_ReferringCustomerDeletedEnvelope as ReferringCustomerDeletedEnvelope, type context_ReferringCustomerNonNullableFields as ReferringCustomerNonNullableFields, type context_ReferringCustomersQueryBuilder as ReferringCustomersQueryBuilder, type context_ReferringCustomersQueryResult as ReferringCustomersQueryResult, type context_RestoreInfo as RestoreInfo, context_SortOrder as SortOrder, type context_Sorting as Sorting, context_WebhookIdentityType as WebhookIdentityType, type context__publicDeleteReferringCustomerType as _publicDeleteReferringCustomerType, type context__publicGenerateReferringCustomerForContactType as _publicGenerateReferringCustomerForContactType, type context__publicGetReferringCustomerByReferralCodeType as _publicGetReferringCustomerByReferralCodeType, type context__publicGetReferringCustomerType as _publicGetReferringCustomerType, type context__publicOnReferringCustomerCreatedType as _publicOnReferringCustomerCreatedType, type context__publicOnReferringCustomerDeletedType as _publicOnReferringCustomerDeletedType, type context__publicQueryReferringCustomersType as _publicQueryReferringCustomersType, context_deleteReferringCustomer as deleteReferringCustomer, context_generateReferringCustomerForContact as generateReferringCustomerForContact, context_getReferringCustomer as getReferringCustomer, context_getReferringCustomerByReferralCode as getReferringCustomerByReferralCode, context_onReferringCustomerCreated as onReferringCustomerCreated, context_onReferringCustomerDeleted as onReferringCustomerDeleted, onReferringCustomerCreated$1 as publicOnReferringCustomerCreated, onReferringCustomerDeleted$1 as publicOnReferringCustomerDeleted, context_queryReferringCustomers as queryReferringCustomers };
|
|
4414
4457
|
}
|
|
4415
4458
|
|
|
4416
4459
|
export { context as customers, context$1 as friends, context$4 as programs, context$2 as rewards, context$3 as tracker };
|