@15gifts/sdk 0.16.0 → 0.16.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -6,7 +6,7 @@ import { Client as Client$1, ClientOptions, Middleware } from 'openapi-fetch';
6
6
  * Do not make direct changes to the file.
7
7
  */
8
8
  interface paths$1 {
9
- "/api/conversation/v3": {
9
+ '/api/conversation/v3': {
10
10
  parameters: {
11
11
  query?: never;
12
12
  header?: never;
@@ -19,7 +19,7 @@ interface paths$1 {
19
19
  * Generate Conversation Response
20
20
  * @description Generates a response based on the users message and the conversation id.
21
21
  */
22
- post: operations["generate_conversation_response_api_conversation_v3_post"];
22
+ post: operations['generate_conversation_response_api_conversation_v3_post'];
23
23
  delete?: never;
24
24
  options?: never;
25
25
  head?: never;
@@ -39,7 +39,7 @@ interface components {
39
39
  * @default CONVERSATION_ID
40
40
  * @constant
41
41
  */
42
- type: "CONVERSATION_ID";
42
+ type: 'CONVERSATION_ID';
43
43
  /**
44
44
  * Conversationid
45
45
  * @description Unique identifier for the conversation. This will be generated once, at the start of a conversation.
@@ -56,7 +56,7 @@ interface components {
56
56
  * @default EXIT_TO_CHAT
57
57
  * @constant
58
58
  */
59
- type: "EXIT_TO_CHAT";
59
+ type: 'EXIT_TO_CHAT';
60
60
  /**
61
61
  * Fallbackmessage
62
62
  * @description What should a client render if they do not have a native renderer for this message type?
@@ -68,7 +68,7 @@ interface components {
68
68
  */
69
69
  conversationSummary: string;
70
70
  /** @description Why have we been exited to chat? */
71
- reason: components["schemas"]["ExitToHumanReason"];
71
+ reason: components['schemas']['ExitToHumanReason'];
72
72
  };
73
73
  /**
74
74
  * AssistantExitToPhoneMessage
@@ -80,14 +80,14 @@ interface components {
80
80
  * @default EXIT_TO_PHONE
81
81
  * @constant
82
82
  */
83
- type: "EXIT_TO_PHONE";
83
+ type: 'EXIT_TO_PHONE';
84
84
  /**
85
85
  * Fallbackmessage
86
86
  * @description What should a client render if they do not have a native renderer for this message type?
87
87
  */
88
88
  fallbackMessage: string;
89
89
  /** @description Why have we been exited to phone? */
90
- reason: components["schemas"]["ExitToHumanReason"];
90
+ reason: components['schemas']['ExitToHumanReason'];
91
91
  /**
92
92
  * Linktext
93
93
  * @description The text to display to the user
@@ -109,7 +109,7 @@ interface components {
109
109
  * @default EXIT_TO_PURCHASE
110
110
  * @constant
111
111
  */
112
- type: "EXIT_TO_PURCHASE";
112
+ type: 'EXIT_TO_PURCHASE';
113
113
  /**
114
114
  * Fallbackmessage
115
115
  * @description What should a client render if they do not have a native renderer for this message type?
@@ -118,19 +118,19 @@ interface components {
118
118
  /** Recommendationidforexit */
119
119
  recommendationIdForExit?: string | null;
120
120
  /** Products */
121
- products: components["schemas"]["Product"][];
121
+ products: components['schemas']['Product'][];
122
122
  /**
123
123
  * Bundles
124
124
  * @description The bundles that were recommended
125
125
  * @default []
126
126
  */
127
- bundles: components["schemas"]["Bundle"][];
127
+ bundles: components['schemas']['Bundle'][];
128
128
  /**
129
129
  * Offers
130
130
  * @description The offers that were part of the recommendation
131
131
  * @default []
132
132
  */
133
- offers: components["schemas"]["Offer"][];
133
+ offers: components['schemas']['Offer'][];
134
134
  };
135
135
  /**
136
136
  * AssistantExitToPurchaseMessageV2
@@ -142,7 +142,7 @@ interface components {
142
142
  * @default EXIT_TO_PURCHASE_V2
143
143
  * @constant
144
144
  */
145
- type: "EXIT_TO_PURCHASE_V2";
145
+ type: 'EXIT_TO_PURCHASE_V2';
146
146
  /**
147
147
  * Fallbackmessage
148
148
  * @description What should a client render if they do not have a native renderer for this message type?
@@ -151,19 +151,19 @@ interface components {
151
151
  /** Recommendationidforexit */
152
152
  recommendationIdForExit?: string | null;
153
153
  /** Products */
154
- products: components["schemas"]["ProductV2"][];
154
+ products: components['schemas']['ProductV2'][];
155
155
  /**
156
156
  * Bundles
157
157
  * @description The bundles that were recommended
158
158
  * @default []
159
159
  */
160
- bundles: components["schemas"]["BundleV2"][];
160
+ bundles: components['schemas']['BundleV2'][];
161
161
  /**
162
162
  * Offers
163
163
  * @description The offers that were part of the recommendation
164
164
  * @default []
165
165
  */
166
- offers: components["schemas"]["OfferV2"][];
166
+ offers: components['schemas']['OfferV2'][];
167
167
  };
168
168
  /**
169
169
  * AssistantMultiSelectMessage
@@ -175,7 +175,7 @@ interface components {
175
175
  * @default MULTI_SELECT
176
176
  * @constant
177
177
  */
178
- type: "MULTI_SELECT";
178
+ type: 'MULTI_SELECT';
179
179
  /**
180
180
  * Fallbackmessage
181
181
  * @description What should a client render if they do not have a native renderer for this message type?
@@ -185,7 +185,7 @@ interface components {
185
185
  * Options
186
186
  * @description What selectable options should be available?
187
187
  */
188
- options: components["schemas"]["ConversationOption"][];
188
+ options: components['schemas']['ConversationOption'][];
189
189
  /**
190
190
  * Allowfreetext
191
191
  * @description Should we expect a free text response to this message?
@@ -202,14 +202,14 @@ interface components {
202
202
  * @default RECOMMENDATION
203
203
  * @constant
204
204
  */
205
- type: "RECOMMENDATION";
205
+ type: 'RECOMMENDATION';
206
206
  /**
207
207
  * Fallbackmessage
208
208
  * @description What should a client render if they do not have a native renderer for this message type?
209
209
  */
210
210
  fallbackMessage: string;
211
211
  /** Recommendations */
212
- recommendations: components["schemas"]["Recommendation"][];
212
+ recommendations: components['schemas']['Recommendation'][];
213
213
  };
214
214
  /**
215
215
  * AssistantRecommendationMessageV2
@@ -221,14 +221,14 @@ interface components {
221
221
  * @default RECOMMENDATION_V2
222
222
  * @constant
223
223
  */
224
- type: "RECOMMENDATION_V2";
224
+ type: 'RECOMMENDATION_V2';
225
225
  /**
226
226
  * Fallbackmessage
227
227
  * @description What should a client render if they do not have a native renderer for this message type?
228
228
  */
229
229
  fallbackMessage: string;
230
230
  /** Recommendations */
231
- recommendations: components["schemas"]["RecommendationV2"][];
231
+ recommendations: components['schemas']['RecommendationV2'][];
232
232
  };
233
233
  /**
234
234
  * AssistantSingleSelectMessage
@@ -240,7 +240,7 @@ interface components {
240
240
  * @default SINGLE_SELECT
241
241
  * @constant
242
242
  */
243
- type: "SINGLE_SELECT";
243
+ type: 'SINGLE_SELECT';
244
244
  /**
245
245
  * Fallbackmessage
246
246
  * @description What should a client render if they do not have a native renderer for this message type?
@@ -250,7 +250,7 @@ interface components {
250
250
  * Options
251
251
  * @description What selectable options should be available?
252
252
  */
253
- options: components["schemas"]["ConversationOption"][];
253
+ options: components['schemas']['ConversationOption'][];
254
254
  /**
255
255
  * Allowfreetext
256
256
  * @description Should we expect a free text response to this message?
@@ -267,7 +267,7 @@ interface components {
267
267
  * @default MESSAGE
268
268
  * @constant
269
269
  */
270
- type: "MESSAGE";
270
+ type: 'MESSAGE';
271
271
  /**
272
272
  * Message
273
273
  * @description Message for the conversation.
@@ -300,7 +300,7 @@ interface components {
300
300
  * Products
301
301
  * @description The products that make up this bundle.
302
302
  */
303
- products: components["schemas"]["Product"][];
303
+ products: components['schemas']['Product'][];
304
304
  };
