@wix/referral 1.0.0 → 1.0.2

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.
@@ -116,11 +116,11 @@ interface GetReferralEventResponse$1 {
116
116
  }
117
117
  interface QueryReferralEventRequest$1 {
118
118
  /** Query to filter ReferralEvents. */
119
- query: CursorQuery$1;
119
+ query: CursorQuery$5;
120
120
  }
121
- interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
121
+ interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
122
122
  /** 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`. */
123
- cursorPaging?: CursorPaging$1;
123
+ cursorPaging?: CursorPaging$5;
124
124
  /**
125
125
  * Filter object in the following format:
126
126
  * `"filter" : {
@@ -134,24 +134,24 @@ interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
134
134
  * Sort object in the following format:
135
135
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
136
136
  */
137
- sort?: Sorting$1[];
137
+ sort?: Sorting$5[];
138
138
  }
139
139
  /** @oneof */
140
- interface CursorQueryPagingMethodOneOf$1 {
140
+ interface CursorQueryPagingMethodOneOf$5 {
141
141
  /** 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`. */
142
- cursorPaging?: CursorPaging$1;
142
+ cursorPaging?: CursorPaging$5;
143
143
  }
144
- interface Sorting$1 {
144
+ interface Sorting$5 {
145
145
  /** Name of the field to sort by. */
146
146
  fieldName?: string;
147
147
  /** Sort order. */
148
- order?: SortOrder$1;
148
+ order?: SortOrder$5;
149
149
  }
150
- declare enum SortOrder$1 {
150
+ declare enum SortOrder$5 {
151
151
  ASC = "ASC",
152
152
  DESC = "DESC"
153
153
  }
154
- interface CursorPaging$1 {
154
+ interface CursorPaging$5 {
155
155
  /** Maximum number of items to return in the results. */
156
156
  limit?: number | null;
157
157
  /**
@@ -166,13 +166,13 @@ interface QueryReferralEventResponse$1 {
166
166
  /** List of ReferralEvents that match the query. */
167
167
  referralEvents?: ReferralEvent$1[];
168
168
  /** Paging metadata. */
169
- metadata?: CursorPagingMetadata$1;
169
+ metadata?: CursorPagingMetadata$5;
170
170
  }
171
- interface CursorPagingMetadata$1 {
171
+ interface CursorPagingMetadata$5 {
172
172
  /** Number of items returned in the response. */
173
173
  count?: number | null;
174
174
  /** Cursor strings that point to the next page, previous page, or both. */
175
- cursors?: Cursors$1;
175
+ cursors?: Cursors$5;
176
176
  /**
177
177
  * Whether there are more pages to retrieve following the current page.
178
178
  *
@@ -181,7 +181,7 @@ interface CursorPagingMetadata$1 {
181
181
  */
182
182
  hasNext?: boolean | null;
183
183
  }
184
- interface Cursors$1 {
184
+ interface Cursors$5 {
185
185
  /** Cursor string pointing to the next page in the list of results. */
186
186
  next?: string | null;
187
187
  /** Cursor pointing to the previous page in the list of results. */
@@ -199,7 +199,7 @@ interface GetReferralStatisticsResponse$1 {
199
199
  }
200
200
  interface QueryReferringCustomerTotalsRequest$1 {
201
201
  /** Query to filter ReferringCustomerTotals. */
202
- query?: CursorQuery$1;
202
+ query?: CursorQuery$5;
203
203
  /** List of contact ids to filter ReferringCustomerTotals. */
204
204
  contactIds?: string[];
205
205
  }
@@ -207,7 +207,7 @@ interface QueryReferringCustomerTotalsResponse$1 {
207
207
  /** List of ReferringCustomerTotals that match the query. */
208
208
  referringCustomerTotals?: ReferringCustomerTotal$1[];
209
209
  /** Paging metadata. */
210
- metadata?: CursorPagingMetadata$1;
210
+ metadata?: CursorPagingMetadata$5;
211
211
  }
212
212
  interface ReferringCustomerTotal$1 {
213
213
  /**
@@ -248,7 +248,7 @@ interface ReferringCustomerTotal$1 {
248
248
  }
249
249
  interface QueryReferredFriendActionsRequest$1 {
250
250
  /** Query to filter ReferredFriendActions. */
251
- query?: CursorQuery$1;
251
+ query?: CursorQuery$5;
252
252
  /** List of contact ids to filter ReferredFriendActions. */
253
253
  contactIds?: string[];
254
254
  }
@@ -256,7 +256,7 @@ interface QueryReferredFriendActionsResponse$1 {
256
256
  /** List of ReferredFriendActions that match the query. */
257
257
  referredFriendActions?: ReferredFriendAction$1[];
258
258
  /** Paging metadata. */
259
- metadata?: CursorPagingMetadata$1;
259
+ metadata?: CursorPagingMetadata$5;
260
260
  }
261
261
  interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOneOf$1 {
262
262
  /** Coupon reward type options. */
@@ -307,33 +307,34 @@ interface ReferredFriendActionRewardTypeOptionsOneOf$1 {
307
307
  }
308
308
  interface V1Coupon$1 {
309
309
  /**
310
- * Coupon id
310
+ * Coupon ID.
311
311
  * @readonly
312
312
  */
313
313
  id?: string;
314
314
  /**
315
- * Coupon code
315
+ * Coupon code.
316
316
  * @readonly
317
317
  */
318
318
  code?: string;
319
319
  /**
320
- * Coupon status
320
+ * Coupon status.
321
321
  * @readonly
322
322
  */
323
- status?: Status$1;
323
+ status?: Status$3;
324
324
  /**
325
- * Coupon specification
325
+ * Coupon specification.
326
326
  * @readonly
327
327
  */
328
328
  couponSpecification?: Coupon$1;
329
329
  }
330
- declare enum Status$1 {
330
+ declare enum Status$3 {
331
+ /** Unknown coupon status. */
331
332
  UNKNOWN = "UNKNOWN",
332
- /** Coupon is active and can be applied */
333
+ /** Coupon is active and can be applied. */
333
334
  ACTIVE = "ACTIVE",
334
- /** Coupon was already applied and can not be used anymore */
335
+ /** Coupon was already applied and can not be used anymore. */
335
336
  APPLIED = "APPLIED",
336
- /** Coupon was deleted */
337
+ /** Coupon was deleted. */
337
338
  DELETED = "DELETED"
338
339
  }
339
340
  interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
@@ -396,12 +397,12 @@ interface Group$1 {
396
397
  }
397
398
  interface LoyaltyPoints$1 {
398
399
  /**
399
- * Loyalty transaction id
400
+ * Loyalty transaction ID.
400
401
  * @readonly
401
402
  */
402
403
  transactionId?: string;
403
404
  /**
404
- * Loyalty points amount given
405
+ * Loyalty points amount given.
405
406
  * @readonly
406
407
  */
407
408
  amount?: number;
@@ -475,7 +476,7 @@ interface QueryReferredFriendActionsResponseNonNullableFields$1 {
475
476
  coupon?: {
476
477
  id: string;
477
478
  code: string;
478
- status: Status$1;
479
+ status: Status$3;
479
480
  couponSpecification?: {
480
481
  fixedAmountOptions?: {
481
482
  amount: number;
@@ -628,11 +629,11 @@ interface GetReferralEventResponse {
628
629
  }
629
630
  interface QueryReferralEventRequest {
630
631
  /** Query to filter ReferralEvents. */
631
- query: CursorQuery;
632
+ query: CursorQuery$4;
632
633
  }
633
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
634
+ interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
634
635
  /** 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`. */
635
- cursorPaging?: CursorPaging;
636
+ cursorPaging?: CursorPaging$4;
636
637
  /**
637
638
  * Filter object in the following format:
638
639
  * `"filter" : {
@@ -646,24 +647,24 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
646
647
  * Sort object in the following format:
647
648
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
648
649
  */
649
- sort?: Sorting[];
650
+ sort?: Sorting$4[];
650
651
  }
651
652
  /** @oneof */
652
- interface CursorQueryPagingMethodOneOf {
653
+ interface CursorQueryPagingMethodOneOf$4 {
653
654
  /** 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`. */
654
- cursorPaging?: CursorPaging;
655
+ cursorPaging?: CursorPaging$4;
655
656
  }
656
- interface Sorting {
657
+ interface Sorting$4 {
657
658
  /** Name of the field to sort by. */
658
659
  fieldName?: string;
659
660
  /** Sort order. */
660
- order?: SortOrder;
661
+ order?: SortOrder$4;
661
662
  }
662
- declare enum SortOrder {
663
+ declare enum SortOrder$4 {
663
664
  ASC = "ASC",
664
665
  DESC = "DESC"
665
666
  }
666
- interface CursorPaging {
667
+ interface CursorPaging$4 {
667
668
  /** Maximum number of items to return in the results. */
668
669
  limit?: number | null;
669
670
  /**
@@ -678,13 +679,13 @@ interface QueryReferralEventResponse {
678
679
  /** List of ReferralEvents that match the query. */
679
680
  referralEvents?: ReferralEvent[];
680
681
  /** Paging metadata. */
681
- metadata?: CursorPagingMetadata;
682
+ metadata?: CursorPagingMetadata$4;
682
683
  }
683
- interface CursorPagingMetadata {
684
+ interface CursorPagingMetadata$4 {
684
685
  /** Number of items returned in the response. */
685
686
  count?: number | null;
686
687
  /** Cursor strings that point to the next page, previous page, or both. */
687
- cursors?: Cursors;
688
+ cursors?: Cursors$4;
688
689
  /**
689
690
  * Whether there are more pages to retrieve following the current page.
690
691
  *
@@ -693,7 +694,7 @@ interface CursorPagingMetadata {
693
694
  */
694
695
  hasNext?: boolean | null;
695
696
  }
696
- interface Cursors {
697
+ interface Cursors$4 {
697
698
  /** Cursor string pointing to the next page in the list of results. */
698
699
  next?: string | null;
699
700
  /** Cursor pointing to the previous page in the list of results. */
@@ -711,7 +712,7 @@ interface GetReferralStatisticsResponse {
711
712
  }
712
713
  interface QueryReferringCustomerTotalsRequest {
713
714
  /** Query to filter ReferringCustomerTotals. */
714
- query?: CursorQuery;
715
+ query?: CursorQuery$4;
715
716
  /** List of contact ids to filter ReferringCustomerTotals. */
716
717
  contactIds?: string[];
717
718
  }
@@ -719,7 +720,7 @@ interface QueryReferringCustomerTotalsResponse {
719
720
  /** List of ReferringCustomerTotals that match the query. */
720
721
  referringCustomerTotals?: ReferringCustomerTotal[];
721
722
  /** Paging metadata. */
722
- metadata?: CursorPagingMetadata;
723
+ metadata?: CursorPagingMetadata$4;
723
724
  }
724
725
  interface ReferringCustomerTotal {
725
726
  /**
@@ -760,7 +761,7 @@ interface ReferringCustomerTotal {
760
761
  }
761
762
  interface QueryReferredFriendActionsRequest {
762
763
  /** Query to filter ReferredFriendActions. */
763
- query?: CursorQuery;
764
+ query?: CursorQuery$4;
764
765
  /** List of contact ids to filter ReferredFriendActions. */
765
766
  contactIds?: string[];
766
767
  }
@@ -768,7 +769,7 @@ interface QueryReferredFriendActionsResponse {
768
769
  /** List of ReferredFriendActions that match the query. */
769
770
  referredFriendActions?: ReferredFriendAction[];
770
771
  /** Paging metadata. */
771
- metadata?: CursorPagingMetadata;
772
+ metadata?: CursorPagingMetadata$4;
772
773
  }
773
774
  interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
774
775
  /** Coupon reward type options. */
@@ -819,33 +820,34 @@ interface ReferredFriendActionRewardTypeOptionsOneOf {
819
820
  }
820
821
  interface V1Coupon {
821
822
  /**
822
- * Coupon id
823
+ * Coupon ID.
823
824
  * @readonly
824
825
  */
825
826
  _id?: string;
826
827
  /**
827
- * Coupon code
828
+ * Coupon code.
828
829
  * @readonly
829
830
  */
830
831
  code?: string;
831
832
  /**
832
- * Coupon status
833
+ * Coupon status.
833
834
  * @readonly
834
835
  */
835
- status?: Status;
836
+ status?: Status$2;
836
837
  /**
837
- * Coupon specification
838
+ * Coupon specification.
838
839
  * @readonly
839
840
  */
840
841
  couponSpecification?: Coupon;
841
842
  }
842
- declare enum Status {
843
+ declare enum Status$2 {
844
+ /** Unknown coupon status. */
843
845
  UNKNOWN = "UNKNOWN",
844
- /** Coupon is active and can be applied */
846
+ /** Coupon is active and can be applied. */
845
847
  ACTIVE = "ACTIVE",
846
- /** Coupon was already applied and can not be used anymore */
848
+ /** Coupon was already applied and can not be used anymore. */
847
849
  APPLIED = "APPLIED",
848
- /** Coupon was deleted */
850
+ /** Coupon was deleted. */
849
851
  DELETED = "DELETED"
850
852
  }
851
853
  interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
@@ -908,12 +910,12 @@ interface Group {
908
910
  }
909
911
  interface LoyaltyPoints {
910
912
  /**
911
- * Loyalty transaction id
913
+ * Loyalty transaction ID.
912
914
  * @readonly
913
915
  */
914
916
  transactionId?: string;
915
917
  /**
916
- * Loyalty points amount given
918
+ * Loyalty points amount given.
917
919
  * @readonly
918
920
  */
919
921
  amount?: number;
@@ -987,7 +989,7 @@ interface QueryReferredFriendActionsResponseNonNullableFields {
987
989
  coupon?: {
988
990
  _id: string;
989
991
  code: string;
990
- status: Status;
992
+ status: Status$2;
991
993
  couponSpecification?: {
992
994
  fixedAmountOptions?: {
993
995
  amount: number;
@@ -1022,7 +1024,7 @@ interface QueryReferredFriendActionsResponseNonNullableFields {
1022
1024
  }[];
1023
1025
  }
1024
1026
 
1025
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1027
+ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1026
1028
  getUrl: (context: any) => string;
1027
1029
  httpMethod: K;
1028
1030
  path: string;
@@ -1032,22 +1034,806 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1032
1034
  __responseType: Q;
1033
1035
  __originalResponseType: R;
1034
1036
  };
1035
- declare function getReferralEvent(): __PublicMethodMetaInfo<'GET', {
1037
+ declare function getReferralEvent(): __PublicMethodMetaInfo$2<'GET', {
1036
1038
  referralEventId: string;
1037
1039
  }, GetReferralEventRequest, GetReferralEventRequest$1, GetReferralEventResponse & GetReferralEventResponseNonNullableFields, GetReferralEventResponse$1 & GetReferralEventResponseNonNullableFields$1>;
1038
- declare function queryReferralEvent(): __PublicMethodMetaInfo<'POST', {}, QueryReferralEventRequest, QueryReferralEventRequest$1, QueryReferralEventResponse & QueryReferralEventResponseNonNullableFields, QueryReferralEventResponse$1 & QueryReferralEventResponseNonNullableFields$1>;
1039
- declare function getReferralStatistics(): __PublicMethodMetaInfo<'GET', {}, GetReferralStatisticsRequest, GetReferralStatisticsRequest$1, GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields, GetReferralStatisticsResponse$1 & GetReferralStatisticsResponseNonNullableFields$1>;
1040
- declare function queryReferringCustomerTotals(): __PublicMethodMetaInfo<'POST', {}, QueryReferringCustomerTotalsRequest, QueryReferringCustomerTotalsRequest$1, QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields, QueryReferringCustomerTotalsResponse$1 & QueryReferringCustomerTotalsResponseNonNullableFields$1>;
1041
- declare function queryReferredFriendActions(): __PublicMethodMetaInfo<'POST', {}, QueryReferredFriendActionsRequest, QueryReferredFriendActionsRequest$1, QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields, QueryReferredFriendActionsResponse$1 & QueryReferredFriendActionsResponseNonNullableFields$1>;
1040
+ declare function queryReferralEvent(): __PublicMethodMetaInfo$2<'POST', {}, QueryReferralEventRequest, QueryReferralEventRequest$1, QueryReferralEventResponse & QueryReferralEventResponseNonNullableFields, QueryReferralEventResponse$1 & QueryReferralEventResponseNonNullableFields$1>;
1041
+ declare function getReferralStatistics(): __PublicMethodMetaInfo$2<'GET', {}, GetReferralStatisticsRequest, GetReferralStatisticsRequest$1, GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields, GetReferralStatisticsResponse$1 & GetReferralStatisticsResponseNonNullableFields$1>;
1042
+ declare function queryReferringCustomerTotals(): __PublicMethodMetaInfo$2<'POST', {}, QueryReferringCustomerTotalsRequest, QueryReferringCustomerTotalsRequest$1, QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields, QueryReferringCustomerTotalsResponse$1 & QueryReferringCustomerTotalsResponseNonNullableFields$1>;
1043
+ declare function queryReferredFriendActions(): __PublicMethodMetaInfo$2<'POST', {}, QueryReferredFriendActionsRequest, QueryReferredFriendActionsRequest$1, QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields, QueryReferredFriendActionsResponse$1 & QueryReferredFriendActionsResponseNonNullableFields$1>;
1044
+
1045
+ declare const meta$2_getReferralEvent: typeof getReferralEvent;
1046
+ declare const meta$2_getReferralStatistics: typeof getReferralStatistics;
1047
+ declare const meta$2_queryReferralEvent: typeof queryReferralEvent;
1048
+ declare const meta$2_queryReferredFriendActions: typeof queryReferredFriendActions;
1049
+ declare const meta$2_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
1050
+ declare namespace meta$2 {
1051
+ export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_getReferralEvent as getReferralEvent, meta$2_getReferralStatistics as getReferralStatistics, meta$2_queryReferralEvent as queryReferralEvent, meta$2_queryReferredFriendActions as queryReferredFriendActions, meta$2_queryReferringCustomerTotals as queryReferringCustomerTotals };
1052
+ }
1053
+
1054
+ /** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
1055
+ interface ReferredFriend$1 {
1056
+ /**
1057
+ * ReferredFriend ID.
1058
+ * @readonly
1059
+ */
1060
+ id?: string;
1061
+ /**
1062
+ * ReferredFriend Contact ID.
1063
+ * @readonly
1064
+ */
1065
+ contactId?: string;
1066
+ /**
1067
+ * Customer who referred.
1068
+ * @readonly
1069
+ */
1070
+ referringCustomerId?: string;
1071
+ /** Status of the ReferredFriend. */
1072
+ status?: Status$1;
1073
+ /**
1074
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.
1075
+ * @readonly
1076
+ */
1077
+ revision?: string | null;
1078
+ /**
1079
+ * Represents the time this ReferredFriend was created.
1080
+ * @readonly
1081
+ */
1082
+ createdDate?: Date;
1083
+ /**
1084
+ * Represents the time this ReferredFriend was last updated.
1085
+ * @readonly
1086
+ */
1087
+ updatedDate?: Date;
1088
+ }
1089
+ declare enum Status$1 {
1090
+ /** Unknown status. */
1091
+ UNKNOWN = "UNKNOWN",
1092
+ /** Initial status, when Referred friend joins site as member. */
1093
+ SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
1094
+ /** After complete some actions (eg. Purchase Order), Action Completed Status is used. */
1095
+ ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
1096
+ }
1097
+ interface CreateReferredFriendRequest$1 {
1098
+ }
1099
+ interface CreateReferredFriendResponse$1 {
1100
+ /** The created ReferredFriend. */
1101
+ referredFriend?: ReferredFriend$1;
1102
+ }
1103
+ interface GetReferredFriendRequest$1 {
1104
+ /** Id of the ReferredFriend to retrieve. */
1105
+ referredFriendId: string;
1106
+ }
1107
+ interface GetReferredFriendResponse$1 {
1108
+ /** The retrieved ReferredFriend. */
1109
+ referredFriend?: ReferredFriend$1;
1110
+ }
1111
+ interface GetReferredFriendByContactIdRequest$1 {
1112
+ /** Contact id or "me" to get current identity's Contact. */
1113
+ contactId: string;
1114
+ }
1115
+ interface GetReferredFriendByContactIdResponse$1 {
1116
+ /** The retrieved ReferredFriend. */
1117
+ referredFriend?: ReferredFriend$1;
1118
+ }
1119
+ interface UpdateReferredFriendRequest$1 {
1120
+ /** ReferredFriend to be updated, may be partial. */
1121
+ referredFriend: ReferredFriend$1;
1122
+ }
1123
+ interface UpdateReferredFriendResponse$1 {
1124
+ /** The updated ReferredFriend. */
1125
+ referredFriend?: ReferredFriend$1;
1126
+ }
1127
+ interface DeleteReferredFriendRequest$1 {
1128
+ /** Id of the ReferredFriend to delete. */
1129
+ referredFriendId: string;
1130
+ /** The revision of the ReferredFriend. */
1131
+ revision?: string;
1132
+ }
1133
+ interface DeleteReferredFriendResponse$1 {
1134
+ }
1135
+ interface QueryReferredFriendRequest$1 {
1136
+ /** Query options. */
1137
+ query: CursorQuery$3;
1138
+ }
1139
+ interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
1140
+ /** 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`. */
1141
+ cursorPaging?: CursorPaging$3;
1142
+ /**
1143
+ * Filter object in the following format:
1144
+ * `"filter" : {
1145
+ * "fieldName1": "value1",
1146
+ * "fieldName2":{"$operator":"value2"}
1147
+ * }`
1148
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1149
+ */
1150
+ filter?: Record<string, any> | null;
1151
+ /**
1152
+ * Sort object in the following format:
1153
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1154
+ */
1155
+ sort?: Sorting$3[];
1156
+ }
1157
+ /** @oneof */
1158
+ interface CursorQueryPagingMethodOneOf$3 {
1159
+ /** 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`. */
1160
+ cursorPaging?: CursorPaging$3;
1161
+ }
1162
+ interface Sorting$3 {
1163
+ /** Name of the field to sort by. */
1164
+ fieldName?: string;
1165
+ /** Sort order. */
1166
+ order?: SortOrder$3;
1167
+ }
1168
+ declare enum SortOrder$3 {
1169
+ ASC = "ASC",
1170
+ DESC = "DESC"
1171
+ }
1172
+ interface CursorPaging$3 {
1173
+ /** Maximum number of items to return in the results. */
1174
+ limit?: number | null;
1175
+ /**
1176
+ * Pointer to the next or previous page in the list of results.
1177
+ *
1178
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1179
+ * Not relevant for the first request.
1180
+ */
1181
+ cursor?: string | null;
1182
+ }
1183
+ interface QueryReferredFriendResponse$1 {
1184
+ /** The retrieved ReferredFriends. */
1185
+ referredFriends?: ReferredFriend$1[];
1186
+ /** CursorPagingMetadata. */
1187
+ metadata?: CursorPagingMetadata$3;
1188
+ }
1189
+ interface CursorPagingMetadata$3 {
1190
+ /** Number of items returned in the response. */
1191
+ count?: number | null;
1192
+ /** Cursor strings that point to the next page, previous page, or both. */
1193
+ cursors?: Cursors$3;
1194
+ /**
1195
+ * Whether there are more pages to retrieve following the current page.
1196
+ *
1197
+ * + `true`: Another page of results can be retrieved.
1198
+ * + `false`: This is the last page.
1199
+ */
1200
+ hasNext?: boolean | null;
1201
+ }
1202
+ interface Cursors$3 {
1203
+ /** Cursor string pointing to the next page in the list of results. */
1204
+ next?: string | null;
1205
+ /** Cursor pointing to the previous page in the list of results. */
1206
+ prev?: string | null;
1207
+ }
1208
+ interface CreateReferredFriendResponseNonNullableFields$1 {
1209
+ referredFriend?: {
1210
+ id: string;
1211
+ contactId: string;
1212
+ referringCustomerId: string;
1213
+ status: Status$1;
1214
+ };
1215
+ }
1216
+ interface GetReferredFriendResponseNonNullableFields$1 {
1217
+ referredFriend?: {
1218
+ id: string;
1219
+ contactId: string;
1220
+ referringCustomerId: string;
1221
+ status: Status$1;
1222
+ };
1223
+ }
1224
+ interface GetReferredFriendByContactIdResponseNonNullableFields$1 {
1225
+ referredFriend?: {
1226
+ id: string;
1227
+ contactId: string;
1228
+ referringCustomerId: string;
1229
+ status: Status$1;
1230
+ };
1231
+ }
1232
+ interface UpdateReferredFriendResponseNonNullableFields$1 {
1233
+ referredFriend?: {
1234
+ id: string;
1235
+ contactId: string;
1236
+ referringCustomerId: string;
1237
+ status: Status$1;
1238
+ };
1239
+ }
1240
+ interface QueryReferredFriendResponseNonNullableFields$1 {
1241
+ referredFriends: {
1242
+ id: string;
1243
+ contactId: string;
1244
+ referringCustomerId: string;
1245
+ status: Status$1;
1246
+ }[];
1247
+ }
1248
+
1249
+ /** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
1250
+ interface ReferredFriend {
1251
+ /**
1252
+ * ReferredFriend ID.
1253
+ * @readonly
1254
+ */
1255
+ _id?: string;
1256
+ /**
1257
+ * ReferredFriend Contact ID.
1258
+ * @readonly
1259
+ */
1260
+ contactId?: string;
1261
+ /**
1262
+ * Customer who referred.
1263
+ * @readonly
1264
+ */
1265
+ referringCustomerId?: string;
1266
+ /** Status of the ReferredFriend. */
1267
+ status?: Status;
1268
+ /**
1269
+ * Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision.
1270
+ * @readonly
1271
+ */
1272
+ revision?: string | null;
1273
+ /**
1274
+ * Represents the time this ReferredFriend was created.
1275
+ * @readonly
1276
+ */
1277
+ _createdDate?: Date;
1278
+ /**
1279
+ * Represents the time this ReferredFriend was last updated.
1280
+ * @readonly
1281
+ */
1282
+ _updatedDate?: Date;
1283
+ }
1284
+ declare enum Status {
1285
+ /** Unknown status. */
1286
+ UNKNOWN = "UNKNOWN",
1287
+ /** Initial status, when Referred friend joins site as member. */
1288
+ SIGN_UP_COMPLETED = "SIGN_UP_COMPLETED",
1289
+ /** After complete some actions (eg. Purchase Order), Action Completed Status is used. */
1290
+ ACTIONS_COMPLETED = "ACTIONS_COMPLETED"
1291
+ }
1292
+ interface CreateReferredFriendRequest {
1293
+ }
1294
+ interface CreateReferredFriendResponse {
1295
+ /** The created ReferredFriend. */
1296
+ referredFriend?: ReferredFriend;
1297
+ }
1298
+ interface GetReferredFriendRequest {
1299
+ /** Id of the ReferredFriend to retrieve. */
1300
+ referredFriendId: string;
1301
+ }
1302
+ interface GetReferredFriendResponse {
1303
+ /** The retrieved ReferredFriend. */
1304
+ referredFriend?: ReferredFriend;
1305
+ }
1306
+ interface GetReferredFriendByContactIdRequest {
1307
+ /** Contact id or "me" to get current identity's Contact. */
1308
+ contactId: string;
1309
+ }
1310
+ interface GetReferredFriendByContactIdResponse {
1311
+ /** The retrieved ReferredFriend. */
1312
+ referredFriend?: ReferredFriend;
1313
+ }
1314
+ interface UpdateReferredFriendRequest {
1315
+ /** ReferredFriend to be updated, may be partial. */
1316
+ referredFriend: ReferredFriend;
1317
+ }
1318
+ interface UpdateReferredFriendResponse {
1319
+ /** The updated ReferredFriend. */
1320
+ referredFriend?: ReferredFriend;
1321
+ }
1322
+ interface DeleteReferredFriendRequest {
1323
+ /** Id of the ReferredFriend to delete. */
1324
+ referredFriendId: string;
1325
+ /** The revision of the ReferredFriend. */
1326
+ revision?: string;
1327
+ }
1328
+ interface DeleteReferredFriendResponse {
1329
+ }
1330
+ interface QueryReferredFriendRequest {
1331
+ /** Query options. */
1332
+ query: CursorQuery$2;
1333
+ }
1334
+ interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
1335
+ /** 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`. */
1336
+ cursorPaging?: CursorPaging$2;
1337
+ /**
1338
+ * Filter object in the following format:
1339
+ * `"filter" : {
1340
+ * "fieldName1": "value1",
1341
+ * "fieldName2":{"$operator":"value2"}
1342
+ * }`
1343
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1344
+ */
1345
+ filter?: Record<string, any> | null;
1346
+ /**
1347
+ * Sort object in the following format:
1348
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1349
+ */
1350
+ sort?: Sorting$2[];
1351
+ }
1352
+ /** @oneof */
1353
+ interface CursorQueryPagingMethodOneOf$2 {
1354
+ /** 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`. */
1355
+ cursorPaging?: CursorPaging$2;
1356
+ }
1357
+ interface Sorting$2 {
1358
+ /** Name of the field to sort by. */
1359
+ fieldName?: string;
1360
+ /** Sort order. */
1361
+ order?: SortOrder$2;
1362
+ }
1363
+ declare enum SortOrder$2 {
1364
+ ASC = "ASC",
1365
+ DESC = "DESC"
1366
+ }
1367
+ interface CursorPaging$2 {
1368
+ /** Maximum number of items to return in the results. */
1369
+ limit?: number | null;
1370
+ /**
1371
+ * Pointer to the next or previous page in the list of results.
1372
+ *
1373
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1374
+ * Not relevant for the first request.
1375
+ */
1376
+ cursor?: string | null;
1377
+ }
1378
+ interface QueryReferredFriendResponse {
1379
+ /** The retrieved ReferredFriends. */
1380
+ referredFriends?: ReferredFriend[];
1381
+ /** CursorPagingMetadata. */
1382
+ metadata?: CursorPagingMetadata$2;
1383
+ }
1384
+ interface CursorPagingMetadata$2 {
1385
+ /** Number of items returned in the response. */
1386
+ count?: number | null;
1387
+ /** Cursor strings that point to the next page, previous page, or both. */
1388
+ cursors?: Cursors$2;
1389
+ /**
1390
+ * Whether there are more pages to retrieve following the current page.
1391
+ *
1392
+ * + `true`: Another page of results can be retrieved.
1393
+ * + `false`: This is the last page.
1394
+ */
1395
+ hasNext?: boolean | null;
1396
+ }
1397
+ interface Cursors$2 {
1398
+ /** Cursor string pointing to the next page in the list of results. */
1399
+ next?: string | null;
1400
+ /** Cursor pointing to the previous page in the list of results. */
1401
+ prev?: string | null;
1402
+ }
1403
+ interface CreateReferredFriendResponseNonNullableFields {
1404
+ referredFriend?: {
1405
+ _id: string;
1406
+ contactId: string;
1407
+ referringCustomerId: string;
1408
+ status: Status;
1409
+ };
1410
+ }
1411
+ interface GetReferredFriendResponseNonNullableFields {
1412
+ referredFriend?: {
1413
+ _id: string;
1414
+ contactId: string;
1415
+ referringCustomerId: string;
1416
+ status: Status;
1417
+ };
1418
+ }
1419
+ interface GetReferredFriendByContactIdResponseNonNullableFields {
1420
+ referredFriend?: {
1421
+ _id: string;
1422
+ contactId: string;
1423
+ referringCustomerId: string;
1424
+ status: Status;
1425
+ };
1426
+ }
1427
+ interface UpdateReferredFriendResponseNonNullableFields {
1428
+ referredFriend?: {
1429
+ _id: string;
1430
+ contactId: string;
1431
+ referringCustomerId: string;
1432
+ status: Status;
1433
+ };
1434
+ }
1435
+ interface QueryReferredFriendResponseNonNullableFields {
1436
+ referredFriends: {
1437
+ _id: string;
1438
+ contactId: string;
1439
+ referringCustomerId: string;
1440
+ status: Status;
1441
+ }[];
1442
+ }
1443
+
1444
+ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1445
+ getUrl: (context: any) => string;
1446
+ httpMethod: K;
1447
+ path: string;
1448
+ pathParams: M;
1449
+ __requestType: T;
1450
+ __originalRequestType: S;
1451
+ __responseType: Q;
1452
+ __originalResponseType: R;
1453
+ };
1454
+ declare function createReferredFriend(): __PublicMethodMetaInfo$1<'POST', {}, CreateReferredFriendRequest, CreateReferredFriendRequest$1, CreateReferredFriendResponse & CreateReferredFriendResponseNonNullableFields, CreateReferredFriendResponse$1 & CreateReferredFriendResponseNonNullableFields$1>;
1455
+ declare function getReferredFriend(): __PublicMethodMetaInfo$1<'GET', {
1456
+ referredFriendId: string;
1457
+ }, GetReferredFriendRequest, GetReferredFriendRequest$1, GetReferredFriendResponse & GetReferredFriendResponseNonNullableFields, GetReferredFriendResponse$1 & GetReferredFriendResponseNonNullableFields$1>;
1458
+ declare function getReferredFriendByContactId(): __PublicMethodMetaInfo$1<'GET', {
1459
+ contactId: string;
1460
+ }, GetReferredFriendByContactIdRequest, GetReferredFriendByContactIdRequest$1, GetReferredFriendByContactIdResponse & GetReferredFriendByContactIdResponseNonNullableFields, GetReferredFriendByContactIdResponse$1 & GetReferredFriendByContactIdResponseNonNullableFields$1>;
1461
+ declare function updateReferredFriend(): __PublicMethodMetaInfo$1<'PATCH', {
1462
+ referredFriendId: string;
1463
+ }, UpdateReferredFriendRequest, UpdateReferredFriendRequest$1, UpdateReferredFriendResponse & UpdateReferredFriendResponseNonNullableFields, UpdateReferredFriendResponse$1 & UpdateReferredFriendResponseNonNullableFields$1>;
1464
+ declare function deleteReferredFriend(): __PublicMethodMetaInfo$1<'DELETE', {
1465
+ referredFriendId: string;
1466
+ }, DeleteReferredFriendRequest, DeleteReferredFriendRequest$1, DeleteReferredFriendResponse, DeleteReferredFriendResponse$1>;
1467
+ declare function queryReferredFriend(): __PublicMethodMetaInfo$1<'POST', {}, QueryReferredFriendRequest, QueryReferredFriendRequest$1, QueryReferredFriendResponse & QueryReferredFriendResponseNonNullableFields, QueryReferredFriendResponse$1 & QueryReferredFriendResponseNonNullableFields$1>;
1468
+
1469
+ declare const meta$1_createReferredFriend: typeof createReferredFriend;
1470
+ declare const meta$1_deleteReferredFriend: typeof deleteReferredFriend;
1471
+ declare const meta$1_getReferredFriend: typeof getReferredFriend;
1472
+ declare const meta$1_getReferredFriendByContactId: typeof getReferredFriendByContactId;
1473
+ declare const meta$1_queryReferredFriend: typeof queryReferredFriend;
1474
+ declare const meta$1_updateReferredFriend: typeof updateReferredFriend;
1475
+ declare namespace meta$1 {
1476
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_createReferredFriend as createReferredFriend, meta$1_deleteReferredFriend as deleteReferredFriend, meta$1_getReferredFriend as getReferredFriend, meta$1_getReferredFriendByContactId as getReferredFriendByContactId, meta$1_queryReferredFriend as queryReferredFriend, meta$1_updateReferredFriend as updateReferredFriend };
1477
+ }
1478
+
1479
+ /** ReferringCustomer is the main entity of ReferringCustomers. */
1480
+ interface ReferringCustomer$1 {
1481
+ /**
1482
+ * ReferringCustomer id.
1483
+ * @readonly
1484
+ */
1485
+ id?: string;
1486
+ /**
1487
+ * Contact id.
1488
+ * @readonly
1489
+ */
1490
+ contactId?: string;
1491
+ /**
1492
+ * Referral code.
1493
+ * @readonly
1494
+ */
1495
+ referralCode?: string;
1496
+ /** Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. */
1497
+ revision?: string | null;
1498
+ /**
1499
+ * Represents the time this ReferringCustomer was created.
1500
+ * @readonly
1501
+ */
1502
+ createdDate?: Date;
1503
+ /**
1504
+ * Represents the time this ReferringCustomer was last updated.
1505
+ * @readonly
1506
+ */
1507
+ updatedDate?: Date;
1508
+ }
1509
+ interface GenerateReferringCustomerForContactRequest$1 {
1510
+ /** Contact id or "me" to generate current identity's referring customer. */
1511
+ contactId: string;
1512
+ }
1513
+ interface GenerateReferringCustomerForContactResponse$1 {
1514
+ /** The created ReferringCustomer. */
1515
+ referringCustomer?: ReferringCustomer$1;
1516
+ }
1517
+ interface GetReferringCustomerRequest$1 {
1518
+ /** Id of the ReferringCustomer to retrieve. */
1519
+ referringCustomerId: string;
1520
+ }
1521
+ interface GetReferringCustomerResponse$1 {
1522
+ /** The retrieved ReferringCustomer. */
1523
+ referringCustomer?: ReferringCustomer$1;
1524
+ }
1525
+ interface GetReferringCustomerByReferralCodeRequest$1 {
1526
+ /** Referral Code of the ReferringCustomer to retrieve. */
1527
+ referralCode: string;
1528
+ }
1529
+ interface GetReferringCustomerByReferralCodeResponse$1 {
1530
+ /** The retrieved ReferringCustomer. */
1531
+ referringCustomer?: ReferringCustomer$1;
1532
+ }
1533
+ interface QueryReferringCustomersRequest$1 {
1534
+ /** Query options. */
1535
+ query: CursorQuery$1;
1536
+ }
1537
+ interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
1538
+ /** 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`. */
1539
+ cursorPaging?: CursorPaging$1;
1540
+ /**
1541
+ * Filter object in the following format:
1542
+ * `"filter" : {
1543
+ * "fieldName1": "value1",
1544
+ * "fieldName2":{"$operator":"value2"}
1545
+ * }`
1546
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1547
+ */
1548
+ filter?: Record<string, any> | null;
1549
+ /**
1550
+ * Sort object in the following format:
1551
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1552
+ */
1553
+ sort?: Sorting$1[];
1554
+ }
1555
+ /** @oneof */
1556
+ interface CursorQueryPagingMethodOneOf$1 {
1557
+ /** 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`. */
1558
+ cursorPaging?: CursorPaging$1;
1559
+ }
1560
+ interface Sorting$1 {
1561
+ /** Name of the field to sort by. */
1562
+ fieldName?: string;
1563
+ /** Sort order. */
1564
+ order?: SortOrder$1;
1565
+ }
1566
+ declare enum SortOrder$1 {
1567
+ ASC = "ASC",
1568
+ DESC = "DESC"
1569
+ }
1570
+ interface CursorPaging$1 {
1571
+ /** Maximum number of items to return in the results. */
1572
+ limit?: number | null;
1573
+ /**
1574
+ * Pointer to the next or previous page in the list of results.
1575
+ *
1576
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1577
+ * Not relevant for the first request.
1578
+ */
1579
+ cursor?: string | null;
1580
+ }
1581
+ interface QueryReferringCustomersResponse$1 {
1582
+ /** The retrieved ReferringCustomers. */
1583
+ referringCustomers?: ReferringCustomer$1[];
1584
+ /** Paging metadata. */
1585
+ metadata?: CursorPagingMetadata$1;
1586
+ }
1587
+ interface CursorPagingMetadata$1 {
1588
+ /** Number of items returned in the response. */
1589
+ count?: number | null;
1590
+ /** Cursor strings that point to the next page, previous page, or both. */
1591
+ cursors?: Cursors$1;
1592
+ /**
1593
+ * Whether there are more pages to retrieve following the current page.
1594
+ *
1595
+ * + `true`: Another page of results can be retrieved.
1596
+ * + `false`: This is the last page.
1597
+ */
1598
+ hasNext?: boolean | null;
1599
+ }
1600
+ interface Cursors$1 {
1601
+ /** Cursor string pointing to the next page in the list of results. */
1602
+ next?: string | null;
1603
+ /** Cursor pointing to the previous page in the list of results. */
1604
+ prev?: string | null;
1605
+ }
1606
+ interface DeleteReferringCustomerRequest$1 {
1607
+ /** Id of the ReferringCustomer to delete. */
1608
+ referringCustomerId: string;
1609
+ /** The revision of the ReferringCustomer. */
1610
+ revision?: string;
1611
+ }
1612
+ interface DeleteReferringCustomerResponse$1 {
1613
+ }
1614
+ interface GenerateReferringCustomerForContactResponseNonNullableFields$1 {
1615
+ referringCustomer?: {
1616
+ id: string;
1617
+ contactId: string;
1618
+ referralCode: string;
1619
+ };
1620
+ }
1621
+ interface GetReferringCustomerResponseNonNullableFields$1 {
1622
+ referringCustomer?: {
1623
+ id: string;
1624
+ contactId: string;
1625
+ referralCode: string;
1626
+ };
1627
+ }
1628
+ interface GetReferringCustomerByReferralCodeResponseNonNullableFields$1 {
1629
+ referringCustomer?: {
1630
+ id: string;
1631
+ contactId: string;
1632
+ referralCode: string;
1633
+ };
1634
+ }
1635
+ interface QueryReferringCustomersResponseNonNullableFields$1 {
1636
+ referringCustomers: {
1637
+ id: string;
1638
+ contactId: string;
1639
+ referralCode: string;
1640
+ }[];
1641
+ }
1642
+
1643
+ /** ReferringCustomer is the main entity of ReferringCustomers. */
1644
+ interface ReferringCustomer {
1645
+ /**
1646
+ * ReferringCustomer id.
1647
+ * @readonly
1648
+ */
1649
+ _id?: string;
1650
+ /**
1651
+ * Contact id.
1652
+ * @readonly
1653
+ */
1654
+ contactId?: string;
1655
+ /**
1656
+ * Referral code.
1657
+ * @readonly
1658
+ */
1659
+ referralCode?: string;
1660
+ /** Represents the current state of an item. Each time the item is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision. */
1661
+ revision?: string | null;
1662
+ /**
1663
+ * Represents the time this ReferringCustomer was created.
1664
+ * @readonly
1665
+ */
1666
+ _createdDate?: Date;
1667
+ /**
1668
+ * Represents the time this ReferringCustomer was last updated.
1669
+ * @readonly
1670
+ */
1671
+ _updatedDate?: Date;
1672
+ }
1673
+ interface GenerateReferringCustomerForContactRequest {
1674
+ /** Contact id or "me" to generate current identity's referring customer. */
1675
+ contactId: string;
1676
+ }
1677
+ interface GenerateReferringCustomerForContactResponse {
1678
+ /** The created ReferringCustomer. */
1679
+ referringCustomer?: ReferringCustomer;
1680
+ }
1681
+ interface GetReferringCustomerRequest {
1682
+ /** Id of the ReferringCustomer to retrieve. */
1683
+ referringCustomerId: string;
1684
+ }
1685
+ interface GetReferringCustomerResponse {
1686
+ /** The retrieved ReferringCustomer. */
1687
+ referringCustomer?: ReferringCustomer;
1688
+ }
1689
+ interface GetReferringCustomerByReferralCodeRequest {
1690
+ /** Referral Code of the ReferringCustomer to retrieve. */
1691
+ referralCode: string;
1692
+ }
1693
+ interface GetReferringCustomerByReferralCodeResponse {
1694
+ /** The retrieved ReferringCustomer. */
1695
+ referringCustomer?: ReferringCustomer;
1696
+ }
1697
+ interface QueryReferringCustomersRequest {
1698
+ /** Query options. */
1699
+ query: CursorQuery;
1700
+ }
1701
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
1702
+ /** 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`. */
1703
+ cursorPaging?: CursorPaging;
1704
+ /**
1705
+ * Filter object in the following format:
1706
+ * `"filter" : {
1707
+ * "fieldName1": "value1",
1708
+ * "fieldName2":{"$operator":"value2"}
1709
+ * }`
1710
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
1711
+ */
1712
+ filter?: Record<string, any> | null;
1713
+ /**
1714
+ * Sort object in the following format:
1715
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
1716
+ */
1717
+ sort?: Sorting[];
1718
+ }
1719
+ /** @oneof */
1720
+ interface CursorQueryPagingMethodOneOf {
1721
+ /** 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`. */
1722
+ cursorPaging?: CursorPaging;
1723
+ }
1724
+ interface Sorting {
1725
+ /** Name of the field to sort by. */
1726
+ fieldName?: string;
1727
+ /** Sort order. */
1728
+ order?: SortOrder;
1729
+ }
1730
+ declare enum SortOrder {
1731
+ ASC = "ASC",
1732
+ DESC = "DESC"
1733
+ }
1734
+ interface CursorPaging {
1735
+ /** Maximum number of items to return in the results. */
1736
+ limit?: number | null;
1737
+ /**
1738
+ * Pointer to the next or previous page in the list of results.
1739
+ *
1740
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1741
+ * Not relevant for the first request.
1742
+ */
1743
+ cursor?: string | null;
1744
+ }
1745
+ interface QueryReferringCustomersResponse {
1746
+ /** The retrieved ReferringCustomers. */
1747
+ referringCustomers?: ReferringCustomer[];
1748
+ /** Paging metadata. */
1749
+ metadata?: CursorPagingMetadata;
1750
+ }
1751
+ interface CursorPagingMetadata {
1752
+ /** Number of items returned in the response. */
1753
+ count?: number | null;
1754
+ /** Cursor strings that point to the next page, previous page, or both. */
1755
+ cursors?: Cursors;
1756
+ /**
1757
+ * Whether there are more pages to retrieve following the current page.
1758
+ *
1759
+ * + `true`: Another page of results can be retrieved.
1760
+ * + `false`: This is the last page.
1761
+ */
1762
+ hasNext?: boolean | null;
1763
+ }
1764
+ interface Cursors {
1765
+ /** Cursor string pointing to the next page in the list of results. */
1766
+ next?: string | null;
1767
+ /** Cursor pointing to the previous page in the list of results. */
1768
+ prev?: string | null;
1769
+ }
1770
+ interface DeleteReferringCustomerRequest {
1771
+ /** Id of the ReferringCustomer to delete. */
1772
+ referringCustomerId: string;
1773
+ /** The revision of the ReferringCustomer. */
1774
+ revision?: string;
1775
+ }
1776
+ interface DeleteReferringCustomerResponse {
1777
+ }
1778
+ interface GenerateReferringCustomerForContactResponseNonNullableFields {
1779
+ referringCustomer?: {
1780
+ _id: string;
1781
+ contactId: string;
1782
+ referralCode: string;
1783
+ };
1784
+ }
1785
+ interface GetReferringCustomerResponseNonNullableFields {
1786
+ referringCustomer?: {
1787
+ _id: string;
1788
+ contactId: string;
1789
+ referralCode: string;
1790
+ };
1791
+ }
1792
+ interface GetReferringCustomerByReferralCodeResponseNonNullableFields {
1793
+ referringCustomer?: {
1794
+ _id: string;
1795
+ contactId: string;
1796
+ referralCode: string;
1797
+ };
1798
+ }
1799
+ interface QueryReferringCustomersResponseNonNullableFields {
1800
+ referringCustomers: {
1801
+ _id: string;
1802
+ contactId: string;
1803
+ referralCode: string;
1804
+ }[];
1805
+ }
1806
+
1807
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1808
+ getUrl: (context: any) => string;
1809
+ httpMethod: K;
1810
+ path: string;
1811
+ pathParams: M;
1812
+ __requestType: T;
1813
+ __originalRequestType: S;
1814
+ __responseType: Q;
1815
+ __originalResponseType: R;
1816
+ };
1817
+ declare function generateReferringCustomerForContact(): __PublicMethodMetaInfo<'POST', {}, GenerateReferringCustomerForContactRequest, GenerateReferringCustomerForContactRequest$1, GenerateReferringCustomerForContactResponse & GenerateReferringCustomerForContactResponseNonNullableFields, GenerateReferringCustomerForContactResponse$1 & GenerateReferringCustomerForContactResponseNonNullableFields$1>;
1818
+ declare function getReferringCustomer(): __PublicMethodMetaInfo<'GET', {
1819
+ referringCustomerId: string;
1820
+ }, GetReferringCustomerRequest, GetReferringCustomerRequest$1, GetReferringCustomerResponse & GetReferringCustomerResponseNonNullableFields, GetReferringCustomerResponse$1 & GetReferringCustomerResponseNonNullableFields$1>;
1821
+ declare function getReferringCustomerByReferralCode(): __PublicMethodMetaInfo<'GET', {
1822
+ referralCode: string;
1823
+ }, GetReferringCustomerByReferralCodeRequest, GetReferringCustomerByReferralCodeRequest$1, GetReferringCustomerByReferralCodeResponse & GetReferringCustomerByReferralCodeResponseNonNullableFields, GetReferringCustomerByReferralCodeResponse$1 & GetReferringCustomerByReferralCodeResponseNonNullableFields$1>;
1824
+ declare function queryReferringCustomers(): __PublicMethodMetaInfo<'POST', {}, QueryReferringCustomersRequest, QueryReferringCustomersRequest$1, QueryReferringCustomersResponse & QueryReferringCustomersResponseNonNullableFields, QueryReferringCustomersResponse$1 & QueryReferringCustomersResponseNonNullableFields$1>;
1825
+ declare function deleteReferringCustomer(): __PublicMethodMetaInfo<'DELETE', {
1826
+ referringCustomerId: string;
1827
+ }, DeleteReferringCustomerRequest, DeleteReferringCustomerRequest$1, DeleteReferringCustomerResponse, DeleteReferringCustomerResponse$1>;
1042
1828
 
1043
1829
  type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
1044
- declare const meta_getReferralEvent: typeof getReferralEvent;
1045
- declare const meta_getReferralStatistics: typeof getReferralStatistics;
1046
- declare const meta_queryReferralEvent: typeof queryReferralEvent;
1047
- declare const meta_queryReferredFriendActions: typeof queryReferredFriendActions;
1048
- declare const meta_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
1830
+ declare const meta_deleteReferringCustomer: typeof deleteReferringCustomer;
1831
+ declare const meta_generateReferringCustomerForContact: typeof generateReferringCustomerForContact;
1832
+ declare const meta_getReferringCustomer: typeof getReferringCustomer;
1833
+ declare const meta_getReferringCustomerByReferralCode: typeof getReferringCustomerByReferralCode;
1834
+ declare const meta_queryReferringCustomers: typeof queryReferringCustomers;
1049
1835
  declare namespace meta {
1050
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getReferralEvent as getReferralEvent, meta_getReferralStatistics as getReferralStatistics, meta_queryReferralEvent as queryReferralEvent, meta_queryReferredFriendActions as queryReferredFriendActions, meta_queryReferringCustomerTotals as queryReferringCustomerTotals };
1836
+ export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_deleteReferringCustomer as deleteReferringCustomer, meta_generateReferringCustomerForContact as generateReferringCustomerForContact, meta_getReferringCustomer as getReferringCustomer, meta_getReferringCustomerByReferralCode as getReferringCustomerByReferralCode, meta_queryReferringCustomers as queryReferringCustomers };
1051
1837
  }
1052
1838
 
1053
- export { meta as tracker };
1839
+ export { meta as customers, meta$1 as friends, meta$2 as tracker };