@15gifts/sdk 0.27.0 → 0.28.1

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
@@ -43,9 +43,45 @@ interface paths$1 {
43
43
  patch?: never;
44
44
  trace?: never;
45
45
  };
46
+ '/api/localisation/v1': {
47
+ parameters: {
48
+ query?: never;
49
+ header?: never;
50
+ path?: never;
51
+ cookie?: never;
52
+ };
53
+ get?: never;
54
+ put?: never;
55
+ /**
56
+ * Resolve Localisation
57
+ * @description Resolve an address to a normalised serviceability outcome.
58
+ */
59
+ post: operations['resolve_localisation_api_localisation_v1_post'];
60
+ delete?: never;
61
+ options?: never;
62
+ head?: never;
63
+ patch?: never;
64
+ trace?: never;
65
+ };
46
66
  }
47
67
  interface components {
48
68
  schemas: {
69
+ /**
70
+ * Address
71
+ * @description What the address sheet collects.
72
+ *
73
+ * There is no separate unit field. Where a multi-dwelling address needs one, the chosen unit
74
+ * goes into `addressLine1` — "1008 EVERETT AVE APT 2" — and the provider passes the line
75
+ * through. Verified against Spectrum for every unit at our one multi-dwelling test address:
76
+ * a combined line resolves to the same location as sending the unit in its own field, with
77
+ * or without a comma before it.
78
+ */
79
+ Address: {
80
+ /** Addressline1 */
81
+ addressLine1: string;
82
+ /** Postcode */
83
+ postcode: string;
84
+ };
49
85
  /**
50
86
  * AssistantConversationIdMessage
51
87
  * @description We're giving the caller a new Conversation ID
@@ -60,6 +96,7 @@ interface components {
60
96
  /**
61
97
  * Conversationid
62
98
  * @description Unique identifier for the conversation. This will be generated once, at the start of a conversation.
99
+ * @example 123e4567-e89b-12d3-a456-426614174000
63
100
  */
64
101
  conversationId?: string | null;
65
102
  };
@@ -77,6 +114,7 @@ interface components {
77
114
  /**
78
115
  * Fallbackmessage
79
116
  * @description What should a client render if they do not have a native renderer for this message type?
117
+ * @example Your options are a, b or c
80
118
  */
81
119
  fallbackMessage: string;
82
120
  /**
@@ -95,6 +133,7 @@ interface components {
95
133
  /**
96
134
  * Conversationid
97
135
  * @description The conversation id
136
+ * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
98
137
  */
99
138
  conversationId?: string | null;
100
139
  };
@@ -112,6 +151,7 @@ interface components {
112
151
  /**
113
152
  * Fallbackmessage
114
153
  * @description What should a client render if they do not have a native renderer for this message type?
154
+ * @example Your options are a, b or c
115
155
  */
116
156
  fallbackMessage: string;
117
157
  /** @description Why have we been exited to phone? */
@@ -143,6 +183,7 @@ interface components {
143
183
  /**
144
184
  * Fallbackmessage
145
185
  * @description What should a client render if they do not have a native renderer for this message type?
186
+ * @example Your options are a, b or c
146
187
  */
147
188
  fallbackMessage: string;
148
189
  /** Recommendationidforexit */
@@ -176,6 +217,7 @@ interface components {
176
217
  /**
177
218
  * Fallbackmessage
178
219
  * @description What should a client render if they do not have a native renderer for this message type?
220
+ * @example Your options are a, b or c
179
221
  */
180
222
  fallbackMessage: string;
181
223
  /** Recommendationidforexit */
@@ -211,6 +253,7 @@ interface components {
211
253
  /**
212
254
  * Fallbackmessage
213
255
  * @description What should a client render if they do not have a native renderer for this message type?
256
+ * @example Your options are a, b or c
214
257
  */
215
258
  fallbackMessage: string;
216
259
  /**
@@ -238,6 +281,7 @@ interface components {
238
281
  /**
239
282
  * Fallbackmessage
240
283
  * @description What should a client render if they do not have a native renderer for this message type?
284
+ * @example Your options are a, b or c
241
285
  */
242
286
  fallbackMessage: string;
243
287
  /** Recommendations */
@@ -257,6 +301,7 @@ interface components {
257
301
  /**
258
302
  * Fallbackmessage
259
303
  * @description What should a client render if they do not have a native renderer for this message type?
304
+ * @example Your options are a, b or c
260
305
  */
261
306
  fallbackMessage: string;
262
307
  /** Recommendations */
@@ -280,6 +325,7 @@ interface components {
280
325
  /**
281
326
  * Fallbackmessage
282
327
  * @description What should a client render if they do not have a native renderer for this message type?
328
+ * @example Your options are a, b or c
283
329
  */
284
330
  fallbackMessage: string;
285
331
  /**
@@ -307,9 +353,28 @@ interface components {
307
353
  /**
308
354
  * Message
309
355
  * @description Message for the conversation.
356
+ * @example Hello, how can I help you today?
310
357
  */
311
358
  message: string;
312
359
  };
360
+ /**
361
+ * AssistantTitleMessage
362
+ * @description A heading for clients to render above the messages that follow it
363
+ */
364
+ AssistantTitleMessage: {
365
+ /**
366
+ * Type
367
+ * @default TITLE
368
+ * @constant
369
+ */
370
+ type: 'TITLE';
371
+ /**
372
+ * Title
373
+ * @description Title to render as a heading.
374
+ * @example Welcome
375
+ */
376
+ title: string;
377
+ };
313
378
  /**
314
379
  * BaseSingleSelectMessage
315
380
  * @description A message from the end user that picks a single select item
@@ -324,11 +389,13 @@ interface components {
324
389
  /**
325
390
  * Usermessage
326
391
  * @description The user message
392
+ * @example Hello
327
393
  */
328
394
  userMessage?: string | null;
329
395
  /**
330
396
  * Option
331
397
  * @description Which select option was picked?
398
+ * @example 12345
332
399
  */
333
400
  option?: string | null;
334
401
  };
@@ -425,21 +492,43 @@ interface components {
425
492
  /**
426
493
  * Eligibleproducts
427
494
  * @description What product IDs is the user eligible for?
495
+ * @example [
496
+ * "12345"
497
+ * ]
428
498
  */
429
499
  eligibleProducts?: string[] | null;
430
500
  /**
431
501
  * Eligiblebundles
432
502
  * @description What bundle IDs is the user eligible for?
503
+ * @example [
504
+ * "12345"
505
+ * ]
433
506
  */
434
507
  eligibleBundles?: string[] | null;
435
508
  /**
436
509
  * Eligibleoffers
437
510
  * @description What offer IDs is the user eligible for?
511
+ * @example [
512
+ * "PROMO1234"
513
+ * ]
438
514
  */
439
515
  eligibleOffers?: string[] | null;
440
516
  /**
441
517
  * Productoverrides
442
518
  * @description The fields to override in the product specs as based on eligibility
519
+ * @example {
520
+ * "INTERNET": {
521
+ * "specifications": {
522
+ * "connectionSpeeds": {
523
+ * "averageDownloadSpeed": {
524
+ * "@type": "AverageDownloadSpeed",
525
+ * "unitText": "Mbps",
526
+ * "value": 100
527
+ * }
528
+ * }
529
+ * }
530
+ * }
531
+ * }
443
532
  */
444
533
  productOverrides?: {
445
534
  [key: string]: {
@@ -449,6 +538,21 @@ interface components {
449
538
  /**
450
539
  * Bundleoverrides
451
540
  * @description The fields to override in the product specs as based on eligibility
541
+ * @example {
542
+ * "BUNDLEDISCOUNT": {
543
+ * "prices": {
544
+ * "@type": "Standard",
545
+ * "description": "$17.50 per month for 12 months",
546
+ * "monthlyCost": 17.5,
547
+ * "parts": [
548
+ * {
549
+ * "@type": "MonthlyPricePart",
550
+ * "value": 17.5
551
+ * }
552
+ * ]
553
+ * }
554
+ * }
555
+ * }
452
556
  */
453
557
  bundleOverrides?: {
454
558
  [key: string]: {
@@ -458,6 +562,14 @@ interface components {
458
562
  /**
459
563
  * Offeroverrides
460
564
  * @description The fields to override in the offer specs as based on eligibility
565
+ * @example {
566
+ * "PROMO1234": {
567
+ * "discount": {
568
+ * "description": "Big Summer Blowout (20% off)",
569
+ * "value": 20
570
+ * }
571
+ * }
572
+ * }
461
573
  */
462
574
  offerOverrides?: {
463
575
  [key: string]: {
@@ -467,13 +579,21 @@ interface components {
467
579
  /**
468
580
  * Restartedfromconversationid
469
581
  * @description The source conversation ID when starting a conversation via restart flow.
582
+ * @example 123e4567-e89b-12d3-a456-426614174000
470
583
  */
471
584
  restartedFromConversationId?: string | null;
472
585
  /**
473
586
  * Islocalised
474
587
  * @description This is to indicate if user is localised. Absent is treated as localised; only an explicit false narrows eligibility to alwaysEligible bundles.
588
+ * @example false
475
589
  */
476
590
  isLocalised?: boolean | null;
591
+ /**
592
+ * Exittophonenumber
593
+ * @description Phone number to show on the exit-to-phone button. When present, overrides the exitOptions.exitToPhone.linkPhone config value.
594
+ * @example 855-000-0000
595
+ */
596
+ exitToPhoneNumber?: string | null;
477
597
  } & {
478
598
  [key: string]: unknown;
479
599
  };
@@ -499,7 +619,7 @@ interface components {
499
619
  /** Usermessage */
500
620
  userMessage: components['schemas']['UserTextMessage'] | components['schemas']['UserSingleSelectMessage'] | components['schemas']['UserMultiSelectMessage'] | components['schemas']['UserStartConversationMessage'];
501
621
  /** Assistantmessages */
502
- assistantMessages: (components['schemas']['AssistantTextMessage'] | components['schemas']['AssistantSingleSelectMessage'] | components['schemas']['AssistantMultiSelectMessage'] | components['schemas']['AssistantExitToChatMessage'] | components['schemas']['AssistantExitToPhoneMessage'] | components['schemas']['AssistantRecommendationMessage'] | components['schemas']['AssistantRecommendationMessageV2'] | components['schemas']['AssistantConversationIdMessage'] | components['schemas']['AssistantExitToPurchaseMessage'] | components['schemas']['AssistantExitToPurchaseMessageV2'])[];
622
+ assistantMessages: (components['schemas']['AssistantTextMessage'] | components['schemas']['AssistantTitleMessage'] | components['schemas']['AssistantSingleSelectMessage'] | components['schemas']['AssistantMultiSelectMessage'] | components['schemas']['AssistantExitToChatMessage'] | components['schemas']['AssistantExitToPhoneMessage'] | components['schemas']['AssistantRecommendationMessage'] | components['schemas']['AssistantRecommendationMessageV2'] | components['schemas']['AssistantConversationIdMessage'] | components['schemas']['AssistantExitToPurchaseMessage'] | components['schemas']['AssistantExitToPurchaseMessageV2'])[];
503
623
  };
504
624
  /** HTTPValidationError */
505
625
  HTTPValidationError: {
@@ -523,6 +643,43 @@ interface components {
523
643
  /** @description The original price of the product or bundle, only set if it's currently discounted. */
524
644
  previousPriceDetails?: components['schemas']['ProductPriceDetails'] | null;
525
645
  };
646
+ /**
647
+ * LocalisationOutcome
648
+ * @description The normalised result of an address check.
649
+ *
650
+ * These string values are a contract with the frontend, which branches on them. Partners
651
+ * describe serviceability in their own vocabulary; every provider maps onto these six.
652
+ * @enum {string}
653
+ */
654
+ LocalisationOutcome: 'resolved' | 'needs_unit' | 'no_match' | 'not_serviceable' | 'not_eligible' | 'needs_human';
655
+ /**
656
+ * LocalisationResult
657
+ * @description A provider's answer, normalised.
658
+ *
659
+ * The eligibility fields mirror `conversationContext` (`platform_py_contracts` `context_v1`) —
660
+ * the shapes have to agree.
661
+ *
662
+ * `isLocalised` is set explicitly, never defaulted: the contract treats absent as localised, so
663
+ * a `None` on an unresolved address would widen eligibility instead of narrowing it.
664
+ *
665
+ * Support for all three eligibility lists is carried, because `conversationContext` defines all three:
666
+ * `eligibleProducts`, `eligibleBundles` and `eligibleOffers`.
667
+ *
668
+ * `exitToPhoneNumber` is the number to show when the user has to call to get any further.
669
+ */
670
+ LocalisationResult: {
671
+ outcome: components['schemas']['LocalisationOutcome'];
672
+ /** Islocalised */
673
+ isLocalised?: boolean | null;
674
+ /** Eligibleproducts */
675
+ eligibleProducts?: string[] | null;
676
+ /** Eligiblebundles */
677
+ eligibleBundles?: string[] | null;
678
+ /** Eligibleoffers */
679
+ eligibleOffers?: string[] | null;
680
+ /** Exittophonenumber */
681
+ exitToPhoneNumber?: string | null;
682
+ };
526
683
  /**
527
684
  * Offer
528
685
  * @description Offer details
@@ -799,16 +956,22 @@ interface components {
799
956
  * Conversationid
800
957
  * Format: uuid
801
958
  * @description The conversation id
959
+ * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
802
960
  */
803
961
  conversationId: string;
804
962
  /**
805
963
  * Usermessage
806
964
  * @description The user message
965
+ * @example Hello
807
966
  */
808
967
  userMessage?: string | null;
809
968
  /**
810
969
  * Options
811
970
  * @description Which select options were picked?
971
+ * @example [
972
+ * "12345",
973
+ * "67890"
974
+ * ]
812
975
  */
813
976
  options: string[];
814
977
  };
@@ -823,17 +986,20 @@ interface components {
823
986
  /**
824
987
  * Usermessage
825
988
  * @description The user message
989
+ * @example Hello
826
990
  */
827
991
  userMessage?: string | null;
828
992
  /**
829
993
  * Option
830
994
  * @description Which select option was picked?
995
+ * @example 12345
831
996
  */
832
997
  option?: string | null;
833
998
  /**
834
999
  * Conversationid
835
1000
  * Format: uuid
836
1001
  * @description The conversation id
1002
+ * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
837
1003
  */
838
1004
  conversationId: string;
839
1005
  };
@@ -868,11 +1034,13 @@ interface components {
868
1034
  * Conversationid
869
1035
  * Format: uuid
870
1036
  * @description The conversation id
1037
+ * @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
871
1038
  */
872
1039
  conversationId: string;
873
1040
  /**
874
1041
  * Usermessage
875
1042
  * @description The user message
1043
+ * @example Hello
876
1044
  */
877
1045
  userMessage: string;
878
1046
  };
@@ -925,6 +1093,13 @@ interface operations {
925
1093
  [name: string]: unknown;
926
1094
  };
927
1095
  content: {
1096
+ /**
1097
+ * @example {
1098
+ * "code": "ERROR_UNHANDLED",
1099
+ * "message": "An error occurred",
1100
+ * "detail": "Access forbidden"
1101
+ * }
1102
+ */
928
1103
  'application/json': unknown;
929
1104
  };
930
1105
  };
@@ -972,7 +1147,7 @@ interface operations {
972
1147
  [name: string]: unknown;
973
1148
  };
974
1149
  content: {
975
- 'application/json': (components['schemas']['AssistantTextMessage'] | components['schemas']['AssistantSingleSelectMessage'] | components['schemas']['AssistantMultiSelectMessage'] | components['schemas']['AssistantExitToChatMessage'] | components['schemas']['AssistantExitToPhoneMessage'] | components['schemas']['AssistantRecommendationMessage'] | components['schemas']['AssistantRecommendationMessageV2'] | components['schemas']['AssistantConversationIdMessage'] | components['schemas']['AssistantExitToPurchaseMessage'] | components['schemas']['AssistantExitToPurchaseMessageV2'])[];
1150
+ 'application/json': (components['schemas']['AssistantTextMessage'] | components['schemas']['AssistantTitleMessage'] | components['schemas']['AssistantSingleSelectMessage'] | components['schemas']['AssistantMultiSelectMessage'] | components['schemas']['AssistantExitToChatMessage'] | components['schemas']['AssistantExitToPhoneMessage'] | components['schemas']['AssistantRecommendationMessage'] | components['schemas']['AssistantRecommendationMessageV2'] | components['schemas']['AssistantConversationIdMessage'] | components['schemas']['AssistantExitToPurchaseMessage'] | components['schemas']['AssistantExitToPurchaseMessageV2'])[];
976
1151
  };
977
1152
  };
978
1153
  /** @description The user is not authorized to access the requested data */
@@ -981,6 +1156,13 @@ interface operations {
981
1156
  [name: string]: unknown;
982
1157
  };
983
1158
  content: {
1159
+ /**
1160
+ * @example {
1161
+ * "code": "ERROR_UNHANDLED",
1162
+ * "message": "An error occurred",
1163
+ * "detail": "Unauthorized access"
1164
+ * }
1165
+ */
984
1166
  'application/json': unknown;
985
1167
  };
986
1168
  };
@@ -990,6 +1172,13 @@ interface operations {
990
1172
  [name: string]: unknown;
991
1173
  };
992
1174
  content: {
1175
+ /**
1176
+ * @example {
1177
+ * "code": "ERROR_UNHANDLED",
1178
+ * "message": "An error occurred",
1179
+ * "detail": "Access forbidden"
1180
+ * }
1181
+ */
993
1182
  'application/json': unknown;
994
1183
  };
995
1184
  };
@@ -999,6 +1188,13 @@ interface operations {
999
1188
  [name: string]: unknown;
1000
1189
  };
1001
1190
  content: {
1191
+ /**
1192
+ * @example {
1193
+ * "code": "ERROR_UNHANDLED",
1194
+ * "message": "An error occurred",
1195
+ * "detail": "Customer 1234 not found"
1196
+ * }
1197
+ */
1002
1198
  'application/json': unknown;
1003
1199
  };
1004
1200
  };
@@ -1008,9 +1204,123 @@ interface operations {
1008
1204
  [name: string]: unknown;
1009
1205
  };
1010
1206
  content: {
1207
+ /**
1208
+ * @example {
1209
+ * "code": "ERROR_UNHANDLED",
1210
+ * "message": "An error occurred",
1211
+ * "detail": {
1212
+ * "loc": [
1213
+ * "string",
1214
+ * 0
1215
+ * ],
1216
+ * "msg": "string",
1217
+ * "type": "string"
1218
+ * }
1219
+ * }
1220
+ */
1221
+ 'application/json': unknown;
1222
+ };
1223
+ };
1224
+ };
1225
+ };
1226
+ resolve_localisation_api_localisation_v1_post: {
1227
+ parameters: {
1228
+ query?: never;
1229
+ header?: {
1230
+ /** @description Comma-separated list of feature flags (flags might require elevated permissions) */
1231
+ 'x-feature-flags'?: string | null;
1232
+ };
1233
+ path?: never;
1234
+ cookie?: never;
1235
+ };
1236
+ requestBody: {
1237
+ content: {
1238
+ 'application/json': components['schemas']['Address'];
1239
+ };
1240
+ };
1241
+ responses: {
1242
+ /** @description Successful Response */
1243
+ 200: {
1244
+ headers: {
1245
+ [name: string]: unknown;
1246
+ };
1247
+ content: {
1248
+ 'application/json': components['schemas']['LocalisationResult'];
1249
+ };
1250
+ };
1251
+ /** @description Localisation is not configured for this customer */
1252
+ 400: {
1253
+ headers: {
1254
+ [name: string]: unknown;
1255
+ };
1256
+ content: {
1257
+ /**
1258
+ * @example {
1259
+ * "code": "ERROR_UNHANDLED",
1260
+ * "message": "An error occurred",
1261
+ * "detail": "No localisation configuration for this customer"
1262
+ * }
1263
+ */
1011
1264
  'application/json': unknown;
1012
1265
  };
1013
1266
  };
1267
+ /** @description The user is not authorized to access the requested data */
1268
+ 401: {
1269
+ headers: {
1270
+ [name: string]: unknown;
1271
+ };
1272
+ content: {
1273
+ /**
1274
+ * @example {
1275
+ * "code": "ERROR_UNHANDLED",
1276
+ * "message": "An error occurred",
1277
+ * "detail": "Unauthorized access"
1278
+ * }
1279
+ */
1280
+ 'application/json': unknown;
1281
+ };
1282
+ };
1283
+ /** @description The feature flags supplied require elevated access */
1284
+ 403: {
1285
+ headers: {
1286
+ [name: string]: unknown;
1287
+ };
1288
+ content: {
1289
+ /**
1290
+ * @example {
1291
+ * "code": "ERROR_UNHANDLED",
1292
+ * "message": "An error occurred",
1293
+ * "detail": "Access denied for feature flags: localisation_stub_outcome"
1294
+ * }
1295
+ */
1296
+ 'application/json': unknown;
1297
+ };
1298
+ };
1299
+ /** @description The customer config was not found */
1300
+ 404: {
1301
+ headers: {
1302
+ [name: string]: unknown;
1303
+ };
1304
+ content: {
1305
+ /**
1306
+ * @example {
1307
+ * "code": "ERROR_UNHANDLED",
1308
+ * "message": "An error occurred",
1309
+ * "detail": "Customer 1234 not found"
1310
+ * }
1311
+ */
1312
+ 'application/json': unknown;
1313
+ };
1314
+ };
1315
+ /** @description Validation Error */
1316
+ 422: {
1317
+ headers: {
1318
+ [name: string]: unknown;
1319
+ };
1320
+ content: {
1321
+ 'application/json': components['schemas']['HTTPValidationError'];
1322
+ };
1323
+ };
1014
1324
  };
1015
1325
  };
1016
1326
  }
@@ -1043,53 +1353,68 @@ interface paths {
1043
1353
  requestBody: {
1044
1354
  content: {
1045
1355
  'application/json': {
1046
- /** @description A 36 character alphanumeric hash that uniquely identifies a user.
1356
+ /**
1357
+ * @description A 36 character alphanumeric hash that uniquely identifies a user.
1047
1358
  *
1048
1359
  *
1049
1360
  * This should match the UUID V4 as specified in RFC 9652:
1050
1361
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1051
1362
  *
1052
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1363
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1364
+ * @example f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1365
+ */
1053
1366
  userId?: string;
1054
- /** @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" */
1367
+ /**
1368
+ * @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"
1369
+ * @example 2024-07-17T10:11:16.591Z
1370
+ */
1055
1371
  eventAt?: string;
1056
1372
  /** @description The page url at the time the event is fired */
1057
1373
  url?: string;
1058
- /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1374
+ /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1059
1375
  browser?: string;
1060
1376
  /** @description The customer that the event occurred on */
1061
1377
  customerId: string;
1062
1378
  /** @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" */
1063
1379
  userAgent?: string;
1064
- /** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1380
+ /**
1381
+ * @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1065
1382
  *
1066
1383
  * This should match the UUID V4 as specified in RFC 9652:
1067
1384
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1068
1385
  *
1069
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1386
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1387
+ * @example f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1388
+ */
1070
1389
  eventId?: string;
1071
1390
  /**
1072
1391
  * @description The name of an event
1392
+ * @example assistantMessage-submitted
1073
1393
  * @enum {string}
1074
1394
  */
1075
1395
  eventName?: 'sale-completed';
1076
- /** @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1396
+ /**
1397
+ * @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1077
1398
  *
1078
1399
  * This should match the UUID V4 as specified in RFC 9652:
1079
1400
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1080
1401
  *
1081
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1402
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1403
+ * @example f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1404
+ */
1082
1405
  pageviewId?: string | null;
1083
1406
  /** @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. */
1084
1407
  webAnalyticsPlatformUserId?: string | null;
1085
- /** @description A 36 character alphanumeric hash that uniquely identifies a session.
1408
+ /**
1409
+ * @description A 36 character alphanumeric hash that uniquely identifies a session.
1086
1410
  *
1087
1411
  *
1088
1412
  * This should match the UUID V4 as specified in RFC 9652:
1089
1413
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1090
1414
  *
1091
1415
  * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1092
- * */
1416
+ * @example
1417
+ */
1093
1418
  browserSessionId?: string | null;
1094
1419
  /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1095
1420
  screenWidth?: number;
@@ -1140,7 +1465,6 @@ interface paths {
1140
1465
  *
1141
1466
  * In the case of an authenticated backend-backend connection, the value will be 'backend'.
1142
1467
  * In the case of an unauthenticated browser client sending us the event, the value will be 'frontend'.
1143
- *
1144
1468
  * @enum {string}
1145
1469
  */
1146
1470
  salesTrackingOrigin?: 'backend' | 'frontend';
@@ -1161,29 +1485,22 @@ interface paths {
1161
1485
  customerConfigurationVersion?: string | null;
1162
1486
  /** @description The version number for the client library our customers are using */
1163
1487
  sdkVersion?: string | null;
1164
- /** @description The version number for the deployed code in the product config service */
1488
+ /** @description The version number for the product configuration data */
1165
1489
  productConfigurationVersion?: string | null;
1166
1490
  /** @description The version number for the sales tracking api service. *in the short term this is technically just the frontend so will match that */
1167
1491
  salesTrackingApiVersion?: string | null;
1168
1492
  /** @description The version number for the recommender service */
1169
1493
  recommenderVersion?: string | null;
1170
- /**
1171
- * @description A 36 character alphanumeric hash that uniquely identifies a product feed update. Identifies the product feed update whose catalogue data was in use when the event fired, so conversation and recommendation activity can be attributed to a specific feed update. Not sent when no feed update id is available for the request.
1172
- *
1173
- * This should match the UUID format as specified in RFC 9562:
1174
- * https://datatracker.ietf.org/doc/html/rfc9562
1175
- *
1176
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1177
- * @example f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1178
- */
1179
- productFeedUpdateId?: string | null;
1180
1494
  };
1181
1495
  /**
1182
1496
  * @description The environment the event originated from (production/development/testing/staging/local/uat/ephemeral)
1183
1497
  * @enum {string}
1184
1498
  */
1185
1499
  environment?: 'development' | 'ephemeral' | 'local' | 'production' | 'staging' | 'test' | 'uat';
1186
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1500
+ /**
1501
+ * @description A JWT used to identify the user in the system, can be obtained from the identity endpoint
1502
+ * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiY3VzdG9tZXJJZCIsInNlc3Npb25JZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsInVzZXJJZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsImlhdCI6MTc0MzY3Mzc1OCwiZXhwIjoxNzQ2MjY1NzU4fQ.iD3cXMjnTVxw0TsfEAyi4vEtomGY8RJ9ZMHNa4mngvc
1503
+ */
1187
1504
  identityToken?: string | null;
1188
1505
  } | {
1189
1506
  /**
@@ -1191,9 +1508,15 @@ interface paths {
1191
1508
  * @enum {string}
1192
1509
  */
1193
1510
  customerId: 'aidem';
1194
- /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1511
+ /**
1512
+ * @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC
1513
+ * @example 2025-04-01T09:44:16.591Z
1514
+ */
1195
1515
  eventAt?: string;
1196
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1516
+ /**
1517
+ * @description A JWT used to identify the user in the system, can be obtained from the identity endpoint
1518
+ * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiY3VzdG9tZXJJZCIsInNlc3Npb25JZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsInVzZXJJZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsImlhdCI6MTc0MzY3Mzc1OCwiZXhwIjoxNzQ2MjY1NzU4fQ.iD3cXMjnTVxw0TsfEAyi4vEtomGY8RJ9ZMHNa4mngvc
1519
+ */
1197
1520
  identityToken?: string | null;
1198
1521
  /** @description The ID for the sale, a unique value we can correlate with customer records. */
1199
1522
  saleId: string;
@@ -1202,7 +1525,12 @@ interface paths {
1202
1525
  * @enum {string}
1203
1526
  */
1204
1527
  userType: 'existing' | 'prospect';
1205
- /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1528
+ /**
1529
+ * @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc.
1530
+ * @example Chrome
1531
+ * @example Firefox
1532
+ * @example Safari
1533
+ */
1206
1534
  browser?: string;
1207
1535
  /** @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" */
1208
1536
  userAgent?: string;
@@ -1220,7 +1548,12 @@ interface paths {
1220
1548
  * @enum {string}
1221
1549
  */
1222
1550
  screenSize?: 'mobile' | 'large';
1223
- /** @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes. */
1551
+ /**
1552
+ * @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes.
1553
+ * @example USD
1554
+ * @example GBP
1555
+ * @example EUR
1556
+ */
1224
1557
  currencyCode?: string;
1225
1558
  /** @description The host/domain of the URL at the time the event is fired */
1226
1559
  siteHost: string;
@@ -1228,11 +1561,22 @@ interface paths {
1228
1561
  sitePath?: string;
1229
1562
  /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1230
1563
  siteQueryString?: string;
1231
- /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc. */
1564
+ /**
1565
+ * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc.
1566
+ * @example en-us
1567
+ * @example es-us
1568
+ */
1232
1569
  language?: string;
1233
1570
  /** @description The recurring payment due per payment period */
1234
1571
  priceRecurring: number;
1235
- /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1572
+ /**
1573
+ * @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over
1574
+ * @example P1Y
1575
+ * @example P1M
1576
+ * @example P4W
1577
+ * @example P1D
1578
+ * @example P30D
1579
+ */
1236
1580
  priceRecurringPeriod: string;
1237
1581
  /** @description The upfront price the user has to pay for the product. */
1238
1582
  priceUpfront?: number;
@@ -1251,7 +1595,14 @@ interface paths {
1251
1595
  siteProductName: string;
1252
1596
  /** @description The category of products the product belongs to. */
1253
1597
  siteProductType: string;
1254
- /** @description An ISO-8601 duration that represents the contract length */
1598
+ /**
1599
+ * @description An ISO-8601 duration that represents the contract length
1600
+ * @example P1Y
1601
+ * @example P1M
1602
+ * @example P4W
1603
+ * @example P1D
1604
+ * @example P30D
1605
+ */
1255
1606
  productContractLength: string;
1256
1607
  /** @description An integer representing how many of this particular product the user is purchasing */
1257
1608
  quantity: number;
@@ -1259,7 +1610,14 @@ interface paths {
1259
1610
  productPriceUpfront: number;
1260
1611
  /** @description The recurring payment per payment period for the product */
1261
1612
  productPricePerPeriod: number;
1262
- /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1613
+ /**
1614
+ * @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over
1615
+ * @example P1Y
1616
+ * @example P1M
1617
+ * @example P4W
1618
+ * @example P1D
1619
+ * @example P30D
1620
+ */
1263
1621
  productRecurringPaymentPeriod: string;
1264
1622
  /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1265
1623
  bundleId?: string;
@@ -1272,9 +1630,15 @@ interface paths {
1272
1630
  * @enum {string}
1273
1631
  */
1274
1632
  customerId: 'spectrum-us-media-consumer-en';
1275
- /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1633
+ /**
1634
+ * @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC
1635
+ * @example 2025-04-01T09:44:16.591Z
1636
+ */
1276
1637
  eventAt?: string;
1277
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1638
+ /**
1639
+ * @description A JWT used to identify the user in the system, can be obtained from the identity endpoint
1640
+ * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiY3VzdG9tZXJJZCIsInNlc3Npb25JZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsInVzZXJJZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsImlhdCI6MTc0MzY3Mzc1OCwiZXhwIjoxNzQ2MjY1NzU4fQ.iD3cXMjnTVxw0TsfEAyi4vEtomGY8RJ9ZMHNa4mngvc
1641
+ */
1278
1642
  identityToken?: string | null;
1279
1643
  /** @description The ID for the sale, a unique value we can correlate with customer records. */
1280
1644
  saleId: string;
@@ -1283,7 +1647,12 @@ interface paths {
1283
1647
  * @enum {string}
1284
1648
  */
1285
1649
  userType: 'existing' | 'prospect';
1286
- /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1650
+ /**
1651
+ * @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc.
1652
+ * @example Chrome
1653
+ * @example Firefox
1654
+ * @example Safari
1655
+ */
1287
1656
  browser?: string;
1288
1657
  /** @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" */
1289
1658
  userAgent?: string;
@@ -1301,7 +1670,12 @@ interface paths {
1301
1670
  * @enum {string}
1302
1671
  */
1303
1672
  screenSize?: 'mobile' | 'large';
1304
- /** @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes. */
1673
+ /**
1674
+ * @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes.
1675
+ * @example USD
1676
+ * @example GBP
1677
+ * @example EUR
1678
+ */
1305
1679
  currencyCode?: string;
1306
1680
  /** @description The host/domain of the URL at the time the event is fired */
1307
1681
  siteHost: string;
@@ -1309,11 +1683,22 @@ interface paths {
1309
1683
  sitePath?: string;
1310
1684
  /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1311
1685
  siteQueryString?: string;
1312
- /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc. */
1686
+ /**
1687
+ * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc.
1688
+ * @example en-us
1689
+ * @example es-us
1690
+ */
1313
1691
  language?: string;
1314
1692
  /** @description The recurring payment due per payment period */
1315
1693
  priceRecurring: number;
1316
- /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1694
+ /**
1695
+ * @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over
1696
+ * @example P1Y
1697
+ * @example P1M
1698
+ * @example P4W
1699
+ * @example P1D
1700
+ * @example P30D
1701
+ */
1317
1702
  priceRecurringPeriod: string;
1318
1703
  /** @description The upfront price the user has to pay for the product. */
1319
1704
  priceUpfront?: number;
@@ -1332,7 +1717,14 @@ interface paths {
1332
1717
  siteProductName: string;
1333
1718
  /** @description The category of products the product belongs to. */
1334
1719
  siteProductType: string;
1335
- /** @description An ISO-8601 duration that represents the contract length */
1720
+ /**
1721
+ * @description An ISO-8601 duration that represents the contract length
1722
+ * @example P1Y
1723
+ * @example P1M
1724
+ * @example P4W
1725
+ * @example P1D
1726
+ * @example P30D
1727
+ */
1336
1728
  productContractLength: string;
1337
1729
  /** @description An integer representing how many of this particular product the user is purchasing */
1338
1730
  quantity: number;
@@ -1340,7 +1732,14 @@ interface paths {
1340
1732
  productPriceUpfront: number;
1341
1733
  /** @description The recurring payment per payment period for the product */
1342
1734
  productPricePerPeriod: number;
1343
- /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1735
+ /**
1736
+ * @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over
1737
+ * @example P1Y
1738
+ * @example P1M
1739
+ * @example P4W
1740
+ * @example P1D
1741
+ * @example P30D
1742
+ */
1344
1743
  productRecurringPaymentPeriod: string;
1345
1744
  /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1346
1745
  bundleId?: string;
@@ -1353,9 +1752,15 @@ interface paths {
1353
1752
  * @enum {string}
1354
1753
  */
1355
1754
  customerId: 'o2-gb-telco-consumer-en';
1356
- /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1755
+ /**
1756
+ * @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC
1757
+ * @example 2025-04-01T09:44:16.591Z
1758
+ */
1357
1759
  eventAt?: string;
1358
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1760
+ /**
1761
+ * @description A JWT used to identify the user in the system, can be obtained from the identity endpoint
1762
+ * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiY3VzdG9tZXJJZCIsInNlc3Npb25JZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsInVzZXJJZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsImlhdCI6MTc0MzY3Mzc1OCwiZXhwIjoxNzQ2MjY1NzU4fQ.iD3cXMjnTVxw0TsfEAyi4vEtomGY8RJ9ZMHNa4mngvc
1763
+ */
1359
1764
  identityToken?: string | null;
1360
1765
  /** @description The ID for the sale, a unique value we can correlate with customer records. */
1361
1766
  saleId: string;
@@ -1364,7 +1769,12 @@ interface paths {
1364
1769
  * @enum {string}
1365
1770
  */
1366
1771
  userType: 'existing' | 'prospect';
1367
- /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1772
+ /**
1773
+ * @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc.
1774
+ * @example Chrome
1775
+ * @example Firefox
1776
+ * @example Safari
1777
+ */
1368
1778
  browser?: string;
1369
1779
  /** @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" */
1370
1780
  userAgent?: string;
@@ -1382,7 +1792,12 @@ interface paths {
1382
1792
  * @enum {string}
1383
1793
  */
1384
1794
  screenSize?: 'mobile' | 'large';
1385
- /** @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes. */
1795
+ /**
1796
+ * @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes.
1797
+ * @example USD
1798
+ * @example GBP
1799
+ * @example EUR
1800
+ */
1386
1801
  currencyCode?: string;
1387
1802
  /** @description The host/domain of the URL at the time the event is fired */
1388
1803
  siteHost?: string;
@@ -1390,11 +1805,22 @@ interface paths {
1390
1805
  sitePath?: string;
1391
1806
  /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1392
1807
  siteQueryString?: string;
1393
- /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc. */
1808
+ /**
1809
+ * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc.
1810
+ * @example en-us
1811
+ * @example es-us
1812
+ */
1394
1813
  language?: string;
1395
1814
  /** @description The recurring payment due per payment period */
1396
1815
  priceRecurring?: number;
1397
- /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1816
+ /**
1817
+ * @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over
1818
+ * @example P1Y
1819
+ * @example P1M
1820
+ * @example P4W
1821
+ * @example P1D
1822
+ * @example P30D
1823
+ */
1398
1824
  priceRecurringPeriod?: string;
1399
1825
  /** @description The upfront price the user has to pay for the product. */
1400
1826
  priceUpfront?: number;
@@ -1413,7 +1839,14 @@ interface paths {
1413
1839
  siteProductName: string;
1414
1840
  /** @description The category of products the product belongs to. */
1415
1841
  siteProductType: string;
1416
- /** @description An ISO-8601 duration that represents the contract length */
1842
+ /**
1843
+ * @description An ISO-8601 duration that represents the contract length
1844
+ * @example P1Y
1845
+ * @example P1M
1846
+ * @example P4W
1847
+ * @example P1D
1848
+ * @example P30D
1849
+ */
1417
1850
  productContractLength: string;
1418
1851
  /** @description An integer representing how many of this particular product the user is purchasing */
1419
1852
  quantity: number;
@@ -1421,7 +1854,14 @@ interface paths {
1421
1854
  productPriceUpfront: number;
1422
1855
  /** @description The recurring payment per payment period for the product */
1423
1856
  productPricePerPeriod: number;
1424
- /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1857
+ /**
1858
+ * @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over
1859
+ * @example P1Y
1860
+ * @example P1M
1861
+ * @example P4W
1862
+ * @example P1D
1863
+ * @example P30D
1864
+ */
1425
1865
  productRecurringPaymentPeriod: string;
1426
1866
  /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1427
1867
  bundleId?: string;
@@ -1434,9 +1874,15 @@ interface paths {
1434
1874
  * @enum {string}
1435
1875
  */
1436
1876
  customerId: 'vodafone-gb-media-consumer-en';
1437
- /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1877
+ /**
1878
+ * @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC
1879
+ * @example 2025-04-01T09:44:16.591Z
1880
+ */
1438
1881
  eventAt?: string;
1439
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1882
+ /**
1883
+ * @description A JWT used to identify the user in the system, can be obtained from the identity endpoint
1884
+ * @example eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21lcklkIjoiY3VzdG9tZXJJZCIsInNlc3Npb25JZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsInVzZXJJZCI6Inh4eHh4eHh4LXh4eHgteHh4eC14eHh4LXh4eHh4eHh4eHh4eCIsImlhdCI6MTc0MzY3Mzc1OCwiZXhwIjoxNzQ2MjY1NzU4fQ.iD3cXMjnTVxw0TsfEAyi4vEtomGY8RJ9ZMHNa4mngvc
1885
+ */
1440
1886
  identityToken?: string | null;
1441
1887
  /** @description The ID for the sale, a unique value we can correlate with customer records. */
1442
1888
  saleId: string;
@@ -1445,7 +1891,12 @@ interface paths {
1445
1891
  * @enum {string}
1446
1892
  */
1447
1893
  userType: 'existing' | 'prospect';
1448
- /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1894
+ /**
1895
+ * @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc.
1896
+ * @example Chrome
1897
+ * @example Firefox
1898
+ * @example Safari
1899
+ */
1449
1900
  browser?: string;
1450
1901
  /** @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" */
1451
1902
  userAgent?: string;
@@ -1463,7 +1914,12 @@ interface paths {
1463
1914
  * @enum {string}
1464
1915
  */
1465
1916
  screenSize?: 'mobile' | 'large';
1466
- /** @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes. */
1917
+ /**
1918
+ * @description "A code that represents what currency the product price is listed in e.g. USD, GBP. This should match the ISO 4217 standard - see https://www.iban.com/currency-codes.
1919
+ * @example USD
1920
+ * @example GBP
1921
+ * @example EUR
1922
+ */
1467
1923
  currencyCode?: string;
1468
1924
  /** @description The host/domain of the URL at the time the event is fired */
1469
1925
  siteHost: string;
@@ -1471,11 +1927,22 @@ interface paths {
1471
1927
  sitePath?: string;
1472
1928
  /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1473
1929
  siteQueryString?: string;
1474
- /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc. */
1930
+ /**
1931
+ * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en-us', 'es-us' etc.
1932
+ * @example en-us
1933
+ * @example es-us
1934
+ */
1475
1935
  language?: string;
1476
1936
  /** @description The recurring payment due per payment period */
1477
1937
  priceRecurring: number;
1478
- /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1938
+ /**
1939
+ * @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over
1940
+ * @example P1Y
1941
+ * @example P1M
1942
+ * @example P4W
1943
+ * @example P1D
1944
+ * @example P30D
1945
+ */
1479
1946
  priceRecurringPeriod: string;
1480
1947
  /** @description The upfront price the user has to pay for the product. */
1481
1948
  priceUpfront?: number;
@@ -1494,7 +1961,14 @@ interface paths {
1494
1961
  siteProductName: string;
1495
1962
  /** @description The category of products the product belongs to. */
1496
1963
  siteProductType: string;
1497
- /** @description An ISO-8601 duration that represents the contract length */
1964
+ /**
1965
+ * @description An ISO-8601 duration that represents the contract length
1966
+ * @example P1Y
1967
+ * @example P1M
1968
+ * @example P4W
1969
+ * @example P1D
1970
+ * @example P30D
1971
+ */
1498
1972
  productContractLength: string;
1499
1973
  /** @description An integer representing how many of this particular product the user is purchasing */
1500
1974
  quantity: number;
@@ -1502,7 +1976,14 @@ interface paths {
1502
1976
  productPriceUpfront: number;
1503
1977
  /** @description The recurring payment per payment period for the product */
1504
1978
  productPricePerPeriod: number;
1505
- /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1979
+ /**
1980
+ * @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over
1981
+ * @example P1Y
1982
+ * @example P1M
1983
+ * @example P4W
1984
+ * @example P1D
1985
+ * @example P30D
1986
+ */
1506
1987
  productRecurringPaymentPeriod: string;
1507
1988
  /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1508
1989
  bundleId?: string;
@@ -1663,6 +2144,14 @@ interface paths {
1663
2144
  [name: string]: unknown;
1664
2145
  };
1665
2146
  content: {
2147
+ /**
2148
+ * @example {
2149
+ * "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
2150
+ * "sessionId": "2f6863a9-2833-5521-a45d-359dcdfd154a",
2151
+ * "userId": "163a692e-8ee2-623f-9927-0bb563b19853",
2152
+ * "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
2153
+ * }
2154
+ */
1666
2155
  'application/json': {
1667
2156
  /**
1668
2157
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
@@ -1715,7 +2204,8 @@ interface paths {
1715
2204
  /** @description User tracking event data */
1716
2205
  requestBody: {
1717
2206
  content: {
1718
- /** @example {
2207
+ /**
2208
+ * @example {
1719
2209
  * "conversationId": "386d85d7-9daa-8a87-85d4-3f93c990b292",
1720
2210
  * "eventName": "entry_point-shown",
1721
2211
  * "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
@@ -1724,80 +2214,89 @@ interface paths {
1724
2214
  * "screenWidth": 390,
1725
2215
  * "url": "https://www.example.com/telco/",
1726
2216
  * "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.210 Mobile Safari/537.36"
1727
- * } */
2217
+ * }
2218
+ */
1728
2219
  'application/json': {
1729
2220
  additionalProperties?: {
1730
- /** @description A 36 character alphanumeric hash that uniquely identifies a user.
2221
+ /**
2222
+ * @description A 36 character alphanumeric hash that uniquely identifies a user.
1731
2223
  *
1732
2224
  *
1733
2225
  * This should match the UUID V4 as specified in RFC 9652:
1734
2226
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1735
2227
  *
1736
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
2228
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
2229
+ */
1737
2230
  user_id?: string;
1738
2231
  /** @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" */
1739
2232
  event_at?: string;
1740
2233
  /** @description The page url at the time the event is fired */
1741
2234
  url?: string;
1742
- /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
2235
+ /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
1743
2236
  browser?: string;
1744
2237
  /** @description The customer that the event occurred on */
1745
2238
  customer_id?: string;
1746
2239
  /** @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" */
1747
2240
  user_agent?: string;
1748
- /** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
2241
+ /**
2242
+ * @description A 36 character alphanumeric hash that uniquely identifies a tracking event
1749
2243
  *
1750
2244
  * This should match the UUID V4 as specified in RFC 9652:
1751
2245
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1752
2246
  *
1753
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
2247
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
2248
+ */
1754
2249
  event_id?: string;
1755
2250
  /** @description The name of an event */
1756
2251
  event_name?: string;
1757
- /** @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
2252
+ /**
2253
+ * @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
1758
2254
  *
1759
2255
  * This should match the UUID V4 as specified in RFC 9652:
1760
2256
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1761
2257
  *
1762
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
2258
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
2259
+ */
1763
2260
  pageview_id?: string;
1764
2261
  /** @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. */
1765
2262
  web_analytics_platform_user_id?: string | null;
1766
- /** @description A 36 character alphanumeric hash that uniquely identifies a session.
2263
+ /**
2264
+ * @description A 36 character alphanumeric hash that uniquely identifies a session.
1767
2265
  *
1768
2266
  *
1769
2267
  * This should match the UUID V4 as specified in RFC 9652:
1770
2268
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1771
2269
  *
1772
2270
  * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
1773
- * */
2271
+ */
1774
2272
  browser_session_id?: string | null;
1775
2273
  /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1776
2274
  screen_width?: number;
1777
2275
  /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
1778
2276
  screen_height?: number;
1779
- /** @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.
2277
+ /**
2278
+ * @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.
1780
2279
  *
1781
2280
  * Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
1782
2281
  *
1783
2282
  * screen_width <= 480px = 'mobile'
1784
- * screen_width > 480px = 'large' */
2283
+ * screen_width > 480px = 'large'
2284
+ */
1785
2285
  screen_size?: string;
1786
- /** @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
1787
- * */
2286
+ /** @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 */
1788
2287
  entry_point_type?: string;
1789
- /** @description A 36 character alphanumeric hash that uniquely identifies a conversation.
2288
+ /**
2289
+ * @description A 36 character alphanumeric hash that uniquely identifies a conversation.
1790
2290
  *
1791
2291
  * This should match the UUID V4 as specified in RFC 9652:
1792
2292
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1793
2293
  *
1794
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
2294
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
2295
+ */
1795
2296
  conversation_id?: string;
1796
- /** @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.
1797
- * */
2297
+ /** @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. */
1798
2298
  entry_point_shown_reason?: string;
1799
- /** @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
1800
- * */
2299
+ /** @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 */
1801
2300
  entry_point_elements?: unknown[];
1802
2301
  /** @description The name of the system/service that the event originates from */
1803
2302
  service?: string;
@@ -1809,15 +2308,13 @@ interface paths {
1809
2308
  feedback_score_text?: string;
1810
2309
  /** @description An integer representing the rank of the corresponding feedback score. It should always start at 0, even if the number of options changes. */
1811
2310
  feedback_score_num?: number;
1812
- /** @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().
1813
- * */
2311
+ /** @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(). */
1814
2312
  ip_address_hashed?: string;
1815
2313
  /** @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. */
1816
2314
  tool_ui_closed_reason?: string;
1817
2315
  /** @description A list of ids that each correspond to their own recommendation, with all recs in the list being 'exit to purchase-able' or 'exit to chat-able' */
1818
2316
  recommendation_ids_for_exit?: unknown[];
1819
- /** @description A list of product ids that are either what are being passed to the basket, or would be passed over to the basket if a basket add was triggered. If there are multiple products with the same id, they should be separate list items.
1820
- * */
2317
+ /** @description A list of product ids that are either what are being passed to the basket, or would be passed over to the basket if a basket add was triggered. If there are multiple products with the same id, they should be separate list items. */
1821
2318
  product_ids_for_exit?: unknown[];
1822
2319
  /** @description true if the experiment is the main uplift test, false if it isn't. */
1823
2320
  is_main_uplift_experiment?: boolean;
@@ -1829,29 +2326,29 @@ interface paths {
1829
2326
  experiment_variation_name?: string;
1830
2327
  /** @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. */
1831
2328
  entry_point_closed_reason?: string;
1832
- /** @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.
1833
- * */
2329
+ /** @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. */
1834
2330
  suppressed_by?: unknown[];
1835
- /** @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())
1836
- * */
2331
+ /** @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()) */
1837
2332
  suppressed_reason?: unknown[];
1838
2333
  /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1839
2334
  exit_destination_type?: string;
1840
2335
  /** @description Describes whether a user clicked the thumbs up ('positive') or thumbs down ('negative') on the rec card */
1841
2336
  rec_card_feedback_sentiment?: string;
1842
- /** @description A 32 character alphanumeric hash that uniquely identifies a single rec in a recommendation set.
2337
+ /**
2338
+ * @description A 32 character alphanumeric hash that uniquely identifies a single rec in a recommendation set.
1843
2339
  *
1844
2340
  * This should match the UUID V4 as specified in RFC 9652:
1845
2341
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1846
2342
  *
1847
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
2343
+ * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
2344
+ */
1848
2345
  recommendation_id?: string;
1849
- /** @description List of objects that represents the options for single & multiselect questions. */
2346
+ /** @description List of objects that represents the options for single & multiselect questions. */
1850
2347
  message_select_options?: unknown[];
1851
- /** @description The text that was visible to the user on the CTA button
1852
- * */
2348
+ /** @description The text that was visible to the user on the CTA button */
1853
2349
  button_text?: string;
1854
- /** @description The integer turn number in the conversation, starting from 0. Each turn number should equate to a call & response to the conversation API. Except If the Assistant goes first, then it starts on turn 0 and the user starts on turn 1.
2350
+ /**
2351
+ * @description The integer turn number in the conversation, starting from 0. Each turn number should equate to a call & response to the conversation API. Except If the Assistant goes first, then it starts on turn 0 and the user starts on turn 1.
1855
2352
  *
1856
2353
  * EXAMPLES:
1857
2354
  * In the following notation the number is the turn number, and A = Assistant & U = User (the U & A values aren't included in the tracking, We just use them to help us understand the turns)
@@ -1861,10 +2358,8 @@ interface paths {
1861
2358
  *
1862
2359
  * When the user goes first (for example they click a prompt chip or a customer doesn't want an assistant opening message) the turns would be:
1863
2360
  * 0U, 0A, 1U, 1A, 2U, 2A...
1864
- * */
2361
+ */
1865
2362
  conversation_turn_num?: number;
1866
- /** @description The time-on-page threshold the user has just passed, in seconds. Sent as the threshold that fired, not as a live elapsed time, so each value appears at most once per page view. */
1867
- time_on_page_seconds?: string;
1868
2363
  /** @description The reason an exit to chat response was provided by the conversation api */
1869
2364
  exit_to_chat_reason?: string;
1870
2365
  };
@@ -1877,7 +2372,7 @@ interface paths {
1877
2372
  * @description Event Name
1878
2373
  * @enum {string}
1879
2374
  */
1880
- eventName: 'entry_point-shown' | 'feedback_submit-clicked' | 'page-shown' | 'tool_ui-closed' | 'feedback-shown' | 'feedback_skip-clicked' | 'entry_point-clicked' | 'tool_close-clicked' | 'exit_to_chat-completed' | 'exit_to_purchase-completed' | 'experiment_variation-assigned' | 'entry_point-closed' | 'entry_point-suppressed' | 'user-created' | 'exit_to_human-completed' | 'rec_card_feedback-clicked' | 'message_select_option-clicked' | 'rec_card_cta-clicked' | 'exit_to_purchase-shown' | 'exit_to_customer_channel-completed' | 'exit_to_purchase_card_cta-clicked' | 'customisations_screen-shown' | 'time_on_page-elapsed';
2375
+ eventName: 'entry_point-shown' | 'feedback_submit-clicked' | 'page-shown' | 'tool_ui-closed' | 'feedback-shown' | 'feedback_skip-clicked' | 'entry_point-clicked' | 'tool_close-clicked' | 'exit_to_chat-completed' | 'exit_to_purchase-completed' | 'experiment_variation-assigned' | 'entry_point-closed' | 'entry_point-suppressed' | 'user-created' | 'exit_to_human-completed' | 'rec_card_feedback-clicked' | 'message_select_option-clicked' | 'rec_card_cta-clicked' | 'exit_to_purchase-shown' | 'exit_to_customer_channel-completed' | 'exit_to_purchase_card_cta-clicked' | 'customisations_screen-shown';
1881
2376
  /**
1882
2377
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
1883
2378
  * @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
@@ -1978,6 +2473,9 @@ type ApiSingleSelectMessage = Extract<ApiConversationResponse, {
1978
2473
  type ApiTextMessage = Extract<ApiConversationResponse, {
1979
2474
  type: 'MESSAGE';
1980
2475
  }>;
2476
+ type ApiTitleMessage = Extract<ApiConversationResponse, {
2477
+ type: 'TITLE';
2478
+ }>;
1981
2479
  type UserTextMessage = Extract<ApiConversationRequest, {
1982
2480
  type: 'MESSAGE';
1983
2481
  }>;
@@ -2065,7 +2563,7 @@ interface Identity {
2065
2563
  * The message types that the SDK returns.
2066
2564
  * Note that the API response may contain additional types that the SDK does not return.
2067
2565
  */
2068
- type Message = ExitToChatMessage | ExitToPhoneMessage | ExitToPurchaseMessage | ExitToPurchaseV2Message | MultiSelectMessage | RecommendationMessage | RecommendationV2Message | SingleSelectMessage | TextMessage;
2566
+ type Message = ExitToChatMessage | ExitToPhoneMessage | ExitToPurchaseMessage | ExitToPurchaseV2Message | MultiSelectMessage | RecommendationMessage | RecommendationV2Message | SingleSelectMessage | TextMessage | TitleMessage;
2069
2567
  /**
2070
2568
  * A conversation turn as returned by the raw API response.
2071
2569
  */
@@ -2109,6 +2607,8 @@ interface SingleSelectMessage extends ApiSingleSelectMessage {
2109
2607
  }
2110
2608
  interface TextMessage extends ApiTextMessage {
2111
2609
  }
2610
+ interface TitleMessage extends ApiTitleMessage {
2611
+ }
2112
2612
  interface TrackingEvent extends ApiTrackingUserRequest {
2113
2613
  }
2114
2614
 
@@ -2273,11 +2773,10 @@ declare class Client {
2273
2773
  message_select_options?: unknown[];
2274
2774
  button_text?: string;
2275
2775
  conversation_turn_num?: number;
2276
- time_on_page_seconds?: string;
2277
2776
  exit_to_chat_reason?: string;
2278
2777
  };
2279
2778
  conversationId?: string;
2280
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "feedback-shown" | "feedback_skip-clicked" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "experiment_variation-assigned" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "rec_card_feedback-clicked" | "message_select_option-clicked" | "rec_card_cta-clicked" | "exit_to_purchase-shown" | "exit_to_customer_channel-completed" | "exit_to_purchase_card_cta-clicked" | "customisations_screen-shown" | "time_on_page-elapsed";
2779
+ eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "feedback-shown" | "feedback_skip-clicked" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "experiment_variation-assigned" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "rec_card_feedback-clicked" | "message_select_option-clicked" | "rec_card_cta-clicked" | "exit_to_purchase-shown" | "exit_to_customer_channel-completed" | "exit_to_purchase_card_cta-clicked" | "customisations_screen-shown";
2281
2780
  pageviewId: string;
2282
2781
  screenHeight?: number;
2283
2782
  screenSize?: "mobile" | "large";
@@ -2382,4 +2881,4 @@ declare const errorMiddleware: Middleware;
2382
2881
  */
2383
2882
  declare const headerMiddleware: (identity: Identity, url: string) => Middleware;
2384
2883
 
2385
- export { Client, type Config, type ConversationIdMessage, type ConversationTurn, type Endpoint, type ExitToChatMessage, type ExitToPhoneMessage, type ExitToPurchaseMessage, type ExitToPurchaseV2Message, type Identity, type Message, type MultiSelectMessage, type RecommendationMessage, type RecommendationV2Message, type RestoredTurn, SDKError, type SendMessagePayload, type SingleSelectMessage, type TextMessage, type TrackingEvent, type UserSingleSelectMessage, type UserStartConversationMessage, authMiddleware, errorMiddleware, headerMiddleware };
2884
+ export { Client, type Config, type ConversationIdMessage, type ConversationTurn, type Endpoint, type ExitToChatMessage, type ExitToPhoneMessage, type ExitToPurchaseMessage, type ExitToPurchaseV2Message, type Identity, type Message, type MultiSelectMessage, type RecommendationMessage, type RecommendationV2Message, type RestoredTurn, SDKError, type SendMessagePayload, type SingleSelectMessage, type TextMessage, type TitleMessage, type TrackingEvent, type UserSingleSelectMessage, type UserStartConversationMessage, authMiddleware, errorMiddleware, headerMiddleware };