@wix/referral 1.0.10 → 1.0.12

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.
@@ -1,13 +1,57 @@
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
6
+ }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
28
+ __type: 'event-definition';
29
+ type: Type;
30
+ isDomainEvent?: boolean;
31
+ transformations?: (envelope: unknown) => Payload;
32
+ __payload: Payload;
33
+ };
34
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
37
+
38
+ declare global {
39
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
40
+ interface SymbolConstructor {
41
+ readonly observable: symbol;
42
+ }
43
+ }
44
+
1
45
  interface ReferralProgram {
2
46
  /** Referral program name. */
3
47
  name?: string | null;
4
48
  /**
5
- * The status of the referral program.
49
+ * The status of the referral program. Possible values:
6
50
  *
7
- * `UNKNOWN`: Status is unknown, this status is never used.
8
- * `DRAFT`: Rderral program is in a draft state, currently being modified, not yet active.
9
- * `ACTIVE`: Referral program is active.
10
- * `PAUSED`: Referral program is paused.
51
+ * - `UNKNOWN`: Status is unknown. This value is never used.
52
+ * - `DRAFT`: Referral program is in a draft state and is currently being modified. Not yet active.
53
+ * - `ACTIVE`: Referral program is active.
54
+ * - `PAUSED`: Referral program is paused.
11
55
  * @readonly
12
56
  */
13
57
  status?: ProgramStatus;
@@ -23,20 +67,27 @@ interface ReferralProgram {
23
67
  * @readonly
24
68
  */
25
69
  _updatedDate?: Date;
26
- /** Reward configuration for the referred friend. Specifies the reward given to a new customer who was referred to the business. */
70
+ /**
71
+ * Reward configuration for the referred friend.
72
+ * Specifies the reward given to a new customer who was referred to the business.
73
+ */
27
74
  referredFriendReward?: Reward$2;
28
- /** Reward configuration for the referring customer. Specifies the reward given to an existing customer who referred a new customer to the business. */
75
+ /**
76
+ * Reward configuration for the referring customer.
77
+ * Specifies the reward given to an existing customer who referred a new customer to the business.
78
+ */
29
79
  referringCustomerReward?: Reward$2;
30
80
  /**
31
81
  * A list of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an order.
32
82
  *
33
83
  * Possible values:
34
- * -`UNKNOWN`: Action is unknown.
35
- * -`STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
36
- * -`PLAN_ORDERED`: Referred friend ordered and paid for a plan.
37
- * -`TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
38
- * -`SESSION_BOOKED`: Referred friend booked and paid for a session.
39
- * -`RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
84
+ *
85
+ * - `UNKNOWN`: Action is unknown.
86
+ * - `STORE_ORDER_PLACED`: Referred friend ordered and paid for an order in a store.
87
+ * - `PLAN_ORDERED`: Referred friend ordered and paid for a plan.
88
+ * - `TICKET_ORDERED`: Referred friend ordered and paid for a ticket.
89
+ * - `SESSION_BOOKED`: Referred friend booked and paid for a session.
90
+ * - `RESTAURANT_ORDER_PLACED`: Referred friend placed and paid for a restaurant order.
40
91
  */
41
92
  successfulReferralActions?: Action[];
42
93
  /**
@@ -193,9 +244,11 @@ declare enum Action {
193
244
  }
194
245
  interface Emails {
195
246
  /**
196
- * Encourage customers to refer their friends email. Select for which apps to enable.
247
+ * Encourage customers to refer their friends via email. Select which apps to enable.
248
+ *
249
+ * Available apps:
197
250
  *
198
- * - `UNKNOWN`: Unknwown email.
251
+ * - `UNKNOWN`: Unknown email.
199
252
  * - `STORES`: Send an email to customers who've placed an order with stores.
200
253
  * - `PRICING_PLANS`: Send an email to customers who've placed an order with pricing plans.
201
254
  * - `EVENTS`: Send an email to customers who've placed an order with events.
@@ -230,19 +283,19 @@ interface PremiumFeatures {
230
283
  interface GetReferralProgramRequest {
231
284
  }
232
285
  interface GetReferralProgramResponse {
233
- /** The retrieved referral program. */
286
+ /** Retrieved referral program. */
234
287
  referralProgram?: ReferralProgram;
235
288
  }
236
289
  interface BulkGetReferralProgramRequest {
237
290
  }
238
291
  interface BulkGetReferralProgramResponse {
239
- /** The retrieved referral programs. */
292
+ /** Retrieved referral programs. */
240
293
  programInSites?: ProgramInSite[];
241
294
  }
242
295
  interface ProgramInSite {
243
296
  /** Metasite ID. */
244
297
  metaSiteId?: string;
245
- /** The retrieved referral program. */
298
+ /** Retrieved referral program. */
246
299
  referralProgram?: ReferralProgram;
247
300
  }
248
301
  interface QueryReferralProgramsRequest {
@@ -300,7 +353,7 @@ interface CursorPaging$4 {
300
353
  cursor?: string | null;
301
354
  }
302
355
  interface QueryReferralProgramsResponse {
303
- /** The referral programs that match the query. */
356
+ /** Referral programs matching the query. */
304
357
  referralPrograms?: ReferralProgram[];
305
358
  /** Paging metadata. */
306
359
  pagingMetadata?: CursorPagingMetadata$4;
@@ -325,33 +378,33 @@ interface Cursors$4 {
325
378
  prev?: string | null;
326
379
  }
327
380
  interface UpdateReferralProgramRequest {
328
- /** Provide a `ReferralProgram` object with the fields to update. Include the latest `revision` for a successful update. */
381
+ /** Referral program to update. Include the latest `revision` for a successful update. */
329
382
  referralProgram: ReferralProgram;
330
383
  }
331
384
  interface UpdateReferralProgramResponse {
332
- /** The updated referral program. */
385
+ /** Updated referral program. */
333
386
  referralProgram?: ReferralProgram;
334
387
  }
335
388
  interface ActivateReferralProgramRequest {
336
389
  }
337
390
  interface ActivateReferralProgramResponse {
338
- /** The activated referral program. */
391
+ /** Activated referral program. */
339
392
  referralProgram?: ReferralProgram;
340
393
  }
341
394
  interface PauseReferralProgramRequest {
342
395
  }
343
396
  interface PauseReferralProgramResponse {
344
- /** The paused referral program. */
397
+ /** Paused referral program. */
345
398
  referralProgram?: ReferralProgram;
346
399
  }
347
400
  interface GetAISocialMediaPostsSuggestionsRequest {
348
- /** The topic to generate socia media post suggestions for. */
401
+ /** Topic to generate social media post suggestions for. */
349
402
  topic?: string;
350
403
  }
351
404
  interface GetAISocialMediaPostsSuggestionsResponse {
352
- /** The generated social media post suggestions. */
405
+ /** Generated social media post suggestions. */
353
406
  suggestions?: AISocialMediaPostSuggestion[];
354
- /** The referral URL to refer friends. */
407
+ /** Referral URL to refer friends. */
355
408
  referFriendsPageUrl?: string | null;
356
409
  }
357
410
  interface AISocialMediaPostSuggestion {
@@ -361,7 +414,7 @@ interface AISocialMediaPostSuggestion {
361
414
  hashtags?: string[];
362
415
  }
363
416
  interface GenerateAISocialMediaPostsSuggestionsRequest {
364
- /** The topic to generate social media post suggestions for. */
417
+ /** Topic to generate social media post suggestions for. */
365
418
  topic?: string;
366
419
  }
367
420
  interface GenerateAISocialMediaPostsSuggestionsResponse {
@@ -431,7 +484,7 @@ interface DomainEventBodyOneOf$4 {
431
484
  interface EntityCreatedEvent$4 {
432
485
  entity?: string;
433
486
  }
434
- interface RestoreInfo$1 {
487
+ interface RestoreInfo$2 {
435
488
  deletedDate?: Date;
436
489
  }
437
490
  interface EntityUpdatedEvent$4 {
@@ -1466,66 +1519,80 @@ interface ReferralProgramsQueryBuilder {
1466
1519
  find: () => Promise<ReferralProgramsQueryResult>;
1467
1520
  }
1468
1521
  interface GetAiSocialMediaPostsSuggestionsOptions {
1469
- /** The topic to generate socia media post suggestions for. */
1522
+ /** Topic to generate social media post suggestions for. */
1470
1523
  topic?: string;
1471
1524
  }
1472
1525
  interface GenerateAiSocialMediaPostsSuggestionsOptions {
1473
- /** The topic to generate social media post suggestions for. */
1526
+ /** Topic to generate social media post suggestions for. */
1474
1527
  topic?: string;
1475
1528
  }
1476
1529
 
1477
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
1478
- interface HttpClient {
1479
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
1480
- fetchWithAuth: typeof fetch;
1481
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
1530
+ declare function getReferralProgram$1(httpClient: HttpClient): GetReferralProgramSignature;
1531
+ interface GetReferralProgramSignature {
1532
+ /**
1533
+ * Retrieves the referral program.
1534
+ */
1535
+ (): Promise<GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields>;
1482
1536
  }
1483
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
1484
- type HttpResponse<T = any> = {
1485
- data: T;
1486
- status: number;
1487
- statusText: string;
1488
- headers: any;
1489
- request?: any;
1490
- };
1491
- type RequestOptions<_TResponse = any, Data = any> = {
1492
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
1493
- url: string;
1494
- data?: Data;
1495
- params?: URLSearchParams;
1496
- } & APIMetadata;
1497
- type APIMetadata = {
1498
- methodFqn?: string;
1499
- entityFqdn?: string;
1500
- packageName?: string;
1501
- };
1502
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
1503
- type EventDefinition<Payload = unknown, Type extends string = string> = {
1504
- __type: 'event-definition';
1505
- type: Type;
1506
- isDomainEvent?: boolean;
1507
- transformations?: (envelope: unknown) => Payload;
1508
- __payload: Payload;
1509
- };
1510
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
1511
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
1512
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
1513
-
1514
- declare global {
1515
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
1516
- interface SymbolConstructor {
1517
- readonly observable: symbol;
1518
- }
1537
+ declare function queryReferralPrograms$1(httpClient: HttpClient): QueryReferralProgramsSignature;
1538
+ interface QueryReferralProgramsSignature {
1539
+ /**
1540
+ * Retrieves a list of referral programs, given the provided paging, filtering, and sorting.
1541
+ *
1542
+ * To learn about working with _Query_ endpoints, see
1543
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
1544
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
1545
+ * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
1546
+ * @deprecated
1547
+ */
1548
+ (): ReferralProgramsQueryBuilder;
1549
+ }
1550
+ declare function updateReferralProgram$1(httpClient: HttpClient): UpdateReferralProgramSignature;
1551
+ interface UpdateReferralProgramSignature {
1552
+ /**
1553
+ * Updates a referral program. Supports partial updates.
1554
+ *
1555
+ * Revision number, which increments by 1 each time the referral program is updated.
1556
+ * To prevent conflicting changes, the current revision must be passed when updating the referral program.
1557
+ * @param - Referral program to update. Include the latest `revision` for a successful update.
1558
+ */
1559
+ (referralProgram: ReferralProgram): Promise<UpdateReferralProgramResponse & UpdateReferralProgramResponseNonNullableFields>;
1560
+ }
1561
+ declare function activateReferralProgram$1(httpClient: HttpClient): ActivateReferralProgramSignature;
1562
+ interface ActivateReferralProgramSignature {
1563
+ /**
1564
+ * Activates the referral program, changing its status to `ACTIVE`.
1565
+ */
1566
+ (): Promise<ActivateReferralProgramResponse & ActivateReferralProgramResponseNonNullableFields>;
1567
+ }
1568
+ declare function pauseReferralProgram$1(httpClient: HttpClient): PauseReferralProgramSignature;
1569
+ interface PauseReferralProgramSignature {
1570
+ /**
1571
+ * Pauses the referral program, changing its status to `PAUSED`.
1572
+ */
1573
+ (): Promise<PauseReferralProgramResponse & PauseReferralProgramResponseNonNullableFields>;
1574
+ }
1575
+ declare function getAiSocialMediaPostsSuggestions$1(httpClient: HttpClient): GetAiSocialMediaPostsSuggestionsSignature;
1576
+ interface GetAiSocialMediaPostsSuggestionsSignature {
1577
+ /**
1578
+ * Retrieves pre-generated social media post suggestions for promoting the referral program.
1579
+ */
1580
+ (options?: GetAiSocialMediaPostsSuggestionsOptions | undefined): Promise<GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields>;
1581
+ }
1582
+ declare function generateAiSocialMediaPostsSuggestions$1(httpClient: HttpClient): GenerateAiSocialMediaPostsSuggestionsSignature;
1583
+ interface GenerateAiSocialMediaPostsSuggestionsSignature {
1584
+ /**
1585
+ * Creates new AI-generated social media post suggestions for promoting the referral program.
1586
+ */
1587
+ (options?: GenerateAiSocialMediaPostsSuggestionsOptions | undefined): Promise<GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields>;
1588
+ }
1589
+ declare function getReferralProgramPremiumFeatures$1(httpClient: HttpClient): GetReferralProgramPremiumFeaturesSignature;
1590
+ interface GetReferralProgramPremiumFeaturesSignature {
1591
+ /**
1592
+ * Retrieves information about enabled premium features for the referral program.
1593
+ */
1594
+ (): Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
1519
1595
  }
1520
-
1521
- declare function getReferralProgram$1(httpClient: HttpClient): () => Promise<GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields>;
1522
- declare function queryReferralPrograms$1(httpClient: HttpClient): () => ReferralProgramsQueryBuilder;
1523
- declare function updateReferralProgram$1(httpClient: HttpClient): (referralProgram: ReferralProgram) => Promise<UpdateReferralProgramResponse & UpdateReferralProgramResponseNonNullableFields>;
1524
- declare function activateReferralProgram$1(httpClient: HttpClient): () => Promise<ActivateReferralProgramResponse & ActivateReferralProgramResponseNonNullableFields>;
1525
- declare function pauseReferralProgram$1(httpClient: HttpClient): () => Promise<PauseReferralProgramResponse & PauseReferralProgramResponseNonNullableFields>;
1526
- declare function getAiSocialMediaPostsSuggestions$1(httpClient: HttpClient): (options?: GetAiSocialMediaPostsSuggestionsOptions) => Promise<GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields>;
1527
- declare function generateAiSocialMediaPostsSuggestions$1(httpClient: HttpClient): (options?: GenerateAiSocialMediaPostsSuggestionsOptions) => Promise<GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields>;
1528
- declare function getReferralProgramPremiumFeatures$1(httpClient: HttpClient): () => Promise<GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields>;
1529
1596
  declare const onProgramUpdated$1: EventDefinition<ProgramUpdatedEnvelope, "wix.loyalty.referral.v1.program_updated">;
1530
1597
 
1531
1598
  declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -1550,6 +1617,7 @@ type _publicGetReferralProgramPremiumFeaturesType = typeof getReferralProgramPre
1550
1617
  declare const getReferralProgramPremiumFeatures: ReturnType<typeof createRESTModule$4<_publicGetReferralProgramPremiumFeaturesType>>;
1551
1618
 
1552
1619
  type _publicOnProgramUpdatedType = typeof onProgramUpdated$1;
1620
+ /** */
1553
1621
  declare const onProgramUpdated: ReturnType<typeof createEventModule$3<_publicOnProgramUpdatedType>>;
1554
1622
 
1555
1623
  type context$4_AISocialMediaPostSuggestion = AISocialMediaPostSuggestion;
@@ -1684,10 +1752,9 @@ declare const context$4_pauseReferralProgram: typeof pauseReferralProgram;
1684
1752
  declare const context$4_queryReferralPrograms: typeof queryReferralPrograms;
1685
1753
  declare const context$4_updateReferralProgram: typeof updateReferralProgram;
1686
1754
  declare namespace context$4 {
1687
- 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$1 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 };
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$2 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 };
1688
1756
  }
1689
1757
 
1690
- /** ReferralEvent. */
1691
1758
  interface ReferralEvent extends ReferralEventEventTypeOneOf {
1692
1759
  /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
1693
1760
  referredFriendSignupEvent?: ReferredFriendSignupEvent;
@@ -2010,34 +2077,41 @@ interface ReferredFriendActionRewardTypeOptionsOneOf {
2010
2077
  }
2011
2078
  interface V1Coupon$1 {
2012
2079
  /**
2013
- * Coupon ID.
2080
+ * Coupon ID. Example: `8934b045-7052-4a90-be2b-832c70afc9da`.
2014
2081
  * @readonly
2015
2082
  */
2016
2083
  _id?: string;
2017
2084
  /**
2018
- * Coupon code.
2085
+ * The code that customers can use to apply the coupon. Example: `6RFD2A3HSPXW`.
2019
2086
  * @readonly
2020
2087
  */
2021
2088
  code?: string;
2022
2089
  /**
2023
- * Coupon status.
2090
+ * Current status of the coupon.
2091
+ *
2092
+ * Possible values:
2093
+ *
2094
+ * - `UNKNOWN`: Unknown coupon status.
2095
+ * - `ACTIVE`: Coupon is active and can be applied.
2096
+ * - `APPLIED`: Coupon was already applied and can't be used anymore.
2097
+ * - `DELETED`: Coupon was deleted.
2024
2098
  * @readonly
2025
2099
  */
2026
2100
  status?: Status$2;
2027
2101
  /**
2028
- * Coupon specification.
2102
+ * Detailed specifications of the coupon.
2029
2103
  * @readonly
2030
2104
  */
2031
2105
  couponSpecification?: Coupon$1;
2032
2106
  }
2033
2107
  declare enum Status$2 {
2034
- /** Unknown coupon status. */
2108
+ /** The coupon status is unknown or not specified. */
2035
2109
  UNKNOWN = "UNKNOWN",
2036
- /** Coupon is active and can be applied. */
2110
+ /** The coupon is active and can be applied to purchases. */
2037
2111
  ACTIVE = "ACTIVE",
2038
- /** Coupon was already applied and can not be used anymore. */
2112
+ /** The coupon has been applied and can't be used again. */
2039
2113
  APPLIED = "APPLIED",
2040
- /** Coupon was deleted. */
2114
+ /** The coupon has been deleted and is no longer valid. */
2041
2115
  DELETED = "DELETED"
2042
2116
  }
2043
2117
  interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
@@ -2130,7 +2204,7 @@ interface LoyaltyPoints$1 {
2130
2204
  */
2131
2205
  transactionId?: string;
2132
2206
  /**
2133
- * Loyalty points amount given.
2207
+ * The number of loyalty points awarded.
2134
2208
  * @readonly
2135
2209
  */
2136
2210
  amount?: number;
@@ -2187,7 +2261,7 @@ interface DomainEventBodyOneOf$3 {
2187
2261
  interface EntityCreatedEvent$3 {
2188
2262
  entity?: string;
2189
2263
  }
2190
- interface RestoreInfo {
2264
+ interface RestoreInfo$1 {
2191
2265
  deletedDate?: Date;
2192
2266
  }
2193
2267
  interface EntityUpdatedEvent$3 {
@@ -2208,42 +2282,42 @@ interface ActionEvent$3 {
2208
2282
  interface Empty$2 {
2209
2283
  }
2210
2284
  interface SuccessfulReferralEvent$2 {
2211
- /** ReferredFriend that completed his referral details. */
2285
+ /** Details of the referred friend who completed their referral. */
2212
2286
  referredFriendDetails?: ReferredFriendDetails$2;
2213
2287
  }
2214
2288
  interface ReferredFriendDetails$2 {
2215
2289
  /**
2216
- * ReferredFriend ID.
2290
+ * ID of the referred friend.
2217
2291
  * @readonly
2218
2292
  */
2219
2293
  referredFriendId?: string;
2220
2294
  /**
2221
- * ReferredFriend Contact ID.
2295
+ * Contact ID of the referred friend.
2222
2296
  * @readonly
2223
2297
  */
2224
2298
  contactId?: string;
2225
2299
  /**
2226
- * Customer who referred this ReferredFriend.
2300
+ * ID of the customer who referred this friend.
2227
2301
  * @readonly
2228
2302
  */
2229
2303
  referringCustomerId?: string;
2230
2304
  }
2231
2305
  interface ReferredFriendActionEvent {
2232
- /** ReferredFriend details. */
2306
+ /** Details of the referred friend. */
2233
2307
  referredFriendDetails?: ReferredFriendDetails$2;
2234
- /** Trigger details. */
2308
+ /** Details of the trigger. */
2235
2309
  trigger?: Trigger;
2236
- /** Amount. */
2310
+ /** Amount of the referral reward. */
2237
2311
  amount?: string | null;
2238
- /** Currency. */
2312
+ /** Currency of the referral reward. */
2239
2313
  currency?: string | null;
2240
- /** Order ID. */
2314
+ /** ID of the order associated with the referral. */
2241
2315
  orderId?: string | null;
2242
2316
  }
2243
2317
  interface Trigger {
2244
- /** App ID. */
2318
+ /** ID of the app associated with the referral activity. */
2245
2319
  appId?: string;
2246
- /** Activity type. */
2320
+ /** Type of referral activity. */
2247
2321
  activityType?: string;
2248
2322
  }
2249
2323
  interface MessageEnvelope$3 {
@@ -2514,11 +2588,43 @@ interface QueryReferredFriendActionsOptions {
2514
2588
  contactIds?: string[];
2515
2589
  }
2516
2590
 
2517
- declare function getReferralEvent$1(httpClient: HttpClient): (referralEventId: string) => Promise<ReferralEvent & ReferralEventNonNullableFields>;
2518
- declare function queryReferralEvent$1(httpClient: HttpClient): () => ReferralEventsQueryBuilder;
2519
- declare function getReferralStatistics$1(httpClient: HttpClient): () => Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
2520
- declare function queryReferringCustomerTotals$1(httpClient: HttpClient): (options?: QueryReferringCustomerTotalsOptions) => Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
2521
- declare function queryReferredFriendActions$1(httpClient: HttpClient): (options?: QueryReferredFriendActionsOptions) => Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
2591
+ declare function getReferralEvent$1(httpClient: HttpClient): GetReferralEventSignature;
2592
+ interface GetReferralEventSignature {
2593
+ /**
2594
+ * Get a ReferralEvent by id.
2595
+ * @param - Id of the ReferralEvent to retrieve
2596
+ * @returns The retrieved ReferralEvent
2597
+ */
2598
+ (referralEventId: string): Promise<ReferralEvent & ReferralEventNonNullableFields>;
2599
+ }
2600
+ declare function queryReferralEvent$1(httpClient: HttpClient): QueryReferralEventSignature;
2601
+ interface QueryReferralEventSignature {
2602
+ /**
2603
+ * Query ReferralEvents
2604
+ */
2605
+ (): ReferralEventsQueryBuilder;
2606
+ }
2607
+ declare function getReferralStatistics$1(httpClient: HttpClient): GetReferralStatisticsSignature;
2608
+ interface GetReferralStatisticsSignature {
2609
+ /**
2610
+ * Get referral statistics.
2611
+ */
2612
+ (): Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
2613
+ }
2614
+ declare function queryReferringCustomerTotals$1(httpClient: HttpClient): QueryReferringCustomerTotalsSignature;
2615
+ interface QueryReferringCustomerTotalsSignature {
2616
+ /**
2617
+ * Query referring customer totals.
2618
+ */
2619
+ (options?: QueryReferringCustomerTotalsOptions | undefined): Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
2620
+ }
2621
+ declare function queryReferredFriendActions$1(httpClient: HttpClient): QueryReferredFriendActionsSignature;
2622
+ interface QueryReferredFriendActionsSignature {
2623
+ /**
2624
+ * Query referred friend actions.
2625
+ */
2626
+ (options?: QueryReferredFriendActionsOptions | undefined): Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
2627
+ }
2522
2628
  declare const onReferralEventCreated$1: EventDefinition<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
2523
2629
 
2524
2630
  declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
@@ -2537,6 +2643,7 @@ type _publicQueryReferredFriendActionsType = typeof queryReferredFriendActions$1
2537
2643
  declare const queryReferredFriendActions: ReturnType<typeof createRESTModule$3<_publicQueryReferredFriendActionsType>>;
2538
2644
 
2539
2645
  type _publicOnReferralEventCreatedType = typeof onReferralEventCreated$1;
2646
+ /** */
2540
2647
  declare const onReferralEventCreated: ReturnType<typeof createEventModule$2<_publicOnReferralEventCreatedType>>;
2541
2648
 
2542
2649
  type context$3_CreateReferralEventRequest = CreateReferralEventRequest;
@@ -2569,7 +2676,6 @@ type context$3_ReferredFriendActionEvent = ReferredFriendActionEvent;
2569
2676
  type context$3_ReferredFriendActionRewardTypeOptionsOneOf = ReferredFriendActionRewardTypeOptionsOneOf;
2570
2677
  type context$3_ReferredFriendSignupEvent = ReferredFriendSignupEvent;
2571
2678
  type context$3_ReferringCustomerTotal = ReferringCustomerTotal;
2572
- type context$3_RestoreInfo = RestoreInfo;
2573
2679
  type context$3_RewardEvent = RewardEvent;
2574
2680
  type context$3_RewardEventReceiverOneOf = RewardEventReceiverOneOf;
2575
2681
  type context$3_Trigger = Trigger;
@@ -2589,7 +2695,7 @@ declare const context$3_queryReferralEvent: typeof queryReferralEvent;
2589
2695
  declare const context$3_queryReferredFriendActions: typeof queryReferredFriendActions;
2590
2696
  declare const context$3_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
2591
2697
  declare namespace context$3 {
2592
- 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 context$3_RestoreInfo 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 };
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$1 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 };
2593
2699
  }
2594
2700
 
2595
2701
  /** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
@@ -2941,7 +3047,7 @@ interface DomainEventBodyOneOf$2 {
2941
3047
  interface EntityCreatedEvent$2 {
2942
3048
  entity?: string;
2943
3049
  }
2944
- interface UndeleteInfo$2 {
3050
+ interface UndeleteInfo$1 {
2945
3051
  deletedDate?: Date;
2946
3052
  }
2947
3053
  interface EntityUpdatedEvent$2 {
@@ -3071,8 +3177,26 @@ interface QueryReferralRewardsOptions {
3071
3177
  contactId?: string | null;
3072
3178
  }
3073
3179
 
3074
- declare function getReferralReward$1(httpClient: HttpClient): (_id: string) => Promise<ReferralReward & ReferralRewardNonNullableFields>;
3075
- declare function queryReferralRewards$1(httpClient: HttpClient): (query: CursorQuery$2, options?: QueryReferralRewardsOptions) => Promise<QueryReferralRewardsResponse & QueryReferralRewardsResponseNonNullableFields>;
3180
+ declare function getReferralReward$1(httpClient: HttpClient): GetReferralRewardSignature;
3181
+ interface GetReferralRewardSignature {
3182
+ /**
3183
+ * Get a ReferralReward by id.
3184
+ * @param - Id of the ReferralReward to retrieve.
3185
+ * @returns The retrieved ReferralReward.
3186
+ */
3187
+ (_id: string): Promise<ReferralReward & ReferralRewardNonNullableFields>;
3188
+ }
3189
+ declare function queryReferralRewards$1(httpClient: HttpClient): QueryReferralRewardsSignature;
3190
+ interface QueryReferralRewardsSignature {
3191
+ /**
3192
+ * Query ReferralRewards.
3193
+ *
3194
+ * Can be filtered by `contact_id`. If it's set to `me` current identity's rewards are returned.
3195
+ * Supports filtering on `owner_type`, `reward_type` fields.
3196
+ * @param - Query to filter ReferralRewards.
3197
+ */
3198
+ (query: CursorQuery$2, options?: QueryReferralRewardsOptions | undefined): Promise<QueryReferralRewardsResponse & QueryReferralRewardsResponseNonNullableFields>;
3199
+ }
3076
3200
 
3077
3201
  declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
3078
3202
 
@@ -3120,10 +3244,9 @@ type context$2__publicQueryReferralRewardsType = _publicQueryReferralRewardsType
3120
3244
  declare const context$2_getReferralReward: typeof getReferralReward;
3121
3245
  declare const context$2_queryReferralRewards: typeof queryReferralRewards;
3122
3246
  declare namespace context$2 {
3123
- 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 UndeleteInfo$2 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 };
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 UndeleteInfo$1 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 };
3124
3248
  }
3125
3249
 
3126
- /** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
3127
3250
  interface ReferredFriend {
3128
3251
  /**
3129
3252
  * ReferredFriend ID.
@@ -3167,6 +3290,8 @@ declare enum Status {
3167
3290
  ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
3168
3291
  }
3169
3292
  interface CreateReferredFriendRequest {
3293
+ /** Referral code for referred friend */
3294
+ referralCode?: string | null;
3170
3295
  }
3171
3296
  interface CreateReferredFriendResponse {
3172
3297
  /** The created ReferredFriend. */
@@ -3209,26 +3334,32 @@ interface QueryReferredFriendRequest {
3209
3334
  query: CursorQuery$1;
3210
3335
  }
3211
3336
  interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
3212
- /** 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`. */
3337
+ /**
3338
+ * Cursor paging options.
3339
+ *
3340
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3341
+ */
3213
3342
  cursorPaging?: CursorPaging$1;
3214
3343
  /**
3215
- * Filter object in the following format:
3216
- * `"filter" : {
3217
- * "fieldName1": "value1",
3218
- * "fieldName2":{"$operator":"value2"}
3219
- * }`
3220
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3344
+ * Filter object.
3345
+ *
3346
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3221
3347
  */
3222
3348
  filter?: Record<string, any> | null;
3223
3349
  /**
3224
- * Sort object in the following format:
3225
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
3350
+ * Sort object.
3351
+ *
3352
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3226
3353
  */
3227
3354
  sort?: Sorting$1[];
3228
3355
  }
3229
3356
  /** @oneof */
3230
3357
  interface CursorQueryPagingMethodOneOf$1 {
3231
- /** 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`. */
3358
+ /**
3359
+ * Cursor paging options.
3360
+ *
3361
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
3362
+ */
3232
3363
  cursorPaging?: CursorPaging$1;
3233
3364
  }
3234
3365
  interface Sorting$1 {
@@ -3259,7 +3390,7 @@ interface QueryReferredFriendResponse {
3259
3390
  metadata?: CursorPagingMetadata$1;
3260
3391
  }
3261
3392
  interface CursorPagingMetadata$1 {
3262
- /** Number of items returned in the response. */
3393
+ /** Number of items returned in current page. */
3263
3394
  count?: number | null;
3264
3395
  /** Cursor strings that point to the next page, previous page, or both. */
3265
3396
  cursors?: Cursors$1;
@@ -3300,7 +3431,7 @@ interface DomainEvent$1 extends DomainEventBodyOneOf$1 {
3300
3431
  slug?: string;
3301
3432
  /** ID of the entity associated with the event. */
3302
3433
  entityId?: string;
3303
- /** Event timestamp. */
3434
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3304
3435
  eventTime?: Date;
3305
3436
  /**
3306
3437
  * Whether the event was triggered as a result of a privacy regulation application
@@ -3329,7 +3460,7 @@ interface DomainEventBodyOneOf$1 {
3329
3460
  interface EntityCreatedEvent$1 {
3330
3461
  entity?: string;
3331
3462
  }
3332
- interface UndeleteInfo$1 {
3463
+ interface RestoreInfo {
3333
3464
  deletedDate?: Date;
3334
3465
  }
3335
3466
  interface EntityUpdatedEvent$1 {
@@ -3350,22 +3481,22 @@ interface ActionEvent$1 {
3350
3481
  interface Empty {
3351
3482
  }
3352
3483
  interface SuccessfulReferralEvent {
3353
- /** ReferredFriend that completed his referral details. */
3484
+ /** Details of the referred friend who completed their referral. */
3354
3485
  referredFriendDetails?: ReferredFriendDetails;
3355
3486
  }
3356
3487
  interface ReferredFriendDetails {
3357
3488
  /**
3358
- * ReferredFriend ID.
3489
+ * ID of the referred friend.
3359
3490
  * @readonly
3360
3491
  */
3361
3492
  referredFriendId?: string;
3362
3493
  /**
3363
- * ReferredFriend Contact ID.
3494
+ * Contact ID of the referred friend.
3364
3495
  * @readonly
3365
3496
  */
3366
3497
  contactId?: string;
3367
3498
  /**
3368
- * Customer who referred this ReferredFriend.
3499
+ * ID of the customer who referred this friend.
3369
3500
  * @readonly
3370
3501
  */
3371
3502
  referringCustomerId?: string;
@@ -3458,7 +3589,7 @@ interface EventMetadata$1 extends BaseEventMetadata$1 {
3458
3589
  slug?: string;
3459
3590
  /** ID of the entity associated with the event. */
3460
3591
  entityId?: string;
3461
- /** Event timestamp. */
3592
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3462
3593
  eventTime?: Date;
3463
3594
  /**
3464
3595
  * Whether the event was triggered as a result of a privacy regulation application
@@ -3488,6 +3619,10 @@ interface ReferredFriendUpdatedEnvelope {
3488
3619
  interface ReferredFriendDeletedEnvelope {
3489
3620
  metadata: EventMetadata$1;
3490
3621
  }
3622
+ interface CreateReferredFriendOptions {
3623
+ /** Referral code for referred friend */
3624
+ referralCode?: string | null;
3625
+ }
3491
3626
  interface UpdateReferredFriend {
3492
3627
  /**
3493
3628
  * ReferredFriend ID.
@@ -3604,12 +3739,62 @@ interface ReferredFriendsQueryBuilder {
3604
3739
  find: () => Promise<ReferredFriendsQueryResult>;
3605
3740
  }
3606
3741
 
3607
- declare function createReferredFriend$1(httpClient: HttpClient): () => Promise<CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields>;
3608
- declare function getReferredFriend$1(httpClient: HttpClient): (referredFriendId: string) => Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
3609
- declare function getReferredFriendByContactId$1(httpClient: HttpClient): (contactId: string) => Promise<ReferredFriend & ReferredFriendNonNullableFields>;
3610
- declare function updateReferredFriend$1(httpClient: HttpClient): (_id: string, referredFriend: UpdateReferredFriend) => Promise<ReferredFriend & ReferredFriendNonNullableFields>;
3611
- declare function deleteReferredFriend$1(httpClient: HttpClient): (referredFriendId: string, options?: DeleteReferredFriendOptions) => Promise<void>;
3612
- declare function queryReferredFriend$1(httpClient: HttpClient): () => ReferredFriendsQueryBuilder;
3742
+ declare function createReferredFriend$1(httpClient: HttpClient): CreateReferredFriendSignature;
3743
+ interface CreateReferredFriendSignature {
3744
+ /**
3745
+ * Try to create the ReferredFriend or return existing entity if it already exists.
3746
+ *
3747
+ * Must be called with member identity.
3748
+ * Referral code must be provided either in the request or via scope.
3749
+ * Member must be eligible to become referred friend.
3750
+ */
3751
+ (options?: CreateReferredFriendOptions | undefined): Promise<CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields>;
3752
+ }
3753
+ declare function getReferredFriend$1(httpClient: HttpClient): GetReferredFriendSignature;
3754
+ interface GetReferredFriendSignature {
3755
+ /**
3756
+ * Get a ReferredFriend by id.
3757
+ * @param - Id of the ReferredFriend to retrieve.
3758
+ */
3759
+ (referredFriendId: string): Promise<GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields>;
3760
+ }
3761
+ declare function getReferredFriendByContactId$1(httpClient: HttpClient): GetReferredFriendByContactIdSignature;
3762
+ interface GetReferredFriendByContactIdSignature {
3763
+ /**
3764
+ * Get a ReferredFriend by contactId.
3765
+ *
3766
+ * You can provide "me" instead of specific contact id to get referring friend for current identity's contact.
3767
+ * @param - Contact id or "me" to get current identity's Contact.
3768
+ * @returns The retrieved ReferredFriend.
3769
+ */
3770
+ (contactId: string): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
3771
+ }
3772
+ declare function updateReferredFriend$1(httpClient: HttpClient): UpdateReferredFriendSignature;
3773
+ interface UpdateReferredFriendSignature {
3774
+ /**
3775
+ * Update a ReferredFriend, supports partial update.
3776
+ *
3777
+ * Pass the latest `revision` for a successful update.
3778
+ * @param - ReferredFriend ID.
3779
+ * @returns The updated ReferredFriend.
3780
+ */
3781
+ (_id: string, referredFriend: UpdateReferredFriend): Promise<ReferredFriend & ReferredFriendNonNullableFields>;
3782
+ }
3783
+ declare function deleteReferredFriend$1(httpClient: HttpClient): DeleteReferredFriendSignature;
3784
+ interface DeleteReferredFriendSignature {
3785
+ /**
3786
+ * Delete a ReferredFriend.
3787
+ * @param - Id of the ReferredFriend to delete.
3788
+ */
3789
+ (referredFriendId: string, options?: DeleteReferredFriendOptions | undefined): Promise<void>;
3790
+ }
3791
+ declare function queryReferredFriend$1(httpClient: HttpClient): QueryReferredFriendSignature;
3792
+ interface QueryReferredFriendSignature {
3793
+ /**
3794
+ * Query ReferredFriends using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
3795
+ */
3796
+ (): ReferredFriendsQueryBuilder;
3797
+ }
3613
3798
  declare const onReferredFriendCreated$1: EventDefinition<ReferredFriendCreatedEnvelope, "wix.loyalty.referral.v1.referred_friend_created">;
3614
3799
  declare const onReferredFriendUpdated$1: EventDefinition<ReferredFriendUpdatedEnvelope, "wix.loyalty.referral.v1.referred_friend_updated">;
3615
3800
  declare const onReferredFriendDeleted$1: EventDefinition<ReferredFriendDeletedEnvelope, "wix.loyalty.referral.v1.referred_friend_deleted">;
@@ -3632,14 +3817,18 @@ type _publicQueryReferredFriendType = typeof queryReferredFriend$1;
3632
3817
  declare const queryReferredFriend: ReturnType<typeof createRESTModule$1<_publicQueryReferredFriendType>>;
3633
3818
 
3634
3819
  type _publicOnReferredFriendCreatedType = typeof onReferredFriendCreated$1;
3820
+ /** */
3635
3821
  declare const onReferredFriendCreated: ReturnType<typeof createEventModule$1<_publicOnReferredFriendCreatedType>>;
3636
3822
 
3637
3823
  type _publicOnReferredFriendUpdatedType = typeof onReferredFriendUpdated$1;
3824
+ /** */
3638
3825
  declare const onReferredFriendUpdated: ReturnType<typeof createEventModule$1<_publicOnReferredFriendUpdatedType>>;
3639
3826
 
3640
3827
  type _publicOnReferredFriendDeletedType = typeof onReferredFriendDeleted$1;
3828
+ /** */
3641
3829
  declare const onReferredFriendDeleted: ReturnType<typeof createEventModule$1<_publicOnReferredFriendDeletedType>>;
3642
3830
 
3831
+ type context$1_CreateReferredFriendOptions = CreateReferredFriendOptions;
3643
3832
  type context$1_CreateReferredFriendRequest = CreateReferredFriendRequest;
3644
3833
  type context$1_CreateReferredFriendResponse = CreateReferredFriendResponse;
3645
3834
  type context$1_CreateReferredFriendResponseNonNullableFields = CreateReferredFriendResponseNonNullableFields;
@@ -3664,6 +3853,7 @@ type context$1_ReferredFriendNonNullableFields = ReferredFriendNonNullableFields
3664
3853
  type context$1_ReferredFriendUpdatedEnvelope = ReferredFriendUpdatedEnvelope;
3665
3854
  type context$1_ReferredFriendsQueryBuilder = ReferredFriendsQueryBuilder;
3666
3855
  type context$1_ReferredFriendsQueryResult = ReferredFriendsQueryResult;
3856
+ type context$1_RestoreInfo = RestoreInfo;
3667
3857
  type context$1_Status = Status;
3668
3858
  declare const context$1_Status: typeof Status;
3669
3859
  type context$1_SuccessfulReferralEvent = SuccessfulReferralEvent;
@@ -3690,7 +3880,7 @@ declare const context$1_onReferredFriendUpdated: typeof onReferredFriendUpdated;
3690
3880
  declare const context$1_queryReferredFriend: typeof queryReferredFriend;
3691
3881
  declare const context$1_updateReferredFriend: typeof updateReferredFriend;
3692
3882
  declare namespace context$1 {
3693
- export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, 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, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, context$1_Status as Status, type context$1_SuccessfulReferralEvent as SuccessfulReferralEvent, type UndeleteInfo$1 as UndeleteInfo, 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 };
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 context$1_RestoreInfo 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 };
3694
3884
  }
3695
3885
 
3696
3886
  /** ReferringCustomer is the main entity of ReferringCustomers. */
@@ -4090,11 +4280,52 @@ interface DeleteReferringCustomerOptions {
4090
4280
  revision?: string;
4091
4281
  }
4092
4282
 
4093
- declare function generateReferringCustomerForContact$1(httpClient: HttpClient): (contactId: string) => Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
4094
- declare function getReferringCustomer$1(httpClient: HttpClient): (referringCustomerId: string) => Promise<ReferringCustomer & ReferringCustomerNonNullableFields>;
4095
- declare function getReferringCustomerByReferralCode$1(httpClient: HttpClient): (referralCode: string) => Promise<GetReferringCustomerByReferralCodeResponse & GetReferringCustomerByReferralCodeResponseNonNullableFields>;
4096
- declare function queryReferringCustomers$1(httpClient: HttpClient): () => ReferringCustomersQueryBuilder;
4097
- declare function deleteReferringCustomer$1(httpClient: HttpClient): (referringCustomerId: string, options?: DeleteReferringCustomerOptions) => Promise<void>;
4283
+ declare function generateReferringCustomerForContact$1(httpClient: HttpClient): GenerateReferringCustomerForContactSignature;
4284
+ interface GenerateReferringCustomerForContactSignature {
4285
+ /**
4286
+ * Creates a new or returns existing ReferringCustomer for provided contact id.
4287
+ *
4288
+ * You can provide "me" instead of specific contact id to generate referring customer for current identity's contact.
4289
+ * @param - Contact id or "me" to generate current identity's referring customer.
4290
+ */
4291
+ (contactId: string): Promise<GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields>;
4292
+ }
4293
+ declare function getReferringCustomer$1(httpClient: HttpClient): GetReferringCustomerSignature;
4294
+ interface GetReferringCustomerSignature {
4295
+ /**
4296
+ * Get a ReferringCustomer by id.
4297
+ * @param - Id of the ReferringCustomer to retrieve.
4298
+ * @returns The retrieved ReferringCustomer.
4299
+ */
4300
+ (referringCustomerId: string): Promise<ReferringCustomer & ReferringCustomerNonNullableFields>;
4301
+ }
4302
+ declare function getReferringCustomerByReferralCode$1(httpClient: HttpClient): GetReferringCustomerByReferralCodeSignature;
4303
+ interface GetReferringCustomerByReferralCodeSignature {
4304
+ /**
4305
+ * Get a ReferringCustomer by referral code.
4306
+ * @param - Referral Code of the ReferringCustomer to retrieve.
4307
+ */
4308
+ (referralCode: string): Promise<GetReferringCustomerByReferralCodeResponse & GetReferringCustomerByReferralCodeResponseNonNullableFields>;
4309
+ }
4310
+ declare function queryReferringCustomers$1(httpClient: HttpClient): QueryReferringCustomersSignature;
4311
+ interface QueryReferringCustomersSignature {
4312
+ /**
4313
+ * Query ReferredFriends using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
4314
+ *
4315
+ * Fields supported: `contact_id`, `referral_code`, `created_date`, `updated_date`.
4316
+ */
4317
+ (): ReferringCustomersQueryBuilder;
4318
+ }
4319
+ declare function deleteReferringCustomer$1(httpClient: HttpClient): DeleteReferringCustomerSignature;
4320
+ interface DeleteReferringCustomerSignature {
4321
+ /**
4322
+ * Delete ReferringCustomer by id.
4323
+ *
4324
+ * You must also provide `revision`.
4325
+ * @param - Id of the ReferringCustomer to delete.
4326
+ */
4327
+ (referringCustomerId: string, options?: DeleteReferringCustomerOptions | undefined): Promise<void>;
4328
+ }
4098
4329
  declare const onReferringCustomerCreated$1: EventDefinition<ReferringCustomerCreatedEnvelope, "wix.loyalty.referral.v1.referring_customer_created">;
4099
4330
  declare const onReferringCustomerDeleted$1: EventDefinition<ReferringCustomerDeletedEnvelope, "wix.loyalty.referral.v1.referring_customer_deleted">;
4100
4331
 
@@ -4114,9 +4345,11 @@ type _publicDeleteReferringCustomerType = typeof deleteReferringCustomer$1;
4114
4345
  declare const deleteReferringCustomer: ReturnType<typeof createRESTModule<_publicDeleteReferringCustomerType>>;
4115
4346
 
4116
4347
  type _publicOnReferringCustomerCreatedType = typeof onReferringCustomerCreated$1;
4348
+ /** */
4117
4349
  declare const onReferringCustomerCreated: ReturnType<typeof createEventModule<_publicOnReferringCustomerCreatedType>>;
4118
4350
 
4119
4351
  type _publicOnReferringCustomerDeletedType = typeof onReferringCustomerDeleted$1;
4352
+ /** */
4120
4353
  declare const onReferringCustomerDeleted: ReturnType<typeof createEventModule<_publicOnReferringCustomerDeletedType>>;
4121
4354
 
4122
4355
  type context_ActionEvent = ActionEvent;