305
305
  /**
306
306
  * BundleV2
@@ -325,16 +325,16 @@ interface components {
325
325
  */
326
326
  previousPrice?: string | null;
327
327
  /** @description The original price of the product or bundle, only set if it's currently discounted. */
328
- previousPriceDetails?: components["schemas"]["ProductPriceDetails"] | null;
328
+ previousPriceDetails?: components['schemas']['ProductPriceDetails'] | null;
329
329
  /**
330
330
  * Price
331
331
  * @description A fallback for headless builds that don't want to use priceDetails. Should include the same info, but as a string.
332
332
  */
333
333
  price: string;
334
334
  /** @description The current price details of the product or bundle. If the product or bundle is discounted, this will hold the discounted price. */
335
- priceDetails: components["schemas"]["ProductPriceDetails"];
335
+ priceDetails: components['schemas']['ProductPriceDetails'];
336
336
  /** Products */
337
- products: components["schemas"]["ProductV2"][];
337
+ products: components['schemas']['ProductV2'][];
338
338
  };
339
339
  /** ConversationContext */
340
340
  ConversationContext: {
@@ -394,7 +394,7 @@ interface components {
394
394
  * ExitToHumanReason
395
395
  * @enum {string}
396
396
  */
397
- ExitToHumanReason: "WANT_TO_TALK_TO_HUMAN" | "OUT_OF_SCOPE_QUESTIONS" | "NOT_BEHAVING_CORRECTLY";
397
+ ExitToHumanReason: 'WANT_TO_TALK_TO_HUMAN' | 'OUT_OF_SCOPE_QUESTIONS' | 'NOT_BEHAVING_CORRECTLY';
398
398
  /**
399
399
  * Offer
400
400
  * @description Offer details
@@ -421,8 +421,11 @@ interface components {
421
421
  * @description The offer id as defined by the customer
422
422
  */
423
423
  id: string;
424
- /** Name */
425
- name: string;
424
+ /**
425
+ * Name
426
+ * @description The offer name as defined by the customer
427
+ */
428
+ name?: string | null;
426
429
  /**
427
430
  * Description
428
431
  * @description Description of the offer from the feed data
@@ -474,7 +477,7 @@ interface components {
474
477
  * @description ISO 4217 Currency code - `USD`, `GBP`, `EUR` etc
475
478
  * @enum {string}
476
479
  */
477
- currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "IRR" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XBA" | "XBB" | "XBC" | "XBD" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "XSU" | "XTS" | "XUA" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWL";
480
+ currency: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
478
481
  /**
479
482
  * Suffix
480
483
  * @description e.g `/mo` or `per month for 12 months` or `including vat`
@@ -504,14 +507,14 @@ interface components {
504
507
  */
505
508
  previousPrice?: string | null;
506
509
  /** @description The original price of the product or bundle, only set if it's currently discounted. */
507
- previousPriceDetails?: components["schemas"]["ProductPriceDetails"] | null;
510
+ previousPriceDetails?: components['schemas']['ProductPriceDetails'] | null;
508
511
  /**
509
512
  * Price
510
513
  * @description A fallback for headless builds that don't want to use priceDetails. Should include the same info, but as a string.
511
514
  */
512
515
  price?: string | null;
513
516
  /** @description The current price details of the product or bundle. If the product or bundle is discounted, this will hold the discounted price. */
514
- priceDetails?: components["schemas"]["ProductPriceDetails"] | null;
517
+ priceDetails?: components['schemas']['ProductPriceDetails'] | null;
515
518
  /**
516
519
  * Category
517
520
  * @description For example, `tv`, `internet`, `phone`. It can be used to show an icon in the UI.
@@ -521,7 +524,7 @@ interface components {
521
524
  * Extras
522
525
  * @description Extras are additional products that are bundled with the main product.
523
526
  */
524
- extras?: components["schemas"]["ProductExtra"][] | null;
527
+ extras?: components['schemas']['ProductExtra'][] | null;
525
528
  /**
526
529
  * Quantity
527
530
  * @description How many of this product are there?
@@ -542,19 +545,19 @@ interface components {
542
545
  * Products
543
546
  * @description The products that make up this recommendation
544
547
  */
545
- products: components["schemas"]["Product"][];
548
+ products: components['schemas']['Product'][];
546
549
  /**
547
550
  * Bundles
548
551
  * @description The bundles that make up this recommendation
549
552
  * @default []
550
553
  */
551
- bundles: components["schemas"]["Bundle"][];
554
+ bundles: components['schemas']['Bundle'][];
552
555
  /**
553
556
  * Offers
554
557
  * @description The offers that make up this recommendation
555
558
  * @default []
556
559
  */
557
- offers: components["schemas"]["Offer"][];
560
+ offers: components['schemas']['Offer'][];
558
561
  };
559
562
  /**
560
563
  * RecommendationV2
@@ -567,19 +570,19 @@ interface components {
567
570
  * Products
568
571
  * @description The products that make up this recommendation
569
572
  */
570
- products: components["schemas"]["ProductV2"][];
573
+ products: components['schemas']['ProductV2'][];
571
574
  /**
572
575
  * Bundles
573
576
  * @description The bundles that make up this recommendation
574
577
  * @default []
575
578
  */
576
- bundles: components["schemas"]["BundleV2"][];
579
+ bundles: components['schemas']['BundleV2'][];
577
580
  /**
578
581
  * Offers
579
582
  * @description The offers that make up this recommendation
580
583
  * @default []
581
584
  */
582
- offers: components["schemas"]["OfferV2"][];
585
+ offers: components['schemas']['OfferV2'][];
583
586
  /**
584
587
  * Importantinformation
585
588
  * @description Information to include at the bottom of the recommendation card, e.g. CPI price data
@@ -596,7 +599,7 @@ interface components {
596
599
  * @default MULTI_SELECT
597
600
  * @constant
598
601
  */
599
- type: "MULTI_SELECT";
602
+ type: 'MULTI_SELECT';
600
603
  /**
601
604
  * Conversationid
602
605
  * Format: uuid
@@ -624,7 +627,7 @@ interface components {
624
627
  * @default SINGLE_SELECT
625
628
  * @constant
626
629
  */
627
- type: "SINGLE_SELECT";
630
+ type: 'SINGLE_SELECT';
628
631
  /**
629
632
  * Conversationid
630
633
  * Format: uuid
@@ -640,7 +643,7 @@ interface components {
640
643
  * Option
641
644
  * @description Which select option was picked?
642
645
  */
643
- option: string;
646
+ option?: string | null;
644
647
  };
