@15gifts/sdk 0.22.2 → 0.22.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -60,7 +60,6 @@ interface components {
60
60
  /**
61
61
  * Conversationid
62
62
  * @description Unique identifier for the conversation. This will be generated once, at the start of a conversation.
63
- * @example 123e4567-e89b-12d3-a456-426614174000
64
63
  */
65
64
  conversationId?: string | null;
66
65
  };
@@ -78,7 +77,6 @@ interface components {
78
77
  /**
79
78
  * Fallbackmessage
80
79
  * @description What should a client render if they do not have a native renderer for this message type?
81
- * @example Your options are a, b or c
82
80
  */
83
81
  fallbackMessage: string;
84
82
  /**
@@ -97,7 +95,6 @@ interface components {
97
95
  /**
98
96
  * Conversationid
99
97
  * @description The conversation id
100
- * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
101
98
  */
102
99
  conversationId?: string | null;
103
100
  };
@@ -115,7 +112,6 @@ interface components {
115
112
  /**
116
113
  * Fallbackmessage
117
114
  * @description What should a client render if they do not have a native renderer for this message type?
118
- * @example Your options are a, b or c
119
115
  */
120
116
  fallbackMessage: string;
121
117
  /** @description Why have we been exited to phone? */
@@ -147,7 +143,6 @@ interface components {
147
143
  /**
148
144
  * Fallbackmessage
149
145
  * @description What should a client render if they do not have a native renderer for this message type?
150
- * @example Your options are a, b or c
151
146
  */
152
147
  fallbackMessage: string;
153
148
  /** Recommendationidforexit */
@@ -181,7 +176,6 @@ interface components {
181
176
  /**
182
177
  * Fallbackmessage
183
178
  * @description What should a client render if they do not have a native renderer for this message type?
184
- * @example Your options are a, b or c
185
179
  */
186
180
  fallbackMessage: string;
187
181
  /** Recommendationidforexit */
@@ -200,6 +194,8 @@ interface components {
200
194
  * @default []
201
195
  */
202
196
  offers: components['schemas']['OfferV2'][];
197
+ /** @description Optional products that the user could add the basket */
198
+ optionalAddOns?: components['schemas']['OptionalAddOnChoices'] | null;
203
199
  };
204
200
  /**
205
201
  * AssistantMultiSelectMessage
@@ -215,7 +211,6 @@ interface components {
215
211
  /**
216
212
  * Fallbackmessage
217
213
  * @description What should a client render if they do not have a native renderer for this message type?
218
- * @example Your options are a, b or c
219
214
  */
220
215
  fallbackMessage: string;
221
216
  /**
@@ -243,7 +238,6 @@ interface components {
243
238
  /**
244
239
  * Fallbackmessage
245
240
  * @description What should a client render if they do not have a native renderer for this message type?
246
- * @example Your options are a, b or c
247
241
  */
248
242
  fallbackMessage: string;
249
243
  /** Recommendations */
@@ -263,7 +257,6 @@ interface components {
263
257
  /**
264
258
  * Fallbackmessage
265
259
  * @description What should a client render if they do not have a native renderer for this message type?
266
- * @example Your options are a, b or c
267
260
  */
268
261
  fallbackMessage: string;
269
262
  /** Recommendations */
@@ -287,7 +280,6 @@ interface components {
287
280
  /**
288
281
  * Fallbackmessage
289
282
  * @description What should a client render if they do not have a native renderer for this message type?
290
- * @example Your options are a, b or c
291
283
  */
292
284
  fallbackMessage: string;
293
285
  /**
@@ -315,7 +307,6 @@ interface components {
315
307
  /**
316
308
  * Message
317
309
  * @description Message for the conversation.
318
- * @example Hello, how can I help you today?
319
310
  */
320
311
  message: string;
321
312
  };
@@ -333,13 +324,11 @@ interface components {
333
324
  /**
334
325
  * Usermessage
335
326
  * @description The user message
336
- * @example Hello
337
327
  */
338
328
  userMessage?: string | null;
339
329
  /**
340
330
  * Option
341
331
  * @description Which select option was picked?
342
- * @example 12345
343
332
  */
344
333
  option?: string | null;
345
334
  };
@@ -436,43 +425,21 @@ interface components {
436
425
  /**
437
426
  * Eligibleproducts
438
427
  * @description What product IDs is the user eligible for?
439
- * @example [
440
- * "12345"
441
- * ]
442
428
  */
443
429
  eligibleProducts?: string[] | null;
444
430
  /**
445
431
  * Eligiblebundles
446
432
  * @description What bundle IDs is the user eligible for?
447
- * @example [
448
- * "12345"
449
- * ]
450
433
  */
451
434
  eligibleBundles?: string[] | null;
452
435
  /**
453
436
  * Eligibleoffers
454
437
  * @description What offer IDs is the user eligible for?
455
- * @example [
456
- * "PROMO1234"
457
- * ]
458
438
  */
459
439
  eligibleOffers?: string[] | null;
460
440
  /**
461
441
  * Productoverrides
462
442
  * @description The fields to override in the product specs as based on eligibility
463
- * @example {
464
- * "INTERNET": {
465
- * "specifications": {
466
- * "connectionSpeeds": {
467
- * "averageDownloadSpeed": {
468
- * "@type": "AverageDownloadSpeed",
469
- * "unitText": "Mbps",
470
- * "value": 100
471
- * }
472
- * }
473
- * }
474
- * }
475
- * }
476
443
  */
477
444
  productOverrides?: {
478
445
  [key: string]: {
@@ -482,21 +449,6 @@ interface components {
482
449
  /**
483
450
  * Bundleoverrides
484
451
  * @description The fields to override in the product specs as based on eligibility
485
- * @example {
486
- * "BUNDLEDISCOUNT": {
487
- * "prices": {
488
- * "@type": "Standard",
489
- * "description": "$17.50 per month for 12 months",
490
- * "monthlyCost": 17.5,
491
- * "parts": [
492
- * {
493
- * "@type": "MonthlyPricePart",
494
- * "value": 17.5
495
- * }
496
- * ]
497
- * }
498
- * }
499
- * }
500
452
  */
501
453
  bundleOverrides?: {
502
454
  [key: string]: {
@@ -506,14 +458,6 @@ interface components {
506
458
  /**
507
459
  * Offeroverrides
508
460
  * @description The fields to override in the offer specs as based on eligibility
509
- * @example {
510
- * "PROMO1234": {
511
- * "discount": {
512
- * "description": "Big Summer Blowout (20% off)",
513
- * "value": 20
514
- * }
515
- * }
516
- * }
517
461
  */
518
462
  offerOverrides?: {
519
463
  [key: string]: {
@@ -613,6 +557,32 @@ interface components {
613
557
  /** @description Choice contain information needed for choice offers */
614
558
  choice?: components['schemas']['ChoiceOfferDetails'] | null;
615
559
  };
560
+ /**
561
+ * OptionalAddOn
562
+ * @description An optional item that can be added to the main product.
563
+ */
564
+ OptionalAddOn: {
565
+ /** Id */
566
+ id: string;
567
+ /** Name */
568
+ name: string;
569
+ /** Price */
570
+ price?: string | null;
571
+ /** Description */
572
+ description?: string | null;
573
+ /** Pickmin */
574
+ pickMin?: number | null;
575
+ /** Pickmax */
576
+ pickMax?: number | null;
577
+ };
578
+ /**
579
+ * OptionalAddOnChoices
580
+ * @description Selection of optional items that the user can add to the main product
581
+ */
582
+ OptionalAddOnChoices: {
583
+ /** Options */
584
+ options: components['schemas']['OptionalAddOn'][];
585
+ };
616
586
  /** PickFrom */
617
587
  PickFrom: {
618
588
  /**
@@ -799,6 +769,8 @@ interface components {
799
769
  importantInformation?: string | null;
800
770
  /** @description Details to populate the header of the recommendation card */
801
771
  header?: components['schemas']['HeaderDetails'] | null;
772
+ /** @description Optional products that the user can add the basket */
773
+ optionalAddOns?: components['schemas']['OptionalAddOnChoices'] | null;
802
774
  };
803
775
  /**
804
776
  * UserMultiSelectMessage
@@ -815,22 +787,16 @@ interface components {
815
787
  * Conversationid
816
788
  * Format: uuid
817
789
  * @description The conversation id
818
- * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
819
790
  */
820
791
  conversationId: string;
821
792
  /**
822
793
  * Usermessage
823
794
  * @description The user message
824
- * @example Hello
825
795
  */
826
796
  userMessage?: string | null;
827
797
  /**
828
798
  * Options
829
799
  * @description Which select options were picked?
830
- * @example [
831
- * "12345",
832
- * "67890"
833
- * ]
834
800
  */
835
801
  options: string[];
836
802
  };
@@ -845,20 +811,17 @@ interface components {
845
811
  /**
846
812
  * Usermessage
847
813
  * @description The user message
848
- * @example Hello
849
814
  */
850
815
  userMessage?: string | null;
851
816
  /**
852
817
  * Option
853
818
  * @description Which select option was picked?
854
- * @example 12345
855
819
  */
856
820
  option?: string | null;
857
821
  /**
858
822
  * Conversationid
859
823
  * Format: uuid
860
824
  * @description The conversation id
861
- * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
862
825
  */
863
826
  conversationId: string;
864
827
  };
@@ -893,13 +856,11 @@ interface components {
893
856
  * Conversationid
894
857
  * Format: uuid
895
858
  * @description The conversation id
896
- * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
897
859
  */
898
860
  conversationId: string;
899
861
  /**
900
862
  * Usermessage
901
863
  * @description The user message
902
- * @example Hello
903
864
  */
904
865
  userMessage: string;
905
866
  };
@@ -948,13 +909,6 @@ interface operations {
948
909
  [name: string]: unknown;
949
910
  };
950
911
  content: {
951
- /**
952
- * @example {
953
- * "code": "ERROR_UNHANDLED",
954
- * "message": "An error occurred",
955
- * "detail": "Access forbidden"
956
- * }
957
- */
958
912
  'application/json': unknown;
959
913
  };
960
914
  };
@@ -1017,13 +971,6 @@ interface operations {
1017
971
  [name: string]: unknown;
1018
972
  };
1019
973
  content: {
1020
- /**
1021
- * @example {
1022
- * "code": "ERROR_UNHANDLED",
1023
- * "message": "An error occurred",
1024
- * "detail": "Unauthorized access"
1025
- * }
1026
- */
1027
974
  'application/json': unknown;
1028
975
  };
1029
976
  };
@@ -1033,13 +980,6 @@ interface operations {
1033
980
  [name: string]: unknown;
1034
981
  };
1035
982
  content: {
1036
- /**
1037
- * @example {
1038
- * "code": "ERROR_UNHANDLED",
1039
- * "message": "An error occurred",
1040
- * "detail": "Access forbidden"
1041
- * }
1042
- */
1043
983
  'application/json': unknown;
1044
984
  };
1045
985
  };
@@ -1049,13 +989,6 @@ interface operations {
1049
989
  [name: string]: unknown;
1050
990
  };
1051
991
  content: {
1052
- /**
1053
- * @example {
1054
- * "code": "ERROR_UNHANDLED",
1055
- * "message": "An error occurred",
1056
- * "detail": "Customer 1234 not found"
1057
- * }
1058
- */
1059
992
  'application/json': unknown;
1060
993
  };
1061
994
  };
@@ -1065,20 +998,6 @@ interface operations {
1065
998
  [name: string]: unknown;
1066
999
  };
1067
1000
  content: {
1068
- /**
1069
- * @example {
1070
- * "code": "ERROR_UNHANDLED",
1071
- * "message": "An error occurred",
1072
- * "detail": {
1073
- * "loc": [
1074
- * "string",
1075
- * 0
1076
- * ],
1077
- * "msg": "string",
1078
- * "type": "string"
1079
- * }
1080
- * }
1081
- */
1082
1001
  'application/json': unknown;
1083
1002
  };
1084
1003
  };
@@ -1159,14 +1078,6 @@ interface paths {
1159
1078
  [name: string]: unknown;
1160
1079
  };
1161
1080
  content: {
1162
- /**
1163
- * @example {
1164
- * "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
1165
- * "sessionId": "2f6863a9-2833-5521-a45d-359dcdfd154a",
1166
- * "userId": "163a692e-8ee2-623f-9927-0bb563b19853",
1167
- * "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
1168
- * }
1169
- */
1170
1081
  'application/json': {
1171
1082
  /**
1172
1083
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
@@ -1219,8 +1130,7 @@ interface paths {
1219
1130
  /** @description User tracking event data */
1220
1131
  requestBody: {
1221
1132
  content: {
1222
- /**
1223
- * @example {
1133
+ /** @example {
1224
1134
  * "conversationId": "386d85d7-9daa-8a87-85d4-3f93c990b292",
1225
1135
  * "eventName": "entry_point-shown",
1226
1136
  * "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
@@ -1229,89 +1139,80 @@ interface paths {
1229
1139
  * "screenWidth": 390,
1230
1140
  * "url": "https://www.example.com/telco/",
1231
1141
  * "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.210 Mobile Safari/537.36"
1232
- * }
1233
- */
1142
+ * } */
1234
1143
  'application/json': {
1235
1144
  additionalProperties?: {
1236
- /**
1237
- * @description A 36 character alphanumeric hash that uniquely identifies a user.
1145
+ /** @description A 36 character alphanumeric hash that uniquely identifies a user.
1238
1146
  *
1239
1147
  *
1240
1148
  * This should match the UUID V4 as specified in RFC 9652:
1241
1149
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1242
1150
  *
1243
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1244
- */
1151
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1245
1152
  user_id?: string;
1246
1153
  /** @description A timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC. Example: "2024-07-17T10:11:16.591Z" */
1247
1154
  event_at?: string;
1248
1155
  /** @description The page url at the time the event is fired */
1249
1156
  url?: string;
1250
- /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1157
+ /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1251
1158
  browser?: string;
1252
1159
  /** @description The customer that the event occurred on */
1253
1160
  customer_id?: string;
1254
1161
  /** @description The user agent string e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36" */
1255
1162
  user_agent?: string;
1256
- /**
1257
- * @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1163
+ /** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1258
1164
  *
1259
1165
  * This should match the UUID V4 as specified in RFC 9652:
1260
1166
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1261
1167
  *
1262
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1263
- */
1168
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1264
1169
  event_id?: string;
1265
1170
  /** @description The name of an event */
1266
1171
  event_name?: string;
1267
- /**
1268
- * @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1172
+ /** @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1269
1173
  *
1270
1174
  * This should match the UUID V4 as specified in RFC 9652:
1271
1175
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1272
1176
  *
1273
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1274
- */
1177
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1275
1178
  pageview_id?: string;
1276
1179
  /** @description A unique user id native to our customers web analytics platforms (adobe, google analytics etc). Helps us & our customers align our data with what customers see in their platforms. */
1277
1180
  web_analytics_platform_user_id?: string | null;
1278
- /**
1279
- * @description A 36 character alphanumeric hash that uniquely identifies a session.
1181
+ /** @description A 36 character alphanumeric hash that uniquely identifies a session.
1280
1182
  *
1281
1183
  *
1282
1184
  * This should match the UUID V4 as specified in RFC 9652:
1283
1185
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1284
1186
  *
1285
1187
  * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1286
- */
1188
+ * */
1287
1189
  browser_session_id?: string | null;
1288
1190
  /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1289
1191
  screen_width?: number;
1290
1192
  /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
1291
1193
  screen_height?: number;
1292
- /**
1293
- * @description The size of the device's screen, based off the actual user experience it will generate, assuming the browser window takes up the whole screen.
1194
+ /** @description The size of the device's screen, based off the actual user experience it will generate, assuming the browser window takes up the whole screen.
1294
1195
  *
1295
1196
  * Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
1296
1197
  *
1297
1198
  * screen_width <= 480px = 'mobile'
1298
- * screen_width > 480px = 'large'
1299
- */
1199
+ * screen_width > 480px = 'large' */
1300
1200
  screen_size?: string;
1301
- /** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement_popup (previously named engagement bubble) or engagement_embedded if it's the engagement embedded on on a page instead of floating */
1201
+ /** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement_popup (previously named engagement bubble) or engagement_embedded if it's the engagement embedded on on a page instead of floating
1202
+ * */
1302
1203
  entry_point_type?: string;
1303
- /**
1304
- * @description A 36 character alphanumeric hash that uniquely identifies a conversation.
1204
+ /** @description A 36 character alphanumeric hash that uniquely identifies a conversation.
1305
1205
  *
1306
1206
  * This should match the UUID V4 as specified in RFC 9652:
1307
1207
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1308
1208
  *
1309
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1310
- */
1209
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1311
1210
  conversation_id?: string;
1312
- /** @description Describes the reason the entry point was shown. When the value is 'customer_triggered' it's because it's been programmatically shown by the customer (by running window.axiom.integrations.show() or similar). When it's 'automatic' it's the default behaviour when Humara loads normally after a page load. */
1211
+ /** @description Describes the reason the entry point was shown. When the value is 'customer_triggered' it's because it's been programmatically shown by the customer (by running window.axiom.integrations.show() or similar). When it's 'automatic' it's the default behaviour when Humara loads normally after a page load.
1212
+ * */
1313
1213
  entry_point_shown_reason?: string;
1314
- /** @description Describes the elements of the entry point at the time of it being shown or clicked. Can be an object of one or more elements, each with their own properties */
1214
+ /** @description Describes the elements of the entry point at the time of it being shown or clicked. Can be an object of one or more elements, each with their own properties
1215
+ * */
1315
1216
  entry_point_elements?: unknown[];
1316
1217
  /** @description The name of the system/service that the event originates from */
1317
1218
  service?: string;
@@ -1323,7 +1224,8 @@ interface paths {
1323
1224
  feedback_score_text?: string;
1324
1225
  /** @description An integer representing the rank of the corresponding feedback score. It should always start at 0, even if the number of options changes. */
1325
1226
  feedback_score_num?: number;
1326
- /** @description A hashed IP address for the user. Hashing Algorithm and Salt are in 1Password. Python replication of algorithm is hashlib.sha256(f'{salt}{ip}'.encode('utf-8')).hexdigest(). */
1227
+ /** @description A hashed IP address for the user. Hashing Algorithm and Salt are in 1Password. Python replication of algorithm is hashlib.sha256(f'{salt}{ip}'.encode('utf-8')).hexdigest().
1228
+ * */
1327
1229
  ip_address_hashed?: string;
1328
1230
  /** @description Describes the reason the tool ui was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide() or window.axiom.integrations.minimise()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
1329
1231
  tool_ui_closed_reason?: string;
@@ -1339,26 +1241,27 @@ interface paths {
1339
1241
  experiment_variation_name?: string;
1340
1242
  /** @description Describes the reason the entry point was closed. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide()). When it's 'user_close_click' it's because the actual end user has closed it manually by clicking. */
1341
1243
  entry_point_closed_reason?: string;
1342
- /** @description A categorical property to denote which party was responsible for suppression. This is useful for accurately calculating control conversion rates, it allows us to count how many users were suppressed before humara loading, and how many were put in a control group. */
1244
+ /** @description A categorical property to denote which party was responsible for suppression. This is useful for accurately calculating control conversion rates, it allows us to count how many users were suppressed before humara loading, and how many were put in a control group.
1245
+ * */
1343
1246
  suppressed_by?: unknown[];
1344
- /** @description A categorical property that describes the reason for the suppression. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide()) */
1247
+ /** @description A categorical property that describes the reason for the suppression. When the value is 'customer_triggered' it's because it's been programmatically closed by the customer (by running window.axiom.integrations.hide())
1248
+ * */
1345
1249
  suppressed_reason?: unknown[];
1346
1250
  /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1347
1251
  exit_destination_type?: string;
1348
1252
  /** @description Describes whether a user clicked the thumbs up ('positive') or thumbs down ('negative') on the rec card */
1349
1253
  rec_card_feedback_sentiment?: string;
1350
- /**
1351
- * @description A 32 character alphanumeric hash that uniquely identifies a single rec in a recommendation set.
1254
+ /** @description A 32 character alphanumeric hash that uniquely identifies a single rec in a recommendation set.
1352
1255
  *
1353
1256
  * This should match the UUID V4 as specified in RFC 9652:
1354
1257
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1355
1258
  *
1356
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1357
- */
1259
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1358
1260
  recommendation_id?: string;
1359
- /** @description List of objects that represents the options for single & multiselect questions. */
1261
+ /** @description List of objects that represents the options for single & multiselect questions. */
1360
1262
  message_select_options?: unknown[];
1361
- /** @description The text that was visible to the user on the CTA button */
1263
+ /** @description The text that was visible to the user on the CTA button
1264
+ * */
1362
1265
  button_text?: string;
1363
1266
  };
1364
1267
  /**
@@ -1736,7 +1639,18 @@ declare class Client {
1736
1639
  event_name?: string;
1737
1640
  pageview_id?: string;
1738
1641
  web_analytics_platform_user_id?: string | null;
1739
- browser_session_id?: string | null;
1642
+ browser_session_id? /**
1643
+ * Sends an event to the tracking API, with the required properties already set.
1644
+ *
1645
+ * @param eventName - The name of the event to track.
1646
+ * @param properties - Additional properties to include in the event.
1647
+ * @returns A promise that resolves once the event is tracked.
1648
+ *
1649
+ * @example
1650
+ * ```ts
1651
+ * await client.trackEvent('entry_point-shown')
1652
+ * ```
1653
+ */: string | null;
1740
1654
  screen_width?: number;
1741
1655
  screen_height?: number;
1742
1656
  screen_size?: string;