@15gifts/sdk 0.16.2 → 0.16.6
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 +172 -27
- package/dist/index.d.ts +172 -27
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -43,6 +43,7 @@ interface components {
|
|
|
43
43
|
/**
|
|
44
44
|
* Conversationid
|
|
45
45
|
* @description Unique identifier for the conversation. This will be generated once, at the start of a conversation.
|
|
46
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
46
47
|
*/
|
|
47
48
|
conversationId?: string | null;
|
|
48
49
|
};
|
|
@@ -60,6 +61,7 @@ interface components {
|
|
|
60
61
|
/**
|
|
61
62
|
* Fallbackmessage
|
|
62
63
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
64
|
+
* @example Your options are a, b or c
|
|
63
65
|
*/
|
|
64
66
|
fallbackMessage: string;
|
|
65
67
|
/**
|
|
@@ -69,6 +71,12 @@ interface components {
|
|
|
69
71
|
conversationSummary: string;
|
|
70
72
|
/** @description Why have we been exited to chat? */
|
|
71
73
|
reason: components['schemas']['ExitToHumanReason'];
|
|
74
|
+
/**
|
|
75
|
+
* Recommendations
|
|
76
|
+
* @description A list of recommendations the user received from the recommender.
|
|
77
|
+
* @default []
|
|
78
|
+
*/
|
|
79
|
+
recommendations: components['schemas']['RecommendationV2'][];
|
|
72
80
|
};
|
|
73
81
|
/**
|
|
74
82
|
* AssistantExitToPhoneMessage
|
|
@@ -84,6 +92,7 @@ interface components {
|
|
|
84
92
|
/**
|
|
85
93
|
* Fallbackmessage
|
|
86
94
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
95
|
+
* @example Your options are a, b or c
|
|
87
96
|
*/
|
|
88
97
|
fallbackMessage: string;
|
|
89
98
|
/** @description Why have we been exited to phone? */
|
|
@@ -98,6 +107,8 @@ interface components {
|
|
|
98
107
|
* @description The phone number to dial
|
|
99
108
|
*/
|
|
100
109
|
linkPhone: string;
|
|
110
|
+
/** Linktitle */
|
|
111
|
+
linkTitle?: string | null;
|
|
101
112
|
};
|
|
102
113
|
/**
|
|
103
114
|
* AssistantExitToPurchaseMessage
|
|
@@ -113,6 +124,7 @@ interface components {
|
|
|
113
124
|
/**
|
|
114
125
|
* Fallbackmessage
|
|
115
126
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
127
|
+
* @example Your options are a, b or c
|
|
116
128
|
*/
|
|
117
129
|
fallbackMessage: string;
|
|
118
130
|
/** Recommendationidforexit */
|
|
@@ -146,6 +158,7 @@ interface components {
|
|
|
146
158
|
/**
|
|
147
159
|
* Fallbackmessage
|
|
148
160
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
161
|
+
* @example Your options are a, b or c
|
|
149
162
|
*/
|
|
150
163
|
fallbackMessage: string;
|
|
151
164
|
/** Recommendationidforexit */
|
|
@@ -179,6 +192,7 @@ interface components {
|
|
|
179
192
|
/**
|
|
180
193
|
* Fallbackmessage
|
|
181
194
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
195
|
+
* @example Your options are a, b or c
|
|
182
196
|
*/
|
|
183
197
|
fallbackMessage: string;
|
|
184
198
|
/**
|
|
@@ -206,6 +220,7 @@ interface components {
|
|
|
206
220
|
/**
|
|
207
221
|
* Fallbackmessage
|
|
208
222
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
223
|
+
* @example Your options are a, b or c
|
|
209
224
|
*/
|
|
210
225
|
fallbackMessage: string;
|
|
211
226
|
/** Recommendations */
|
|
@@ -225,10 +240,13 @@ interface components {
|
|
|
225
240
|
/**
|
|
226
241
|
* Fallbackmessage
|
|
227
242
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
243
|
+
* @example Your options are a, b or c
|
|
228
244
|
*/
|
|
229
245
|
fallbackMessage: string;
|
|
230
246
|
/** Recommendations */
|
|
231
247
|
recommendations: components['schemas']['RecommendationV2'][];
|
|
248
|
+
/** Recommendationbuttontext */
|
|
249
|
+
recommendationButtonText?: string | null;
|
|
232
250
|
};
|
|
233
251
|
/**
|
|
234
252
|
* AssistantSingleSelectMessage
|
|
@@ -244,6 +262,7 @@ interface components {
|
|
|
244
262
|
/**
|
|
245
263
|
* Fallbackmessage
|
|
246
264
|
* @description What should a client render if they do not have a native renderer for this message type?
|
|
265
|
+
* @example Your options are a, b or c
|
|
247
266
|
*/
|
|
248
267
|
fallbackMessage: string;
|
|
249
268
|
/**
|
|
@@ -271,6 +290,7 @@ interface components {
|
|
|
271
290
|
/**
|
|
272
291
|
* Message
|
|
273
292
|
* @description Message for the conversation.
|
|
293
|
+
* @example Hello, how can I help you today?
|
|
274
294
|
*/
|
|
275
295
|
message: string;
|
|
276
296
|
};
|
|
@@ -341,21 +361,43 @@ interface components {
|
|
|
341
361
|
/**
|
|
342
362
|
* Eligibleproducts
|
|
343
363
|
* @description What product IDs is the user eligible for?
|
|
364
|
+
* @example [
|
|
365
|
+
* "12345"
|
|
366
|
+
* ]
|
|
344
367
|
*/
|
|
345
368
|
eligibleProducts?: string[] | null;
|
|
346
369
|
/**
|
|
347
370
|
* Eligiblebundles
|
|
348
371
|
* @description What bundle IDs is the user eligible for?
|
|
372
|
+
* @example [
|
|
373
|
+
* "12345"
|
|
374
|
+
* ]
|
|
349
375
|
*/
|
|
350
376
|
eligibleBundles?: string[] | null;
|
|
351
377
|
/**
|
|
352
378
|
* Eligibleoffers
|
|
353
379
|
* @description What offer IDs is the user eligible for?
|
|
380
|
+
* @example [
|
|
381
|
+
* "PROMO1234"
|
|
382
|
+
* ]
|
|
354
383
|
*/
|
|
355
384
|
eligibleOffers?: string[] | null;
|
|
356
385
|
/**
|
|
357
386
|
* Productoverrides
|
|
358
387
|
* @description The fields to override in the product specs as based on eligibility
|
|
388
|
+
* @example {
|
|
389
|
+
* "INTERNET": {
|
|
390
|
+
* "specifications": {
|
|
391
|
+
* "connectionSpeeds": {
|
|
392
|
+
* "averageDownloadSpeed": {
|
|
393
|
+
* "@type": "AverageDownloadSpeed",
|
|
394
|
+
* "unitText": "Mbps",
|
|
395
|
+
* "value": 100
|
|
396
|
+
* }
|
|
397
|
+
* }
|
|
398
|
+
* }
|
|
399
|
+
* }
|
|
400
|
+
* }
|
|
359
401
|
*/
|
|
360
402
|
productOverrides?: {
|
|
361
403
|
[key: string]: {
|
|
@@ -365,6 +407,21 @@ interface components {
|
|
|
365
407
|
/**
|
|
366
408
|
* Bundleoverrides
|
|
367
409
|
* @description The fields to override in the product specs as based on eligibility
|
|
410
|
+
* @example {
|
|
411
|
+
* "BUNDLEDISCOUNT": {
|
|
412
|
+
* "prices": {
|
|
413
|
+
* "@type": "Standard",
|
|
414
|
+
* "description": "$17.50 per month for 12 months",
|
|
415
|
+
* "monthlyCost": 17.5,
|
|
416
|
+
* "parts": [
|
|
417
|
+
* {
|
|
418
|
+
* "@type": "MonthlyPricePart",
|
|
419
|
+
* "value": 17.5
|
|
420
|
+
* }
|
|
421
|
+
* ]
|
|
422
|
+
* }
|
|
423
|
+
* }
|
|
424
|
+
* }
|
|
368
425
|
*/
|
|
369
426
|
bundleOverrides?: {
|
|
370
427
|
[key: string]: {
|
|
@@ -374,6 +431,14 @@ interface components {
|
|
|
374
431
|
/**
|
|
375
432
|
* Offeroverrides
|
|
376
433
|
* @description The fields to override in the offer specs as based on eligibility
|
|
434
|
+
* @example {
|
|
435
|
+
* "PROMO1234": {
|
|
436
|
+
* "discount": {
|
|
437
|
+
* "description": "Big Summer Blowout (20% off)",
|
|
438
|
+
* "value": 20
|
|
439
|
+
* }
|
|
440
|
+
* }
|
|
441
|
+
* }
|
|
377
442
|
*/
|
|
378
443
|
offerOverrides?: {
|
|
379
444
|
[key: string]: {
|
|
@@ -431,6 +496,11 @@ interface components {
|
|
|
431
496
|
* @description Description of the offer from the feed data
|
|
432
497
|
*/
|
|
433
498
|
description?: string | null;
|
|
499
|
+
/**
|
|
500
|
+
* Type
|
|
501
|
+
* @description The type of the offer
|
|
502
|
+
*/
|
|
503
|
+
type?: string | null;
|
|
434
504
|
};
|
|
435
505
|
/** Product */
|
|
436
506
|
Product: {
|
|
@@ -604,16 +674,22 @@ interface components {
|
|
|
604
674
|
* Conversationid
|
|
605
675
|
* Format: uuid
|
|
606
676
|
* @description The conversation id
|
|
677
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
607
678
|
*/
|
|
608
679
|
conversationId: string;
|
|
609
680
|
/**
|
|
610
681
|
* Usermessage
|
|
611
682
|
* @description The user message
|
|
683
|
+
* @example Hello
|
|
612
684
|
*/
|
|
613
685
|
userMessage?: string | null;
|
|
614
686
|
/**
|
|
615
687
|
* Options
|
|
616
688
|
* @description Which select options were picked?
|
|
689
|
+
* @example [
|
|
690
|
+
* "12345",
|
|
691
|
+
* "67890"
|
|
692
|
+
* ]
|
|
617
693
|
*/
|
|
618
694
|
options: string[];
|
|
619
695
|
};
|
|
@@ -632,16 +708,19 @@ interface components {
|
|
|
632
708
|
* Conversationid
|
|
633
709
|
* Format: uuid
|
|
634
710
|
* @description The conversation id
|
|
711
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
635
712
|
*/
|
|
636
713
|
conversationId: string;
|
|
637
714
|
/**
|
|
638
715
|
* Usermessage
|
|
639
716
|
* @description The user message
|
|
717
|
+
* @example Hello
|
|
640
718
|
*/
|
|
641
719
|
userMessage?: string | null;
|
|
642
720
|
/**
|
|
643
721
|
* Option
|
|
644
722
|
* @description Which select option was picked?
|
|
723
|
+
* @example 12345
|
|
645
724
|
*/
|
|
646
725
|
option?: string | null;
|
|
647
726
|
};
|
|
@@ -658,6 +737,11 @@ interface components {
|
|
|
658
737
|
type: 'START_CONVERSATION';
|
|
659
738
|
/** @description Context information we'll be getting with the request */
|
|
660
739
|
conversationContext: components['schemas']['ConversationContext'];
|
|
740
|
+
/**
|
|
741
|
+
* Openingusermessage
|
|
742
|
+
* @description An optional opening message sent by the user as the very first message, for things such as UI chips in the frontend to prepopulate the conversation
|
|
743
|
+
*/
|
|
744
|
+
openingUserMessage?: components['schemas']['UserTextMessage'] | components['schemas']['UserSingleSelectMessage'] | components['schemas']['UserMultiSelectMessage'] | null;
|
|
661
745
|
};
|
|
662
746
|
/**
|
|
663
747
|
* UserTextMessage
|
|
@@ -674,11 +758,13 @@ interface components {
|
|
|
674
758
|
* Conversationid
|
|
675
759
|
* Format: uuid
|
|
676
760
|
* @description The conversation id
|
|
761
|
+
* @example 15630a82-0e3d-4d1b-ab7d-fb7481a7a344
|
|
677
762
|
*/
|
|
678
763
|
conversationId: string;
|
|
679
764
|
/**
|
|
680
765
|
* Usermessage
|
|
681
766
|
* @description The user message
|
|
767
|
+
* @example Hello
|
|
682
768
|
*/
|
|
683
769
|
userMessage: string;
|
|
684
770
|
};
|
|
@@ -697,7 +783,7 @@ interface operations {
|
|
|
697
783
|
'user-agent'?: string;
|
|
698
784
|
/**
|
|
699
785
|
* @description Comma-separated list of feature flags (flags might require elevated permissions)
|
|
700
|
-
* @example debug,
|
|
786
|
+
* @example debug,feature_1=hello,!feature_2
|
|
701
787
|
*/
|
|
702
788
|
'x-feature-flags'?: string | null;
|
|
703
789
|
/**
|
|
@@ -738,6 +824,13 @@ interface operations {
|
|
|
738
824
|
[name: string]: unknown;
|
|
739
825
|
};
|
|
740
826
|
content: {
|
|
827
|
+
/**
|
|
828
|
+
* @example {
|
|
829
|
+
* "code": "ERROR_UNHANDLED",
|
|
830
|
+
* "message": "An error occurred",
|
|
831
|
+
* "detail": "Unauthorized access"
|
|
832
|
+
* }
|
|
833
|
+
*/
|
|
741
834
|
'application/json': unknown;
|
|
742
835
|
};
|
|
743
836
|
};
|
|
@@ -747,6 +840,13 @@ interface operations {
|
|
|
747
840
|
[name: string]: unknown;
|
|
748
841
|
};
|
|
749
842
|
content: {
|
|
843
|
+
/**
|
|
844
|
+
* @example {
|
|
845
|
+
* "code": "ERROR_UNHANDLED",
|
|
846
|
+
* "message": "An error occurred",
|
|
847
|
+
* "detail": "Access forbidden"
|
|
848
|
+
* }
|
|
849
|
+
*/
|
|
750
850
|
'application/json': unknown;
|
|
751
851
|
};
|
|
752
852
|
};
|
|
@@ -756,6 +856,13 @@ interface operations {
|
|
|
756
856
|
[name: string]: unknown;
|
|
757
857
|
};
|
|
758
858
|
content: {
|
|
859
|
+
/**
|
|
860
|
+
* @example {
|
|
861
|
+
* "code": "ERROR_UNHANDLED",
|
|
862
|
+
* "message": "An error occurred",
|
|
863
|
+
* "detail": "Customer 1234 not found"
|
|
864
|
+
* }
|
|
865
|
+
*/
|
|
759
866
|
'application/json': unknown;
|
|
760
867
|
};
|
|
761
868
|
};
|
|
@@ -765,6 +872,20 @@ interface operations {
|
|
|
765
872
|
[name: string]: unknown;
|
|
766
873
|
};
|
|
767
874
|
content: {
|
|
875
|
+
/**
|
|
876
|
+
* @example {
|
|
877
|
+
* "code": "ERROR_UNHANDLED",
|
|
878
|
+
* "message": "An error occurred",
|
|
879
|
+
* "detail": {
|
|
880
|
+
* "loc": [
|
|
881
|
+
* "string",
|
|
882
|
+
* 0
|
|
883
|
+
* ],
|
|
884
|
+
* "msg": "string",
|
|
885
|
+
* "type": "string"
|
|
886
|
+
* }
|
|
887
|
+
* }
|
|
888
|
+
*/
|
|
768
889
|
'application/json': unknown;
|
|
769
890
|
};
|
|
770
891
|
};
|
|
@@ -845,6 +966,14 @@ interface paths {
|
|
|
845
966
|
[name: string]: unknown;
|
|
846
967
|
};
|
|
847
968
|
content: {
|
|
969
|
+
/**
|
|
970
|
+
* @example {
|
|
971
|
+
* "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
|
|
972
|
+
* "sessionId": "2f6863a9-2833-5521-a45d-359dcdfd154a",
|
|
973
|
+
* "userId": "163a692e-8ee2-623f-9927-0bb563b19853",
|
|
974
|
+
* "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
|
|
975
|
+
* }
|
|
976
|
+
*/
|
|
848
977
|
'application/json': {
|
|
849
978
|
/**
|
|
850
979
|
* @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
|
|
@@ -897,7 +1026,8 @@ interface paths {
|
|
|
897
1026
|
/** @description User tracking event data */
|
|
898
1027
|
requestBody: {
|
|
899
1028
|
content: {
|
|
900
|
-
/**
|
|
1029
|
+
/**
|
|
1030
|
+
* @example {
|
|
901
1031
|
* "conversationId": "386d85d7-9daa-8a87-85d4-3f93c990b292",
|
|
902
1032
|
* "eventName": "entry_point-shown",
|
|
903
1033
|
* "pageviewId": "3c06dccf-06cb-4ffe-a3c2-863f76dcc765",
|
|
@@ -906,73 +1036,85 @@ interface paths {
|
|
|
906
1036
|
* "screenWidth": 390,
|
|
907
1037
|
* "url": "https://www.example.com/telco/",
|
|
908
1038
|
* "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.210 Mobile Safari/537.36"
|
|
909
|
-
* }
|
|
1039
|
+
* }
|
|
1040
|
+
*/
|
|
910
1041
|
'application/json': {
|
|
911
1042
|
additionalProperties?: {
|
|
912
|
-
/**
|
|
1043
|
+
/**
|
|
1044
|
+
* @description A 36 character alphanumeric hash that uniquely identifies a user.
|
|
913
1045
|
*
|
|
914
1046
|
*
|
|
915
1047
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
916
1048
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
917
1049
|
*
|
|
918
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1050
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1051
|
+
*/
|
|
919
1052
|
user_id?: string;
|
|
920
1053
|
/** @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" */
|
|
921
1054
|
event_at?: string;
|
|
922
1055
|
/** @description The page url at the time the event is fired */
|
|
923
1056
|
url?: string;
|
|
924
|
-
/** @description What web browser the user is using e.g. chrome/firefox/safari etc.
|
|
1057
|
+
/** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
|
|
925
1058
|
browser?: string;
|
|
926
1059
|
/** @description The customer that the event occurred on */
|
|
927
1060
|
customer_id?: string;
|
|
928
1061
|
/** @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" */
|
|
929
1062
|
user_agent?: string;
|
|
930
|
-
/**
|
|
1063
|
+
/**
|
|
1064
|
+
* @description A 36 character alphanumeric hash that uniquely identifies a tracking event
|
|
931
1065
|
*
|
|
932
1066
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
933
1067
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
934
1068
|
*
|
|
935
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1069
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1070
|
+
*/
|
|
936
1071
|
event_id?: string;
|
|
937
1072
|
/** @description The name of an event */
|
|
938
1073
|
event_name?: string;
|
|
939
|
-
/**
|
|
1074
|
+
/**
|
|
1075
|
+
* @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
|
|
940
1076
|
*
|
|
941
1077
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
942
1078
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
943
1079
|
*
|
|
944
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1080
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1081
|
+
*/
|
|
945
1082
|
pageview_id?: string;
|
|
946
1083
|
/** @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. */
|
|
947
1084
|
web_analytics_platform_user_id?: string | null;
|
|
948
|
-
/**
|
|
1085
|
+
/**
|
|
1086
|
+
* @description A 36 character alphanumeric hash that uniquely identifies a session.
|
|
949
1087
|
*
|
|
950
1088
|
*
|
|
951
1089
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
952
1090
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
953
1091
|
*
|
|
954
1092
|
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
955
|
-
|
|
1093
|
+
*/
|
|
956
1094
|
browser_session_id?: string | null;
|
|
957
1095
|
/** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
|
|
958
1096
|
screen_width?: number;
|
|
959
1097
|
/** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
|
|
960
1098
|
screen_height?: number;
|
|
961
|
-
/**
|
|
1099
|
+
/**
|
|
1100
|
+
* @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.
|
|
962
1101
|
*
|
|
963
1102
|
* Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
|
|
964
1103
|
*
|
|
965
1104
|
* screen_width <= 480px = 'mobile'
|
|
966
|
-
* screen_width > 480px = 'large'
|
|
1105
|
+
* screen_width > 480px = 'large'
|
|
1106
|
+
*/
|
|
967
1107
|
screen_size?: string;
|
|
968
1108
|
/** @description The type of entry point the event refers to, e.g. engagement_button (previously named tab), engagement popup (previously named engagement bubble) etc */
|
|
969
1109
|
entry_point_type?: string;
|
|
970
|
-
/**
|
|
1110
|
+
/**
|
|
1111
|
+
* @description A 36 character alphanumeric hash that uniquely identifies a conversation.
|
|
971
1112
|
*
|
|
972
1113
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
973
1114
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
974
1115
|
*
|
|
975
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1116
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1117
|
+
*/
|
|
976
1118
|
conversation_id?: string;
|
|
977
1119
|
/** @description The name of the system/service that the event originates from */
|
|
978
1120
|
service?: string;
|
|
@@ -990,14 +1132,15 @@ interface paths {
|
|
|
990
1132
|
tool_ui_closed_reason?: string;
|
|
991
1133
|
/** @description Specifies whether the click on the entry point was a positive or negative CTA. Positive would be expected to open the tool ui, negative would be expected to close the entry point. */
|
|
992
1134
|
entry_point_click_type?: string | null;
|
|
993
|
-
/**
|
|
1135
|
+
/**
|
|
1136
|
+
* @description Describes what exactly was clicked on an entry point that lead to the tool opening.
|
|
994
1137
|
*
|
|
995
1138
|
* Value should be one of the following:
|
|
996
1139
|
*
|
|
997
1140
|
* 'main_cta' if the standard sparkles cta is clicked
|
|
998
1141
|
* 'keyword_box' - if it's the freetext box that's clicked
|
|
999
1142
|
* 'prompt_chip_{promptchiptext}' - if an example prompt is clicked e.g. 'prompt_chip_what_speed_is_best_for_my_devices' - we'll revise this tracking post fake door test if prompt chips become more permanent
|
|
1000
|
-
|
|
1143
|
+
*/
|
|
1001
1144
|
entry_point_click_element?: string;
|
|
1002
1145
|
/** @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' */
|
|
1003
1146
|
recommendation_ids_for_exit?: unknown[];
|
|
@@ -1011,27 +1154,26 @@ interface paths {
|
|
|
1011
1154
|
experiment_variation_name?: string;
|
|
1012
1155
|
/** @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. */
|
|
1013
1156
|
entry_point_closed_reason?: string;
|
|
1014
|
-
/** @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.
|
|
1015
|
-
* */
|
|
1157
|
+
/** @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. */
|
|
1016
1158
|
suppressed_by?: unknown[];
|
|
1017
|
-
/** @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())
|
|
1018
|
-
* */
|
|
1159
|
+
/** @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()) */
|
|
1019
1160
|
suppressed_reason?: unknown[];
|
|
1020
1161
|
/** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
|
|
1021
1162
|
exit_destination_type?: string;
|
|
1022
1163
|
/** @description Describes whether a user clicked the thumbs up ('positive') or thumbs down ('negative') on the rec card */
|
|
1023
1164
|
rec_card_feedback_sentiment?: string;
|
|
1024
|
-
/**
|
|
1165
|
+
/**
|
|
1166
|
+
* @description A 32 character alphanumeric hash that uniquely identifies a single rec in a recommendation set.
|
|
1025
1167
|
*
|
|
1026
1168
|
* This should match the UUID V4 as specified in RFC 9652:
|
|
1027
1169
|
* https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
|
|
1028
1170
|
*
|
|
1029
|
-
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1171
|
+
* e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
|
|
1172
|
+
*/
|
|
1030
1173
|
recommendation_id?: string;
|
|
1031
|
-
/** @description List of objects that represents the options for single & multiselect questions.
|
|
1174
|
+
/** @description List of objects that represents the options for single & multiselect questions. */
|
|
1032
1175
|
message_select_options?: unknown[];
|
|
1033
|
-
/** @description The text that was visible to the user on the CTA button
|
|
1034
|
-
* */
|
|
1176
|
+
/** @description The text that was visible to the user on the CTA button */
|
|
1035
1177
|
button_text?: string;
|
|
1036
1178
|
};
|
|
1037
1179
|
/**
|
|
@@ -1322,12 +1464,14 @@ declare class Client {
|
|
|
1322
1464
|
fallbackMessage: string;
|
|
1323
1465
|
conversationSummary: string;
|
|
1324
1466
|
reason: components["schemas"]["ExitToHumanReason"];
|
|
1467
|
+
recommendations: components["schemas"]["RecommendationV2"][];
|
|
1325
1468
|
} | {
|
|
1326
1469
|
type: "EXIT_TO_PHONE";
|
|
1327
1470
|
fallbackMessage: string;
|
|
1328
1471
|
reason: components["schemas"]["ExitToHumanReason"];
|
|
1329
1472
|
linkText: string;
|
|
1330
1473
|
linkPhone: string;
|
|
1474
|
+
linkTitle?: string | null;
|
|
1331
1475
|
} | {
|
|
1332
1476
|
type: "EXIT_TO_PURCHASE";
|
|
1333
1477
|
fallbackMessage: string;
|
|
@@ -1355,6 +1499,7 @@ declare class Client {
|
|
|
1355
1499
|
type: "RECOMMENDATION_V2";
|
|
1356
1500
|
fallbackMessage: string;
|
|
1357
1501
|
recommendations: components["schemas"]["RecommendationV2"][];
|
|
1502
|
+
recommendationButtonText?: string | null;
|
|
1358
1503
|
} | {
|
|
1359
1504
|
type: "SINGLE_SELECT";
|
|
1360
1505
|
fallbackMessage: string;
|