645
648
  /**
646
649
  * UserStartConversationMessage
@@ -652,9 +655,9 @@ interface components {
652
655
  * @default START_CONVERSATION
653
656
  * @constant
654
657
  */
655
- type: "START_CONVERSATION";
658
+ type: 'START_CONVERSATION';
656
659
  /** @description Context information we'll be getting with the request */
657
- conversationContext: components["schemas"]["ConversationContext"];
660
+ conversationContext: components['schemas']['ConversationContext'];
658
661
  };
659
662
  /**
660
663
  * UserTextMessage
@@ -666,7 +669,7 @@ interface components {
666
669
  * @default MESSAGE
667
670
  * @constant
668
671
  */
669
- type: "MESSAGE";
672
+ type: 'MESSAGE';
670
673
  /**
671
674
  * Conversationid
672
675
  * Format: uuid
@@ -691,23 +694,23 @@ interface operations {
691
694
  parameters: {
692
695
  query?: never;
693
696
  header?: {
694
- "user-agent"?: string;
697
+ 'user-agent'?: string;
695
698
  /**
696
699
  * @description Comma-separated list of feature flags (flags might require elevated permissions)
697
700
  * @example debug,rec-message-v2
698
701
  */
699
- "x-feature-flags"?: string | null;
702
+ 'x-feature-flags'?: string | null;
700
703
  /**
701
704
  * @description The version of the SDK version that is being used
702
705
  * @example 1.0.0
703
706
  */
704
- "x-sdk-version"?: string | null;
707
+ 'x-sdk-version'?: string | null;
705
708
  /** @description A UUID marking the unique page view ID, if this request came from a web browser */
706
- "x-pageview-id"?: string | null;
709
+ 'x-pageview-id'?: string | null;
707
710
  /** @description The URL of the page that is sending requests to the conversation API */
708
- "x-page-url"?: string | null;
711
+ 'x-page-url'?: string | null;
709
712
  /** @description The user id assigned to the user by a web analytics platform, for example our customers adobe analytics. */
710
- "x-web-analytics-platform-user-id"?: string | null;
713
+ 'x-web-analytics-platform-user-id'?: string | null;
711
714
  };
712
715
  path?: never;
713
716
  cookie?: {
@@ -716,7 +719,7 @@ interface operations {
716
719
  };
717
720
  requestBody: {
718
721
  content: {
719
- "application/json": components["schemas"]["UserTextMessage"] | components["schemas"]["UserSingleSelectMessage"] | components["schemas"]["UserMultiSelectMessage"] | components["schemas"]["UserStartConversationMessage"];
722
+ 'application/json': components['schemas']['UserTextMessage'] | components['schemas']['UserSingleSelectMessage'] | components['schemas']['UserMultiSelectMessage'] | components['schemas']['UserStartConversationMessage'];
720
723
  };
721
724
  };
722
725
  responses: {
@@ -726,7 +729,7 @@ interface operations {
726
729
  [name: string]: unknown;
727
730
  };
728
731
  content: {
729
- "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"])[];
732
+ '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'])[];
730
733
  };
731
734
  };
732
735
  /** @description The user is not authorized to access the requested data */
@@ -735,7 +738,7 @@ interface operations {
735
738
  [name: string]: unknown;
736
739
  };
737
740
  content: {
738
- "application/json": unknown;
741
+ 'application/json': unknown;
739
742
  };
740
743
  };
741
744
  /** @description The user does not have permission to access the requested data */
@@ -744,7 +747,7 @@ interface operations {
744
747
  [name: string]: unknown;
745
748
  };
746
749
  content: {
747
- "application/json": unknown;
750
+ 'application/json': unknown;
748
751
  };
749
752
  };
750
753
  /** @description The customer config was not found */
@@ -753,7 +756,7 @@ interface operations {
753
756
  [name: string]: unknown;
754
757
  };
755
758
  content: {
756
- "application/json": unknown;
759
+ 'application/json': unknown;
757
760
  };
758
761
  };
759
762
  /** @description Validation Error */
@@ -762,7 +765,7 @@ interface operations {
762
765
  [name: string]: unknown;
763
766
  };
764
767
  content: {
765
- "application/json": unknown;
768
+ 'application/json': unknown;
766
769
  };
767
770
  };
768
771
  };
@@ -774,7 +777,7 @@ interface operations {
774
777
  * Do not make direct changes to the file.
775
778
  */
776
779
  interface paths {
777
- "/api/tracking/identity/v2": {
780
+ '/api/tracking/identity/v2': {
778
781
  parameters: {
779
782
  query?: never;
780
783
  header?: never;
@@ -795,19 +798,19 @@ interface paths {
795
798
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
796
799
  * @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
797
800
  */
798
- "x-page-view-id"?: string;
801
+ 'x-page-view-id'?: string;
799
802
  /** @description Web Analytics Platform User ID */
800
- "x-web-analytics-platform-user-id"?: string;
803
+ 'x-web-analytics-platform-user-id'?: string;
801
804
  /**
802
805
  * @description The version of the frontend application that is making the request
803
806
  * @example 1.0.0
804
807
  */
805
- "x-frontend-version"?: string;
808
+ 'x-frontend-version'?: string;
806
809
  /**
807
810
  * @description The version of the SDK that is making the request
808
811
  * @example 1.0.0
809
812
  */
810
- "x-sdk-version"?: string;
813
+ 'x-sdk-version'?: string;
811
814
  };
812
815
  path?: never;
813
816
  cookie?: never;
@@ -815,7 +818,7 @@ interface paths {
815
818
  /** @description Generate tracking identifiers for a user */
816
819
  requestBody: {
817
820
  content: {
818
- "application/json": {
821
+ 'application/json': {
819
822
  /** @description The customer that the event occurred on */
820
823
  customerId: string;
821
824
  /**
@@ -842,7 +845,7 @@ interface paths {
842
845
  [name: string]: unknown;
843
846
  };
844
847
  content: {
845
- "application/json": {
848
+ 'application/json': {
846
849
  /**
847
850
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
848
851
  * @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
@@ -871,409 +874,7 @@ interface paths {
871
874
  patch?: never;
872
875
  trace?: never;
873
876
  };
874
- "/api/tracking/sales/v2": {
875
- parameters: {
876
- query?: never;
877
- header?: never;
878
- path?: never;
879
- cookie?: never;
880
- };
881
- get?: never;
882
- put?: never;
883
- /**
884
- * Submit sales tracking data
885
- * @description Submit sales tracking data
886
- */
887
- post: {
888
- parameters: {
889
- query?: never;
890
- header?: never;
891
- path?: never;
892
- cookie?: never;
893
- };
894
- requestBody?: {
895
- content: {
896
- "application/json": {
897
- /** @description A 36 character alphanumeric hash that uniquely identifies a user.
898
- *
899
- *
900
- * This should match the UUID V4 as specified in RFC 9652:
901
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
902
- *
903
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
904
- userId?: string;
905
- /** @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" */
906
- eventAt?: string;
907
- /** @description The page url at the time the event is fired */
908
- url?: string;
909
- /** @description What web browser the user is using e.g. chrome/firefox/safari etc. */
910
- browser?: string;
911
- /** @description The customer that the event occurred on */
912
- customerId: string;
913
- /** @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" */
914
- userAgent?: string;
915
- /** @description A 36 character alphanumeric hash that uniquely identifies a tracking event
916
- *
917
- * This should match the UUID V4 as specified in RFC 9652:
918
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
919
- *
920
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
921
- eventId?: string;
922
- /**
923
- * @description The name of an event
924
- * @enum {string}
925
- */
926
- eventName?: "sale-completed";
927
- /** @description A 36 character alphanumeric hash that uniquely identifies a page view (page-shown event)
928
- *
929
- * This should match the UUID V4 as specified in RFC 9652:
930
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
931
- *
932
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
933
- pageviewId?: string | null;
934
- /** @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. */
935
- webAnalyticsPlatformUserId?: string | null;
936
- /** @description A 36 character alphanumeric hash that uniquely identifies a session.
937
- *
938
- *
939
- * This should match the UUID V4 as specified in RFC 9652:
940
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
941
- *
942
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6
943
- * */
944
- browserSessionId?: string | null;
945
- /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
946
- screenWidth?: number;
947
- /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
948
- screenHeight?: number;
949
- /**
950
- * @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.
951
- *
952
- * Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
953
- *
954
- * screen_width <= 480px = 'mobile'
955
- * screen_width > 480px = 'large'
956
- * @enum {string}
957
- */
958
- screenSize?: "large" | "mobile";
959
- /** @description The ID for the sale, a unique, non-empty value we can correlate with customer records. */
960
- saleId: string;
961
- /**
962
- * @description The type of user, for example, existing or prospect.
963
- * @enum {string}
964
- */
965
- userType: "existing" | "prospect";
966
- /**
967
- * @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.
968
- * @enum {string}
969
- */
970
- currencyCode?: "AUD" | "CAD" | "EUR" | "GBP" | "MXN" | "USD";
971
- /** @description The full basket value of the sale, inclusive of any offers. */
972
- saleTotalValue?: number;
973
- /** @description A list containing separate line items for each product sold. */
974
- productsSold: {
975
- /** @description The ID or SKU of a product that is provided by the customer */
976
- siteProductId: string;
977
- /** @description The name of the product */
978
- siteProductName: string;
979
- /** @description The category of products the product belongs to. */
980
- siteProductType: string;
981
- /** @description The upfront price the user has to pay for the product. */
982
- productPriceUpfront: number;
983
- }[];
984
- /**
985
- * @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en', 'es' etc.
986
- * @enum {string}
987
- */
988
- language?: "de" | "en" | "es" | "fr" | "it";
989
- /**
990
- * @description The name of the system/service that the event originates from
991
- * @enum {string}
992
- */
993
- service?: "frontend" | "salesTrackingApi";
994
- /** @description A JSON object containing the different versions of services directly used by the service that tracks an event. The version of the service that is firing any tracking event should ALWAYS be included, for example if the conversation_api is firing an event, service_versions should include conversation_api_version. It should also ideally include the version numbers of any other services used in the generation of the event that is being tracked. */
995
- serviceVersions?: {
996
- /** @description The version number for the frontend service */
997
- frontendVersion?: string | null;
998
- /** @description The version number for the frontend api service */
999
- frontendApiVersion?: string | null;
1000
- /** @description The version number for the conversation api service */
1001
- conversationApiVersion?: string | null;
1002
- /** @description The version number for the customer configuration service */
1003
- customerConfigurationVersion?: string | null;
1004
- /** @description The version number for the client library our customers are using */
1005
- sdkVersion?: string | null;
1006
- /** @description The version number for the product configuration data */
1007
- productConfigurationVersion?: string | null;
1008
- /** @description The version number for the sales tracking api service. *in the short term this is technically just the frontend so will match that */
1009
- salesTrackingApiVersion?: string | null;
1010
- /** @description The version number for the recommender service */
1011
- recommenderVersion?: string | null;
1012
- };
1013
- /**
1014
- * @description The environment the event originated from (production/development/testing/staging/local/uat/ephemeral)
1015
- * @enum {string}
1016
- */
1017
- environment?: "development" | "ephemeral" | "local" | "production" | "staging" | "test" | "uat";
1018
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1019
- identityToken: string;
1020
- } | {
1021
- /**
1022
- * @description The customer that the event occurred on
1023
- * @enum {string}
1024
- */
1025
- customerId: "aidem";
1026
- /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1027
- eventAt?: string;
1028
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1029
- identityToken: string;
1030
- /** @description The ID for the sale, a unique value we can correlate with customer records. */
1031
- saleId: string;
1032
- /**
1033
- * @description The type of user, for example, existing or prospect.
1034
- * @enum {string}
1035
- */
1036
- userType: "existing" | "prospect";
1037
- /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1038
- browser?: string;
1039
- /** @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" */
1040
- userAgent?: string;
1041
- /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1042
- screenWidth?: number;
1043
- /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
1044
- screenHeight?: number;
1045
- /**
1046
- * @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.
1047
- *
1048
- * Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
1049
- *
1050
- * screen_width <= 480px = 'mobile'
1051
- * screen_width > 480px = 'large'
1052
- * @enum {string}
1053
- */
1054
- screenSize?: "mobile" | "large";
1055
- /** @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. */
1056
- currencyCode?: string;
1057
- /** @description The host/domain of the URL at the time the event is fired */
1058
- siteHost: string;
1059
- /** @description The path of the URL (including an initial `/`) at the time the event is fired */
1060
- sitePath?: string;
1061
- /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1062
- siteQueryString?: string;
1063
- /** @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. */
1064
- language?: string;
1065
- /** @description The recurring payment due per payment period */
1066
- priceRecurring: number;
1067
- /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1068
- priceRecurringPeriod: string;
1069
- /** @description The upfront price the user has to pay for the product. */
1070
- priceUpfront?: number;
1071
- /** @description The full basket value of the sale, inclusive of any offers. */
1072
- totalValueOfSale?: number;
1073
- /** @description The taxes the user has to pay relating to the priceUpfront of the product(s) */
1074
- totalUpfrontTax?: number;
1075
- /** @description The taxes the user has to pay relating to the priceRecurring of the product(s), due per payment period */
1076
- totalRecurringTax?: number;
1077
- totalTaxOnSale?: number;
1078
- /** @description A list containing separate line items for each product sold. */
1079
- productsSold: {
1080
- /** @description The ID or SKU of a product that is provided by the customer */
1081
- siteProductId?: string;
1082
- /** @description The name of the product */
1083
- siteProductName: string;
1084
- /** @description The category of products the product belongs to. */
1085
- siteProductType: string;
1086
- /** @description An ISO-8601 duration that represents the contract length */
1087
- productContractLength: string;
1088
- /** @description An integer representing how many of this particular product the user is purchasing */
1089
- quantity: number;
1090
- /** @description The upfront price the user has to pay for the product. */
1091
- productPriceUpfront: number;
1092
- /** @description The recurring payment per payment period for the product */
1093
- productPricePerPeriod: number;
1094
- /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1095
- productRecurringPaymentPeriod: string;
1096
- /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1097
- bundleId?: string;
1098
- }[];
1099
- } | {
1100
- /**
1101
- * @description The customer that the event occurred on
1102
- * @enum {string}
1103
- */
1104
- customerId: "spectrum-us-media-consumer-en";
1105
- /** @description The timestamp describing the time the event occurred. This should conform to ISO 8601 standards and be in UTC */
1106
- eventAt?: string;
1107
- /** @description A JWT used to identify the user in the system, can be obtained from the identity endpoint */
1108
- identityToken: string;
1109
- /** @description The ID for the sale, a unique value we can correlate with customer records. */
1110
- saleId: string;
1111
- /**
1112
- * @description The type of user, for example, existing or prospect.
1113
- * @enum {string}
1114
- */
1115
- userType: "existing" | "prospect";
1116
- /** @description The browser the user is using, e.g. Chrome, Firefox, Safari, etc. */
1117
- browser?: string;
1118
- /** @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" */
1119
- userAgent?: string;
1120
- /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1121
- screenWidth?: number;
1122
- /** @description The device screen height in pixels - window.screen.height in JS. This is a user level property that should never change. */
1123
- screenHeight?: number;
1124
- /**
1125
- * @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.
1126
- *
1127
- * Based off https://15gifts.atlassian.net/wiki/spaces/AI/pages/3981443139/Breakpoints+for+mobile+desktop
1128
- *
1129
- * screen_width <= 480px = 'mobile'
1130
- * screen_width > 480px = 'large'
1131
- * @enum {string}
1132
- */
1133
- screenSize?: "mobile" | "large";
1134
- /** @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. */
1135
- currencyCode?: string;
1136
- /** @description The host/domain of the URL at the time the event is fired */
1137
- siteHost: string;
1138
- /** @description The path of the URL (including an initial `/`) at the time the event is fired */
1139
- sitePath?: string;
1140
- /** @description The query string of the URL (including an initial `?`) at the time the event is fired */
1141
- siteQueryString?: string;
1142
- /** @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. */
1143
- language?: string;
1144
- /** @description The recurring payment due per payment period */
1145
- priceRecurring: number;
1146
- /** @description An ISO-8601 duration that represents the period of time that the priceRecurring payment recurs over */
1147
- priceRecurringPeriod: string;
1148
- /** @description The upfront price the user has to pay for the product. */
1149
- priceUpfront?: number;
1150
- /** @description The full basket value of the sale, inclusive of any offers. */
1151
- totalValueOfSale?: number;
1152
- /** @description The taxes the user has to pay relating to the priceUpfront of the product(s) */
1153
- totalUpfrontTax?: number;
1154
- /** @description The taxes the user has to pay relating to the priceRecurring of the product(s), due per payment period */
1155
- totalRecurringTax?: number;
1156
- totalTaxOnSale?: number;
1157
- /** @description A list containing separate line items for each product sold. */
1158
- productsSold: {
1159
- /** @description The ID or SKU of a product that is provided by the customer */
1160
- siteProductId?: string;
1161
- /** @description The name of the product */
1162
- siteProductName: string;
1163
- /** @description The category of products the product belongs to. */
1164
- siteProductType: string;
1165
- /** @description An ISO-8601 duration that represents the contract length */
1166
- productContractLength: string;
1167
- /** @description An integer representing how many of this particular product the user is purchasing */
1168
- quantity: number;
1169
- /** @description The upfront price the user has to pay for the product. */
1170
- productPriceUpfront: number;
1171
- /** @description The recurring payment per payment period for the product */
1172
- productPricePerPeriod: number;
1173
- /** @description An ISO-8601 duration that represents the period of time that the productPricePerPeriod payment recurs over */
1174
- productRecurringPaymentPeriod: string;
1175
- /** @description The ID or SKU of a bundle that the product (and other products being purchased at the same time) are part of */
1176
- bundleId?: string;
1177
- }[];
1178
- };
1179
- };
1180
- };
1181
- responses: {
1182
- /** @description Successful response */
1183
- 204: {
1184
- headers: {
1185
- [name: string]: unknown;
1186
- };
1187
- content?: never;
1188
- };
1189
- /** @description Error response */
1190
- 400: {
1191
- headers: {
1192
- [name: string]: unknown;
1193
- };
1194
- content: {
1195
- "application/json": {
1196
- /** @description The error message */
1197
- message?: string;
1198
- };
1199
- };
1200
- };
1201
- /** @description Error response */
1202
- 401: {
1203
- headers: {
1204
- [name: string]: unknown;
1205
- };
1206
- content: {
1207
- "application/json": {
1208
- /** @description The error message */
1209
- message?: string;
1210
- };
1211
- };
1212
- };
1213
- /** @description Error response */
1214
- 403: {
1215
- headers: {
1216
- [name: string]: unknown;
1217
- };
1218
- content: {
1219
- "application/json": {
1220
- /** @description The error message */
1221
- message?: string;
1222
- };
1223
- };
1224
- };
1225
- /** @description Error response */
1226
- 404: {
1227
- headers: {
1228
- [name: string]: unknown;
1229
- };
1230
- content: {
1231
- "application/json": {
1232
- /** @description The error message */
1233
- message?: string;
1234
- };
1235
- };
1236
- };
1237
- /** @description Default Response */
1238
- 422: {
1239
- headers: {
1240
- [name: string]: unknown;
1241
- };
1242
- content: {
1243
- "application/json": {
1244
- /** @description The path to the field that caused the error */
1245
- instancePath?: string;
1246
- /** @description The error message */
1247
- message?: string;
1248
- /** @description The path to the schema that caused the error */
1249
- schemaPath?: string;
1250
- /** @description The keyword that caused the error */
1251
- keyword?: string;
1252
- params?: {
1253
- /** @description The name of the missing property */
1254
- missingProperty?: string;
1255
- /** @description The pattern that caused the error */
1256
- pattern?: string;
1257
- /** @description The name of the additional property that caused the error */
1258
- additionalProperty?: string;
1259
- /** @description The comparison that caused the error */
1260
- comparison?: string;
1261
- };
1262
- }[] | {
1263
- /** @description The error message */
1264
- message?: string;
1265
- };
1266
- };
1267
- };
1268
- };
1269
- };
1270
- delete?: never;
1271
- options?: never;
1272
- head?: never;
1273
- patch?: never;
1274
- trace?: never;
1275
- };
1276
- "/api/tracking/user/v2": {
877
+ '/api/tracking/user/v2': {
1277
878
  parameters: {
1278
879
  query?: never;
1279
880
  header?: never;
@@ -1306,7 +907,7 @@ interface paths {
1306
907
  * "url": "https://www.example.com/telco/",
1307
908
  * "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.210 Mobile Safari/537.36"
1308
909
  * } */
1309
- "application/json": {
910
+ 'application/json': {
1310
911
  additionalProperties?: {
1311
912
  /** @description A 36 character alphanumeric hash that uniquely identifies a user.
1312
913
  *
@@ -1387,88 +988,19 @@ interface paths {
1387
988
  ip_address_hashed?: string;
1388
989
  /** @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. */
1389
990
  tool_ui_closed_reason?: string;
1390
- /** @description The turn number in the conversation. This links each user message to a corresponding assistant response. If there is an opening message from the assistant, this would have a message_turn of 1. Then the first message a user sends would have a message_turn of 2. The first actual response the assistant sends would have a message_turn of 2.
1391
- *
1392
- * All message_turn values except for 1 (the opening message if it exists) should be expected to come in pairs.
991
+ /** @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
+ entry_point_click_type?: string | null;
993
+ /** @description Describes what exactly was clicked on an entry point that lead to the tool opening.
1393
994
  *
1394
- * Here's an example sequence of message_turn values where the user is provided with an opening message at the beginning of a conversation, and then sends 5 separate messages themselves with 5 corresponding assistant responses:
995
+ * Value should be one of the following:
1395
996
  *
1396
- * 1,2,2,3,3,4,4,5,5,6,6
997
+ * 'main_cta' if the standard sparkles cta is clicked
998
+ * 'keyword_box' - if it's the freetext box that's clicked
999
+ * '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
1397
1000
  * */
1398
- conversation_turn_num?: number;
1399
- /** @description An alphanumeric hash that uniquely identifies a turn in a conversation
1400
- *
1401
- * This should match the UUID V4 as specified in RFC 9652:
1402
- * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1403
- *
1404
- * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1405
- conversation_turn_id?: string;
1406
- /** @description Describes the type of message e.g. text, single select, multi select etc */
1407
- message_type?: string;
1408
- /** @description The text that was sent by either the user or the assistant. For messages where message_type is not 'text', this should be a string representation of the more complex data type. */
1409
- message_text?: string;
1410
- /** @description List of objects that represents the options for single & multiselect questions. */
1411
- message_select_options?: unknown[];
1412
- /** @description true or false depending on whether the users message caused the assistant to provide a fallback guardrail response.
1413
- *
1414
- * This happens for most guardrails, but in the case of pii-masking it will be false, because it strips the PII from the conversation history and continues the conversation as normal.
1415
- *
1416
- * To check whether the guardrail was triggered, use the is_guardrail_triggered property. */
1417
- is_user_message_guardrailed?: boolean;
1418
- /** @description A list of all guardrails checked for in the corresponding turn associated with the assistant_message-submitted event this property is part of. Includes whether they were triggered and some meaningful way of measuring how close to being triggered/not triggered they were, as well as categorising into input/output guardrails. */
1419
- guardrails?: unknown[];
1420
- /** @description True if assistant_message-submitted event is one that is associated with a message chunk before the conversation api checks the llm response against guardrails. False if it's the final message chunk sent to the frontend. See event level description for assistant_message-submitted for more detail. */
1421
- is_pre_output_guardrail_checks?: boolean;
1422
- /** @description Describes the stage that the conversation is currently at. A conversation stage is triggered in response to each user message, and according to the stage, the main LLM prompt is tweaked to apply specific instructions and steer the conversation. */
1423
- conversation_stage?: string | null;
1424
- /** @description A list of ids that each relate to a single recommendation that was shown in a set of recs */
1425
- recommendation_ids_recommended?: unknown[];
1426
- /** @description Contains the fallback text provided by the conversation api to a frontend that non 'text' (single_select/multi_select etc) messages could revert to if they needed to. Described in the conversation api docs as: "What should a client render if they do not have a native renderer for this message type?". */
1427
- fallback_text?: string;
1428
- /** @description Specifies if a free text response can be provided to an assistant single/multi-select message */
1429
- is_allow_free_text_message?: boolean;
1430
- /** @description The reason an exit to chat response was provided by the conversation api */
1431
- exit_to_chat_reason?: string;
1001
+ entry_point_click_element?: string;
1432
1002
  /** @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' */
1433
1003
  recommendation_ids_for_exit?: unknown[];
1434
- /** @description The type of destination the user will be sent to as a result of exiting to chat. E.g 'phone','chat','email' etc */
1435
- exit_destination_type?: string;
1436
- /** @description The ID for the sale, a unique, non-empty value we can correlate with customer records. */
1437
- sale_id?: string;
1438
- /** @description The type of user, for example, existing or prospect. */
1439
- user_type?: string;
1440
- /** @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. */
1441
- currency_code?: string;
1442
- /** @description The full basket value of the sale, inclusive of any offers. */
1443
- sale_total_value?: number;
1444
- /** @description A list containing separate line items for each product sold. */
1445
- products_sold?: unknown[];
1446
- /** @description The language of the part of the site the sales data is coming from in ISO 639-1 format e.g. 'en', 'es' etc. */
1447
- language?: string;
1448
- /** @description A list of product items with properties that are specific to Spectrum */
1449
- products_sold_spectrum?: unknown[];
1450
- /** @description Properties at the sale level (not product item level) specifically required from media customers */
1451
- sale_custom_properties_media?: Record<string, never>;
1452
- /** @description A list of product item objects specific to media customers */
1453
- products_sold_media?: unknown[];
1454
- /** @description Properties at the sale level (not product item level) specifically required from Aidem */
1455
- sale_custom_properties_aidem?: Record<string, never>;
1456
- /** @description A list of product items with properties that are specific to Aidem */
1457
- products_sold_aidem?: unknown[];
1458
- /** @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. */
1459
- entry_point_click_type?: string | null;
1460
- /** @description True if user has qualified for using the 15gifts sales advisor (except on customers with no qualification process where this will always be True) */
1461
- is_qualified?: boolean;
1462
- /** @description The stage on the particular customer's site that a user would be expected to qualify at. Should be NULL for customer sites that don't have a qualification process.
1463
- *
1464
- * Stage definitions:
1465
- *
1466
- * website - On a page on the main customer website (and not in either of the below)
1467
- *
1468
- * tool_ui - Within whatever frontend overlay exists that a user would have a conversation in, but not within our actual conversation (managed by conversation api). This value is more aimed to towards something like xfinity on comcast where we have a headless customer and they manage the ui.
1469
- *
1470
- * conversation - Within an actual conversation that is managed by the conversation api (a conversation id should exist at this point) */
1471
- qualification_stage?: string;
1472
1004
  /** @description true if the experiment is the main uplift test, false if it isn't. */
1473
1005
  is_main_uplift_experiment?: boolean;
1474
1006
  /** @description The tracking key that growthbook uses to uniquely identify an experiment. https://docs.growthbook.io/feature-flag-experiments#tracking-key */
@@ -1477,10 +1009,6 @@ interface paths {
1477
1009
  experiment_variation_id?: string;
1478
1010
  /** @description The human readable name for the variation as defined in Growthbook */
1479
1011
  experiment_variation_name?: string;
1480
- /** @description A list of structured information extracted from the conversation that can inform the recommender and the discovery. A single slot would provide a key piece of information such as the users broadband usages (gaming/streaming/working from home).
1481
- *
1482
- * https://backoffice.15gifts.com/product/recommender/slots */
1483
- slots?: unknown[];
1484
1012
  /** @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. */
1485
1013
  entry_point_closed_reason?: string;
1486
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.
@@ -1489,12 +1017,8 @@ interface paths {
1489
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())
1490
1018
  * */
1491
1019
  suppressed_reason?: unknown[];
1492
- /** @description A list of objects for recommendations sent in a conversation api message. */
1493
- recommendation_set?: unknown[];
1494
- /** @description This is a score that evaluates how much progress has been made through the discovery phase of the conversation. A higher score means more information has been discovered. This value is generated by the recommender.
1495
- *
1496
- * https://github.com/15gifts/indy-contracts/blob/main/contracts/recommendation_v2_generate.json#L57 */
1497
- discovery_progress_score?: number;
1020
+ /** @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
+ exit_destination_type?: string;
1498
1022
  /** @description Describes whether a user clicked the thumbs up ('positive') or thumbs down ('negative') on the rec card */
1499
1023
  rec_card_feedback_sentiment?: string;
1500
1024
  /** @description A 32 character alphanumeric hash that uniquely identifies a single rec in a recommendation set.
@@ -1503,19 +1027,12 @@ interface paths {
1503
1027
  * https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4
1504
1028
  *
1505
1029
  * e.g f81d4fae-7dec-41d0-a765-00a0c91e6bf6 */
1506
- recommendation_id?: string | null;
1507
- /** @description The number of tokens contained in the sequence of text sent in a request to an external service (from the user message) */
1508
- external_request_input_token_count?: number;
1509
- /** @description The number of tokens contained in the sequence of text received from sending a request to an external service. Should be null for embedding requests. */
1510
- external_request_output_token_count?: number | null;
1511
- /** @description The type of external request e.g. llm/embedding */
1512
- external_request_type?: string;
1513
- /** @description Describes the subcategory of the request for the purpose of bucketing the higher level request_category into different categories */
1514
- external_request_subtype?: string;
1515
- /** @description The provider an external request is sent to */
1516
- external_request_provider?: string;
1517
- /** @description The model ID is used to determine which exact model we use in an external request e.g. 'gpt-4o-mini' */
1518
- external_request_model_id?: string;
1030
+ recommendation_id?: string;
1031
+ /** @description List of objects that represents the options for single & multiselect questions. */
1032
+ message_select_options?: unknown[];
1033
+ /** @description The text that was visible to the user on the CTA button
1034
+ * */
1035
+ button_text?: string;
1519
1036
  };
1520
1037
  /**
1521
1038
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a conversation
@@ -1526,7 +1043,7 @@ interface paths {
1526
1043
  * @description Event Name
1527
1044
  * @enum {string}
1528
1045
  */
1529
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "ww_user_context-received" | "rec_card_feedback-clicked" | "external_request-submitted" | "external_request-submitted llm" | "external_request-submitted embedding" | "external_request-submitted embedding_service_level" | "ww_prompt_context-used" | "message_select_option-clicked";
1046
+ 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_purchase-clicked';
1530
1047
  /**
1531
1048
  * @description A 36 character hash, 5 segments, separated by dashes that uniquely identifies a page view (page-shown event)
1532
1049
  * @example 1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a
@@ -1543,7 +1060,7 @@ interface paths {
1543
1060
  * screen_width > 480px = 'large'
1544
1061
  * @enum {string}
1545
1062
  */
1546
- screenSize?: "mobile" | "large";
1063
+ screenSize?: 'mobile' | 'large';
1547
1064
  /** @description The device screen width in pixels - window.screen.width in JS. This is a user level property that should never change. */
1548
1065
  screenWidth?: number;
1549
1066
  /** @description The page url at the time the event is fired */
@@ -1893,56 +1410,24 @@ declare class Client {
1893
1410
  feedback_score_num?: number;
1894
1411
  ip_address_hashed?: string;
1895
1412
  tool_ui_closed_reason?: string;
1896
- conversation_turn_num?: number;
1897
- conversation_turn_id?: string;
1898
- message_type?: string;
1899
- message_text?: string;
1900
- message_select_options?: unknown[];
1901
- is_user_message_guardrailed?: boolean;
1902
- guardrails?: unknown[];
1903
- is_pre_output_guardrail_checks?: boolean;
1904
- conversation_stage?: string | null;
1905
- recommendation_ids_recommended?: unknown[];
1906
- fallback_text?: string;
1907
- is_allow_free_text_message?: boolean;
1908
- exit_to_chat_reason?: string;
1909
- recommendation_ids_for_exit?: unknown[];
1910
- exit_destination_type?: string;
1911
- sale_id?: string;
1912
- user_type?: string;
1913
- currency_code?: string;
1914
- sale_total_value?: number;
1915
- products_sold?: unknown[];
1916
- language?: string;
1917
- products_sold_spectrum?: unknown[];
1918
- sale_custom_properties_media?: Record<string, never>;
1919
- products_sold_media?: unknown[];
1920
- sale_custom_properties_aidem?: Record<string, never>;
1921
- products_sold_aidem?: unknown[];
1922
1413
  entry_point_click_type?: string | null;
1923
- is_qualified?: boolean;
1924
- qualification_stage?: string;
1414
+ entry_point_click_element?: string;
1415
+ recommendation_ids_for_exit?: unknown[];
1925
1416
  is_main_uplift_experiment?: boolean;
1926
1417
  experiment_id?: string;
1927
1418
  experiment_variation_id?: string;
1928
1419
  experiment_variation_name?: string;
1929
- slots?: unknown[];
1930
1420
  entry_point_closed_reason?: string;
1931
1421
  suppressed_by?: unknown[];
1932
1422
  suppressed_reason?: unknown[];
1933
- recommendation_set?: unknown[];
1934
- discovery_progress_score?: number;
1423
+ exit_destination_type?: string;
1935
1424
  rec_card_feedback_sentiment?: string;
1936
- recommendation_id?: string | null;
1937
- external_request_input_token_count?: number;
1938
- external_request_output_token_count?: number | null;
1939
- external_request_type?: string;
1940
- external_request_subtype?: string;
1941
- external_request_provider?: string;
1942
- external_request_model_id?: string;
1425
+ recommendation_id?: string;
1426
+ message_select_options?: unknown[];
1427
+ button_text?: string;
1943
1428
  };
1944
1429
  conversationId?: string;
1945
- eventName: "entry_point-shown" | "feedback_submit-clicked" | "page-shown" | "tool_ui-closed" | "user_message-submitted" | "user_message-submitted message" | "user_message-submitted single_select" | "user_message-submitted multi_select" | "assistant_message-submitted" | "assistant_message-submitted recommendation" | "assistant_message-submitted message" | "assistant_message-submitted single_select" | "assistant_message-submitted multi_select" | "assistant_message-submitted exit_to_chat" | "assistant_message-submitted exit_to_purchase" | "assistant_message-submitted exit_to_human" | "feedback-shown" | "feedback_skip-clicked" | "sale-completed" | "sale-completed spectrum" | "sale-completed aidem" | "sale-completed spectrum-us-media-consumer-en" | "entry_point-clicked" | "tool_close-clicked" | "exit_to_chat-completed" | "exit_to_purchase-completed" | "conversation-started" | "user_qualification-identified" | "experiment_variation-assigned" | "slot_filling-completed" | "entry_point-closed" | "entry_point-suppressed" | "user-created" | "exit_to_human-completed" | "recommendation_set-returned" | "ww_rag_context-used" | "ww_user_context-received" | "rec_card_feedback-clicked" | "external_request-submitted" | "external_request-submitted llm" | "external_request-submitted embedding" | "external_request-submitted embedding_service_level" | "ww_prompt_context-used" | "message_select_option-clicked";
1430
+ 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_purchase-clicked";
1946
1431
  pageviewId: string;
1947
1432
  screenHeight?: number;
1948
1433
  screenSize?: "mobile" | "large";