@puppi/adapter-intercom 0.0.0-stage → 0.1.0

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.
@@ -0,0 +1,2696 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export type paths = {
6
+ "/contacts": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ /**
14
+ * List all contacts
15
+ * @description You can fetch a list of all contacts (ie. users or leads) in your workspace.
16
+ * {% admonition type="info" name="Merged contacts" %}
17
+ * Contacts that have been merged (via POST /contacts/merge) will not appear in list results. Only the target contact from the merge remains accessible.
18
+ * {% /admonition %}
19
+ * {% admonition type="warning" name="Pagination" %}
20
+ * You can use pagination to limit the number of results returned. The default is `10` results per page, with a maximum of `150`.
21
+ * See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.
22
+ * {% /admonition %}
23
+ *
24
+ * Requires the `read_users_companies` or `read_write_users` OAuth scope.
25
+ */
26
+ get: operations["ListContacts"];
27
+ put?: never;
28
+ post?: never;
29
+ delete?: never;
30
+ options?: never;
31
+ head?: never;
32
+ patch?: never;
33
+ trace?: never;
34
+ };
35
+ "/conversations": {
36
+ parameters: {
37
+ query?: never;
38
+ header?: never;
39
+ path?: never;
40
+ cookie?: never;
41
+ };
42
+ /**
43
+ * List all conversations
44
+ * @description You can fetch a list of all conversations.
45
+ *
46
+ * You can optionally request the result page size and the cursor to start after to fetch the result.
47
+ * {% admonition type="warning" name="Pagination" %}
48
+ * You can use pagination to limit the number of results returned. The default is `20` results per page.
49
+ * See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.
50
+ * {% /admonition %}
51
+ */
52
+ get: operations["listConversations"];
53
+ put?: never;
54
+ post?: never;
55
+ delete?: never;
56
+ options?: never;
57
+ head?: never;
58
+ patch?: never;
59
+ trace?: never;
60
+ };
61
+ "/companies/scroll": {
62
+ parameters: {
63
+ query?: never;
64
+ header?: never;
65
+ path?: never;
66
+ cookie?: never;
67
+ };
68
+ /**
69
+ * Scroll over all companies
70
+ * @description The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.
71
+ *
72
+ * - Each app can only have 1 scroll open at a time. Starting a second one returns a `400` error with code `scroll_exists`.
73
+ * - If the scroll isn't used for 1 minute, it expires and calls with that scroll param return a `404` error with code `not_found`.
74
+ * - If the end of the scroll is reached, `data` will be empty and the scroll parameter will expire.
75
+ *
76
+ * The response always has `pages` and `total_count` set to `null`. Use `scroll_param` to fetch the next page.
77
+ *
78
+ * {% admonition type="info" name="Scroll Parameter" %}
79
+ * You can get the first page of companies by simply sending a GET request to the scroll endpoint.
80
+ * For subsequent requests you will need to use the scroll parameter from the response.
81
+ * {% /admonition %}
82
+ * {% admonition type="danger" name="Scroll network timeouts" %}
83
+ * Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:
84
+ * "Request failed due to an internal network error. Please restart the scroll operation."
85
+ * If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.
86
+ * {% /admonition %}
87
+ *
88
+ * Requires the `read_users_companies` OAuth scope.
89
+ */
90
+ get: operations["scrollOverAllCompanies"];
91
+ put?: never;
92
+ post?: never;
93
+ delete?: never;
94
+ options?: never;
95
+ head?: never;
96
+ patch?: never;
97
+ trace?: never;
98
+ };
99
+ };
100
+ export type webhooks = Record<string, never>;
101
+ export type components = {
102
+ schemas: {
103
+ /**
104
+ * @description Intercom API version.</br>If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.
105
+ * @example 2.17
106
+ * @enum {string}
107
+ */
108
+ intercom_version: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "2.12" | "2.13" | "2.14" | "2.15" | "2.16" | "2.17";
109
+ /**
110
+ * Contact List
111
+ * @description Contacts are your users in Intercom.
112
+ */
113
+ contact_list: {
114
+ /**
115
+ * @description Always list
116
+ * @example list
117
+ * @enum {string}
118
+ */
119
+ type?: "list";
120
+ /** @description The list of contact objects */
121
+ data?: components["schemas"]["contact"][];
122
+ /**
123
+ * @description A count of the total number of objects.
124
+ * @example 100
125
+ */
126
+ total_count?: number;
127
+ pages?: components["schemas"]["cursor_pages"];
128
+ };
129
+ /**
130
+ * Error
131
+ * @description The API will return an Error List for a failed request, which will contain one or more Error objects.
132
+ */
133
+ error: {
134
+ /**
135
+ * @description The type is error.list
136
+ * @example error.list
137
+ */
138
+ type: string;
139
+ /**
140
+ * Format: uuid
141
+ * @example f93ecfa8-d08a-4325-8694-89aeb89c8f85
142
+ */
143
+ request_id?: string | null;
144
+ /** @description An array of one or more error objects */
145
+ errors: {
146
+ /**
147
+ * @description A string indicating the kind of error, used to further qualify the HTTP response code. A few request validation errors send an HTTP status code as an integer here instead, for example `422`.
148
+ * @example unauthorized
149
+ */
150
+ code: string | number;
151
+ /**
152
+ * @description Optional. Human readable description of the error.
153
+ * @example Access Token Invalid
154
+ */
155
+ message?: string | null;
156
+ /**
157
+ * @description Optional. Extra detail about the error, for example `required_permissions` on a 403 `action_forbidden` error.
158
+ * @example {
159
+ * "required_permissions": [
160
+ * "read_conversations"
161
+ * ]
162
+ * }
163
+ */
164
+ data?: {
165
+ [key: string]: unknown;
166
+ } | null;
167
+ }[];
168
+ };
169
+ /**
170
+ * Conversation List
171
+ * @description Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.
172
+ */
173
+ conversation_list: {
174
+ /**
175
+ * @description Always conversation.list
176
+ * @example conversation.list
177
+ * @enum {string}
178
+ */
179
+ type?: "conversation.list";
180
+ /** @description The list of conversation objects */
181
+ conversations?: components["schemas"]["conversation_list_item"][];
182
+ /**
183
+ * @description A count of the total number of objects.
184
+ * @example 12345
185
+ */
186
+ total_count?: number;
187
+ pages?: components["schemas"]["cursor_pages"];
188
+ };
189
+ /**
190
+ * Company Scroll
191
+ * @description Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.
192
+ */
193
+ company_scroll: {
194
+ /**
195
+ * @description The type of object - `list`
196
+ * @example list
197
+ * @enum {string}
198
+ */
199
+ type?: "list";
200
+ data?: components["schemas"]["company"][];
201
+ /** @description Always `null`. Page through a scroll with `scroll_param` instead. */
202
+ pages?: Record<string, unknown> | null;
203
+ /** @description Always `null`. The scroll endpoint does not count the companies it returns. */
204
+ total_count?: number | null;
205
+ /**
206
+ * @description The scroll parameter to use in the next request to fetch the next page of results.
207
+ * @example 25b649f7-4d33-4ef6-88f5-60e5b8244309
208
+ */
209
+ scroll_param?: string;
210
+ } | null;
211
+ /**
212
+ * Contact
213
+ * @description Contacts represent your leads and users in Intercom.
214
+ */
215
+ contact: {
216
+ /**
217
+ * @description The type of object.
218
+ * @example contact
219
+ */
220
+ type?: string;
221
+ /**
222
+ * @description The unique identifier for the contact which is given by Intercom.
223
+ * @example 5ba682d23d7cf92bef87bfd4
224
+ */
225
+ id?: string;
226
+ /**
227
+ * @description The unique identifier for the contact which is provided by the Client.
228
+ * @example f3b87a2e09d514c6c2e79b9a
229
+ */
230
+ external_id?: string | null;
231
+ /**
232
+ * @description The id of the workspace which the contact belongs to.
233
+ * @example ecahpwf5
234
+ */
235
+ workspace_id?: string;
236
+ /**
237
+ * @description The role of the contact.
238
+ * @example user
239
+ */
240
+ role?: string;
241
+ /**
242
+ * @description The contact's email.
243
+ * @example joe@example.com
244
+ */
245
+ email?: string;
246
+ /**
247
+ * @description The contact's email domain.
248
+ * @example example.com
249
+ */
250
+ email_domain?: string;
251
+ /**
252
+ * @description Whether the contact has proved they own their current email address. `true` only when this address was marked verified through the Contacts API (`email_verified: true` on create or update) and has not changed since; it becomes `false` again if the contact's email changes, until the new address is verified. Intercom reuses a lead with a verified email when it later matches an inbound email, or an outbound conversation or ticket, to that address, instead of creating a new lead. In List contacts and Search contacts responses it is left out only if the contact can't be loaded, for example when it is deleted while the request runs.
253
+ * @example true
254
+ */
255
+ email_verified?: boolean;
256
+ /**
257
+ * @description The contacts phone.
258
+ * @example +1123456789
259
+ */
260
+ phone?: string | null;
261
+ /**
262
+ * @description The contacts name.
263
+ * @example John Doe
264
+ */
265
+ name?: string | null;
266
+ /**
267
+ * @description The id of an admin that has been assigned account ownership of the contact.
268
+ * @example 321
269
+ */
270
+ owner_id?: string | null;
271
+ /**
272
+ * @description Whether the contact has had an email sent to them hard bounce.
273
+ * @example true
274
+ */
275
+ has_hard_bounced?: boolean;
276
+ /**
277
+ * @description Whether the contact has marked an email sent to them as spam.
278
+ * @example true
279
+ */
280
+ marked_email_as_spam?: boolean;
281
+ /**
282
+ * @description Whether the contact is unsubscribed from emails.
283
+ * @example true
284
+ */
285
+ unsubscribed_from_emails?: boolean;
286
+ /**
287
+ * Format: date-time
288
+ * @description (Unix timestamp in seconds) The time when the contact was created.
289
+ * @example 1571672154
290
+ */
291
+ created_at?: number;
292
+ /**
293
+ * Format: date-time
294
+ * @description (Unix timestamp in seconds) The time when the contact was last updated.
295
+ * @example 1571672154
296
+ */
297
+ updated_at?: number;
298
+ /**
299
+ * Format: date-time
300
+ * @description (Unix timestamp in seconds) The time specified for when a contact signed up.
301
+ * @example 1571672154
302
+ */
303
+ signed_up_at?: number | null;
304
+ /**
305
+ * Format: date-time
306
+ * @description (Unix timestamp in seconds) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).
307
+ * @example 1571672154
308
+ */
309
+ last_seen_at?: number | null;
310
+ /**
311
+ * Format: date-time
312
+ * @description (Unix timestamp in seconds) The time when the contact last messaged in.
313
+ * @example 1571672154
314
+ */
315
+ last_replied_at?: number | null;
316
+ /**
317
+ * Format: date-time
318
+ * @description (Unix timestamp in seconds) The time when the contact was last messaged.
319
+ * @example 1571672154
320
+ */
321
+ last_contacted_at?: number | null;
322
+ /**
323
+ * Format: date-time
324
+ * @description (Unix timestamp in seconds) The time when the contact last opened an email.
325
+ * @example 1571672154
326
+ */
327
+ last_email_opened_at?: number | null;
328
+ /**
329
+ * Format: date-time
330
+ * @description (Unix timestamp in seconds) The time when the contact last clicked a link in an email.
331
+ * @example 1571672154
332
+ */
333
+ last_email_clicked_at?: number | null;
334
+ /**
335
+ * @description A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.
336
+ * @example en
337
+ */
338
+ language_override?: string | null;
339
+ /**
340
+ * @description The name of the browser which the contact is using.
341
+ * @example Chrome
342
+ */
343
+ browser?: string | null;
344
+ /**
345
+ * @description The version of the browser which the contact is using.
346
+ * @example 80.0.3987.132
347
+ */
348
+ browser_version?: string | null;
349
+ /**
350
+ * @description The language set by the browser which the contact is using.
351
+ * @example en-US
352
+ */
353
+ browser_language?: string | null;
354
+ /**
355
+ * @description The operating system which the contact is using.
356
+ * @example Mac OS X
357
+ */
358
+ os?: string | null;
359
+ /**
360
+ * @description The name of the Android app which the contact is using.
361
+ * @example Intercom
362
+ */
363
+ android_app_name?: string | null;
364
+ /**
365
+ * @description The version of the Android app which the contact is using.
366
+ * @example 5.0.0
367
+ */
368
+ android_app_version?: string | null;
369
+ /**
370
+ * @description The Android device which the contact is using.
371
+ * @example Pixel 3
372
+ */
373
+ android_device?: string | null;
374
+ /**
375
+ * @description The version of the Android OS which the contact is using.
376
+ * @example 10
377
+ */
378
+ android_os_version?: string | null;
379
+ /**
380
+ * @description The version of the Android SDK which the contact is using.
381
+ * @example 28
382
+ */
383
+ android_sdk_version?: string | null;
384
+ /**
385
+ * Format: date-time
386
+ * @description (Unix timestamp in seconds) The time when the contact was last seen on an Android device.
387
+ * @example 1571672154
388
+ */
389
+ android_last_seen_at?: number | null;
390
+ /**
391
+ * @description The name of the iOS app which the contact is using.
392
+ * @example Intercom
393
+ */
394
+ ios_app_name?: string | null;
395
+ /**
396
+ * @description The version of the iOS app which the contact is using.
397
+ * @example 5.0.0
398
+ */
399
+ ios_app_version?: string | null;
400
+ /**
401
+ * @description The iOS device which the contact is using.
402
+ * @example iPhone 11
403
+ */
404
+ ios_device?: string | null;
405
+ /**
406
+ * @description The version of iOS which the contact is using.
407
+ * @example 13.3.1
408
+ */
409
+ ios_os_version?: string | null;
410
+ /**
411
+ * @description The version of the iOS SDK which the contact is using.
412
+ * @example 13.3.1
413
+ */
414
+ ios_sdk_version?: string | null;
415
+ /**
416
+ * Format: date-time
417
+ * @description (Unix timestamp in seconds) The last time the contact used the iOS app.
418
+ * @example 1571672154
419
+ */
420
+ ios_last_seen_at?: number | null;
421
+ /** @description The custom attributes which are set for the contact. */
422
+ custom_attributes?: Record<string, unknown>;
423
+ /**
424
+ * Format: uri
425
+ * @description An image URL containing the avatar of a contact.
426
+ * @example https://example.org/128Wash.jpg
427
+ */
428
+ avatar?: string | null;
429
+ tags?: components["schemas"]["contact_tags"];
430
+ notes?: components["schemas"]["contact_notes"];
431
+ companies?: components["schemas"]["contact_companies"];
432
+ location?: components["schemas"]["contact_location"];
433
+ social_profiles?: components["schemas"]["contact_social_profiles"];
434
+ opted_out_subscription_types?: components["schemas"]["contact_subscription_types"];
435
+ opted_in_subscription_types?: components["schemas"]["contact_subscription_types"];
436
+ /**
437
+ * @description The `utm_campaign` value recorded for the contact.
438
+ * @example spring_launch
439
+ */
440
+ utm_campaign?: string | null;
441
+ /**
442
+ * @description The `utm_content` value recorded for the contact.
443
+ * @example banner_ad
444
+ */
445
+ utm_content?: string | null;
446
+ /**
447
+ * @description The `utm_medium` value recorded for the contact.
448
+ * @example email
449
+ */
450
+ utm_medium?: string | null;
451
+ /**
452
+ * @description The `utm_source` value recorded for the contact.
453
+ * @example newsletter
454
+ */
455
+ utm_source?: string | null;
456
+ /**
457
+ * @description The `utm_term` value recorded for the contact.
458
+ * @example support_software
459
+ */
460
+ utm_term?: string | null;
461
+ /**
462
+ * @description The URL of the page the contact came from, as recorded by the Messenger.
463
+ * @example https://example.com/pricing
464
+ */
465
+ referrer?: string | null;
466
+ /**
467
+ * @description Whether the contact has consented to receive SMS messages.
468
+ * @example false
469
+ */
470
+ sms_consent?: boolean;
471
+ /**
472
+ * @description Whether the contact is unsubscribed from SMS messages.
473
+ * @example false
474
+ */
475
+ unsubscribed_from_sms?: boolean;
476
+ /**
477
+ * @description Whether the contact has a mobile device registered to receive push messages.
478
+ * @example true
479
+ */
480
+ enabled_push_messaging?: boolean | null;
481
+ /** @description A list of contacts that were merged into this contact, most recent first, capped at 10. Only included in the response when `include_merge_history=true` is passed as a query parameter. */
482
+ merge_history?: components["schemas"]["merge_history_item"][] | null;
483
+ };
484
+ /**
485
+ * Cursor based pages
486
+ * @description Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.
487
+ * A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
488
+ */
489
+ cursor_pages: {
490
+ /**
491
+ * @description the type of object `pages`.
492
+ * @example pages
493
+ * @enum {string}
494
+ */
495
+ type?: "pages";
496
+ /**
497
+ * @description The current page
498
+ * @example 1
499
+ */
500
+ page?: number;
501
+ /** @description Fetch the next page by sending this `starting_after` cursor. Omitted on the last page. */
502
+ next?: {
503
+ /**
504
+ * @description The number of the next page
505
+ * @example 2
506
+ */
507
+ page?: number;
508
+ /**
509
+ * @description The cursor to send in the next request to get the next page of results.
510
+ * @example your-cursor-from-response
511
+ */
512
+ starting_after?: string;
513
+ } | null;
514
+ /**
515
+ * @description Number of results per page
516
+ * @example 2
517
+ */
518
+ per_page?: number;
519
+ /**
520
+ * @description Total number of pages
521
+ * @example 13
522
+ */
523
+ total_pages?: number;
524
+ } | null;
525
+ /**
526
+ * Conversation List Item
527
+ * @description The data returned about your conversations when you list or search them.
528
+ */
529
+ conversation_list_item: {
530
+ /**
531
+ * @description Always conversation.
532
+ * @example conversation
533
+ */
534
+ type?: string;
535
+ /**
536
+ * @description The id representing the conversation.
537
+ * @example 1295
538
+ */
539
+ id?: string;
540
+ /**
541
+ * @description The title given to the conversation.
542
+ * @example Conversation Title
543
+ */
544
+ title?: string | null;
545
+ /**
546
+ * Format: date-time
547
+ * @description The time the conversation was created.
548
+ * @example 1663597223
549
+ */
550
+ created_at?: number;
551
+ /**
552
+ * Format: date-time
553
+ * @description The last time the conversation was updated.
554
+ * @example 1663597260
555
+ */
556
+ updated_at?: number;
557
+ /**
558
+ * Format: date-time
559
+ * @description The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.
560
+ * @example 1663597260
561
+ */
562
+ waiting_since?: number | null;
563
+ /**
564
+ * Format: date-time
565
+ * @description If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.
566
+ * @example 1663597260
567
+ */
568
+ snoozed_until?: number | null;
569
+ /**
570
+ * @description Indicates whether a conversation is open (true) or closed (false).
571
+ * @example true
572
+ */
573
+ open?: boolean;
574
+ /**
575
+ * @description Can be set to "open", "closed" or "snoozed".
576
+ * @example open
577
+ * @enum {string}
578
+ */
579
+ state?: "open" | "closed" | "snoozed";
580
+ /**
581
+ * @description Indicates whether a conversation has been read.
582
+ * @example true
583
+ */
584
+ read?: boolean;
585
+ /**
586
+ * @description The priority level of the conversation. Returns one of none, low, medium, high, or urgent.
587
+ * @example high
588
+ * @enum {string}
589
+ */
590
+ priority?: "none" | "low" | "medium" | "high" | "urgent";
591
+ /**
592
+ * @description The id of the admin assigned to the conversation. If it's not assigned to an admin it will return 0.
593
+ * @example 0
594
+ */
595
+ admin_assignee_id?: number;
596
+ /**
597
+ * @description The id of the team assigned to the conversation. If it's not assigned to a team it will return 0.
598
+ * @example 5017691
599
+ */
600
+ team_assignee_id?: number;
601
+ /** @description The company associated with the conversation. */
602
+ company?: components["schemas"]["company"];
603
+ tags?: components["schemas"]["tags"];
604
+ conversation_rating?: components["schemas"]["conversation_rating"];
605
+ source?: components["schemas"]["conversation_source"];
606
+ contacts?: components["schemas"]["conversation_contacts"];
607
+ teammates?: components["schemas"]["conversation_teammates"];
608
+ custom_attributes?: components["schemas"]["custom_attributes"];
609
+ first_contact_reply?: components["schemas"]["conversation_first_contact_reply"];
610
+ sla_applied?: components["schemas"]["sla_applied"];
611
+ statistics?: components["schemas"]["conversation_statistics"];
612
+ linked_objects?: components["schemas"]["linked_object_list"];
613
+ /**
614
+ * @description Indicates whether the AI Agent participated in the conversation.
615
+ * @example true
616
+ */
617
+ ai_agent_participated?: boolean;
618
+ ai_agent?: components["schemas"]["ai_agent"];
619
+ /**
620
+ * @description Indicates whether the Sales Agent participated in the conversation.
621
+ * @example false
622
+ */
623
+ sales_agent_participated?: boolean;
624
+ sales_agent?: components["schemas"]["sales_agent"];
625
+ /** @description The channel through which the conversation was initiated and its current channel. */
626
+ channel?: components["schemas"]["conversation_channel"] | null;
627
+ /** @description The topics of the conversation. An empty object when the workspace doesn't use topics. */
628
+ topics?: {
629
+ /**
630
+ * @description Always `topic.list`.
631
+ * @example topic.list
632
+ */
633
+ type?: string;
634
+ /** @description The topics of the conversation. */
635
+ topics?: {
636
+ /**
637
+ * @description Always `topic`.
638
+ * @example topic
639
+ */
640
+ type?: string;
641
+ /**
642
+ * @description The id of the topic.
643
+ * @example 4521
644
+ */
645
+ id?: number;
646
+ /**
647
+ * @description The name of the topic.
648
+ * @example Billing
649
+ */
650
+ name?: string;
651
+ }[];
652
+ /**
653
+ * @description The number of topics.
654
+ * @example 1
655
+ */
656
+ total_count?: number;
657
+ };
658
+ /** @description The ticket details when the conversation is a ticket. `null` for any other conversation. */
659
+ ticket?: {
660
+ /**
661
+ * @description Always `ticket`.
662
+ * @example ticket
663
+ */
664
+ type?: string;
665
+ /**
666
+ * @description The id of the ticket's conversation.
667
+ * @example 1295
668
+ */
669
+ id?: number;
670
+ /**
671
+ * @description The link to the ticket in the inbox.
672
+ * @example https://app.intercom.com/a/apps/abcd1234/conversations/1295
673
+ */
674
+ url?: string;
675
+ /** @description The ticket's attributes, keyed by attribute name. */
676
+ custom_attributes?: {
677
+ [key: string]: {
678
+ /** @description The value of the attribute. */
679
+ value?: (string | null) | number | boolean | number[] | components["schemas"]["file_attribute"];
680
+ /**
681
+ * @description The data type of the attribute.
682
+ * @example string
683
+ */
684
+ type?: string;
685
+ };
686
+ };
687
+ /**
688
+ * @description The current state of the ticket.
689
+ * @example submitted
690
+ */
691
+ state?: string;
692
+ /**
693
+ * @description The name of the ticket type.
694
+ * @example Bug report
695
+ */
696
+ ticket_type?: string;
697
+ /**
698
+ * @description The description of the ticket type.
699
+ * @example Something is broken
700
+ */
701
+ ticket_type_description?: string;
702
+ /**
703
+ * @description The emoji of the ticket type.
704
+ * @example 🐛
705
+ */
706
+ ticket_type_emoji?: string | null;
707
+ /**
708
+ * @description The label of the ticket's state as teammates see it.
709
+ * @example Submitted
710
+ */
711
+ ticket_custom_state_admin_label?: string | null;
712
+ /**
713
+ * @description The label of the ticket's state as the customer sees it.
714
+ * @example Received
715
+ */
716
+ ticket_custom_state_user_label?: string | null;
717
+ } | null;
718
+ /**
719
+ * @description References linking this conversation to records in an external helpdesk or CRM system. Populated for Fin Standalone workspaces synced from an external platform; an empty array otherwise. Sorted alphabetically by `type` and capped at 20 entries.
720
+ * @example [
721
+ * {
722
+ * "type": "zendesk_ticket",
723
+ * "id": "3633338"
724
+ * },
725
+ * {
726
+ * "type": "zendesk_sunshine_conversation",
727
+ * "id": "abc-def-uuid"
728
+ * }
729
+ * ]
730
+ */
731
+ external_references?: components["schemas"]["conversation_external_reference"][];
732
+ /** @description The latest QA monitor evaluation for each monitor that has evaluated this conversation, whatever its result. Only included when `include_monitors=true` is passed as a query parameter. */
733
+ monitor_evaluations?: components["schemas"]["conversation_monitor_evaluation"][];
734
+ /** @description QA scorecard results for this conversation. Only included when `include_scorecards=true` is passed as a query parameter. */
735
+ scorecards?: components["schemas"]["conversation_scorecard"][];
736
+ };
737
+ /**
738
+ * Company
739
+ * @description Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.
740
+ */
741
+ company: {
742
+ /**
743
+ * @description Value is `company`
744
+ * @example company
745
+ * @enum {string}
746
+ */
747
+ type?: "company";
748
+ /**
749
+ * @description The Intercom defined id representing the company.
750
+ * @example 531ee472cce572a6ec000006
751
+ */
752
+ id?: string;
753
+ /**
754
+ * @description The name of the company. Returned HTML-escaped, for example `&` as `&amp;`.
755
+ * @example Blue Sun
756
+ */
757
+ name?: string;
758
+ /**
759
+ * @description The Intercom defined code of the workspace the company is associated to.
760
+ * @example ecahpwf5
761
+ */
762
+ app_id?: string;
763
+ plan?: {
764
+ /**
765
+ * @description Value is always "plan"
766
+ * @example plan
767
+ */
768
+ type?: string;
769
+ /**
770
+ * @description The id of the plan
771
+ * @example 269315
772
+ */
773
+ id?: string;
774
+ /**
775
+ * @description The name of the plan
776
+ * @example Pro
777
+ */
778
+ name?: string;
779
+ };
780
+ /**
781
+ * @description The company id you have defined for the company. Returned HTML-escaped, for example `&` as `&amp;`.
782
+ * @example 6
783
+ */
784
+ company_id?: string;
785
+ /**
786
+ * @description The time the company was created by you.
787
+ * @example 1663597223
788
+ */
789
+ remote_created_at?: number;
790
+ /**
791
+ * @description The time the company was added in Intercom.
792
+ * @example 1663597223
793
+ */
794
+ created_at?: number;
795
+ /**
796
+ * @description The last time the company was updated.
797
+ * @example 1663597223
798
+ */
799
+ updated_at?: number;
800
+ /**
801
+ * @description The time the company last recorded making a request.
802
+ * @example 1663597223
803
+ */
804
+ last_request_at?: number;
805
+ /**
806
+ * @description The number of employees in the company.
807
+ * @example 100
808
+ */
809
+ size?: number;
810
+ /**
811
+ * @description The URL for the company website.
812
+ * @example https://www.intercom.com
813
+ */
814
+ website?: string;
815
+ /**
816
+ * @description The industry that the company operates in.
817
+ * @example Software
818
+ */
819
+ industry?: string;
820
+ /**
821
+ * @description How much revenue the company generates for your business.
822
+ * @example 100
823
+ */
824
+ monthly_spend?: number;
825
+ /**
826
+ * @description How many sessions the company has recorded.
827
+ * @example 100
828
+ */
829
+ session_count?: number;
830
+ /**
831
+ * @description The number of users in the company.
832
+ * @example 100
833
+ */
834
+ user_count?: number;
835
+ /**
836
+ * @description The custom attributes you have set on the company.
837
+ * @example {
838
+ * "paid_subscriber": true,
839
+ * "monthly_spend": 155.5,
840
+ * "team_mates": 9
841
+ * }
842
+ */
843
+ custom_attributes?: {
844
+ [key: string]: (string | null) | number | boolean;
845
+ };
846
+ /** @description The list of tags associated with the company */
847
+ tags?: {
848
+ /**
849
+ * @description The type of the object
850
+ * @enum {string}
851
+ */
852
+ type?: "tag.list";
853
+ tags?: components["schemas"]["tag_basic"][];
854
+ };
855
+ /** @description Always returned empty. Fetch a company's segments with the list attached segments endpoint. */
856
+ segments?: {
857
+ /**
858
+ * @description The type of the object
859
+ * @enum {string}
860
+ */
861
+ type?: "segment.list";
862
+ segments?: components["schemas"]["segment"][];
863
+ };
864
+ /** @description The list of notes associated with the company */
865
+ notes?: {
866
+ /**
867
+ * @description The type of the object
868
+ * @enum {string}
869
+ */
870
+ type?: "note.list";
871
+ /** @description The notes on the company, newest first. */
872
+ data?: components["schemas"]["company_note"][];
873
+ /**
874
+ * @description The relative URL of the company's notes.
875
+ * @example /companies/531ee472cce572a6ec000006/notes
876
+ */
877
+ url?: string;
878
+ /**
879
+ * @description The number of notes in `data`.
880
+ * @example 1
881
+ */
882
+ total_count?: number;
883
+ /**
884
+ * @description Always `false`. Every note on the company is returned in `data`.
885
+ * @example false
886
+ */
887
+ has_more?: boolean;
888
+ };
889
+ };
890
+ /**
891
+ * Contact Tags
892
+ * @description An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.
893
+ */
894
+ contact_tags: {
895
+ /** @description This object represents the tags attached to a contact. */
896
+ data?: components["schemas"]["addressable_list"][];
897
+ /**
898
+ * Format: uri
899
+ * @description url to get more tag resources for this contact
900
+ * @example /contacts/5ba682d23d7cf92bef87bfd4/tags
901
+ */
902
+ url?: string;
903
+ /**
904
+ * @description Int representing the total number of tags attached to this contact
905
+ * @example 100
906
+ */
907
+ total_count?: number;
908
+ /**
909
+ * @description Whether there's more Addressable Objects to be viewed. If true, use the url to view all
910
+ * @example true
911
+ */
912
+ has_more?: boolean;
913
+ } | null;
914
+ /**
915
+ * Contact notes
916
+ * @description An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.
917
+ */
918
+ contact_notes: {
919
+ /** @description This object represents the notes attached to a contact. */
920
+ data?: components["schemas"]["addressable_list"][];
921
+ /**
922
+ * Format: uri
923
+ * @description Url to get more company resources for this contact
924
+ * @example /contacts/5ba682d23d7cf92bef87bfd4/notes
925
+ */
926
+ url?: string;
927
+ /**
928
+ * @description Int representing the total number of companyies attached to this contact
929
+ * @example 100
930
+ */
931
+ total_count?: number;
932
+ /**
933
+ * @description Whether there's more Addressable Objects to be viewed. If true, use the url to view all
934
+ * @example true
935
+ */
936
+ has_more?: boolean;
937
+ };
938
+ /**
939
+ * Contact companies
940
+ * @description An object with metadata about companies attached to a contact . Up to 10 will be displayed here. Use the url to get more.
941
+ */
942
+ contact_companies: {
943
+ /** @description An array of company data objects attached to the contact. */
944
+ data?: components["schemas"]["company_data"][];
945
+ /**
946
+ * Format: uri
947
+ * @description Url to get more company resources for this contact
948
+ * @example /contacts/5ba682d23d7cf92bef87bfd4/companies
949
+ */
950
+ url?: string;
951
+ /**
952
+ * @description Integer representing the total number of companies attached to this contact
953
+ * @example 100
954
+ */
955
+ total_count?: number;
956
+ /**
957
+ * @description Whether there's more Addressable Objects to be viewed. If true, use the url to view all
958
+ * @example true
959
+ */
960
+ has_more?: boolean;
961
+ };
962
+ /**
963
+ * Contact Location
964
+ * @description An object containing location meta data about a Intercom contact.
965
+ */
966
+ contact_location: {
967
+ /**
968
+ * @description Always location
969
+ * @example location
970
+ */
971
+ type?: string | null;
972
+ /**
973
+ * @description The country that the contact is located in
974
+ * @example Ireland
975
+ */
976
+ country?: string | null;
977
+ /**
978
+ * @description The overal region that the contact is located in
979
+ * @example Dublin
980
+ */
981
+ region?: string | null;
982
+ /**
983
+ * @description The city that the contact is located in
984
+ * @example Dublin
985
+ */
986
+ city?: string | null;
987
+ /**
988
+ * @description The ISO 3166-1 alpha-3 code of the country that the contact is located in
989
+ * @example IRL
990
+ */
991
+ country_code?: string | null;
992
+ /**
993
+ * @description The code of the continent that the contact is located in
994
+ * @example EU
995
+ */
996
+ continent_code?: string | null;
997
+ };
998
+ /**
999
+ * Social Profile
1000
+ * @description An object containing social profiles that a contact has.
1001
+ */
1002
+ contact_social_profiles: {
1003
+ /** @description A list of social profiles objects associated with the contact. */
1004
+ data?: components["schemas"]["social_profile"][];
1005
+ };
1006
+ /**
1007
+ * Contact Subscription Types
1008
+ * @description An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.
1009
+ */
1010
+ contact_subscription_types: {
1011
+ /**
1012
+ * @description The type of the object
1013
+ * @example list
1014
+ * @enum {string}
1015
+ */
1016
+ type?: "list";
1017
+ /** @description This object represents the subscriptions attached to a contact. */
1018
+ data?: components["schemas"]["addressable_list"][];
1019
+ /**
1020
+ * Format: uri
1021
+ * @description Url to get more subscription type resources for this contact
1022
+ * @example /contacts/5ba682d23d7cf92bef87bfd4/subscriptions
1023
+ */
1024
+ url?: string;
1025
+ /**
1026
+ * @description Int representing the total number of subscription types attached to this contact
1027
+ * @example 100
1028
+ */
1029
+ total_count?: number;
1030
+ /**
1031
+ * @description Whether there's more Addressable Objects to be viewed. If true, use the url to view all
1032
+ * @example true
1033
+ */
1034
+ has_more?: boolean;
1035
+ };
1036
+ /**
1037
+ * Merge History Item
1038
+ * @description A record of a contact that was merged into another contact.
1039
+ */
1040
+ merge_history_item: {
1041
+ /**
1042
+ * @description The type of object.
1043
+ * @example merge_history
1044
+ */
1045
+ type?: string;
1046
+ /**
1047
+ * @description The Intercom ID of the contact that was merged into this contact.
1048
+ * @example 5ba682d23d7cf92bef87bfd3
1049
+ */
1050
+ source_contact_id?: string;
1051
+ /**
1052
+ * @description The role of the contact that was merged in.
1053
+ * @example lead
1054
+ * @enum {string}
1055
+ */
1056
+ source_contact_role?: "lead" | "user";
1057
+ /**
1058
+ * Format: date-time
1059
+ * @description (Unix timestamp in seconds) The time when the merge occurred.
1060
+ * @example 1571672154
1061
+ */
1062
+ merged_at?: number | null;
1063
+ };
1064
+ /**
1065
+ * Tags
1066
+ * @description A list of tags objects associated with a conversation, article or internal article
1067
+ */
1068
+ tags: {
1069
+ /**
1070
+ * @description The type of the object
1071
+ * @example tag.list
1072
+ * @enum {string}
1073
+ */
1074
+ type?: "tag.list";
1075
+ /** @description A list of tags objects associated with the object. */
1076
+ tags?: components["schemas"]["tag"][];
1077
+ };
1078
+ /**
1079
+ * Conversation Rating
1080
+ * @description The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.
1081
+ */
1082
+ conversation_rating: {
1083
+ /**
1084
+ * @description The rating, between 1 and 5, for the conversation.
1085
+ * @example 5
1086
+ */
1087
+ rating?: number;
1088
+ /**
1089
+ * @description An optional field to add a remark to correspond to the number rating
1090
+ * @example
1091
+ */
1092
+ remark?: string;
1093
+ /**
1094
+ * Format: date-time
1095
+ * @description The time the rating was requested in the conversation being rated.
1096
+ * @example 1671028894
1097
+ */
1098
+ created_at?: number;
1099
+ /**
1100
+ * Format: date-time
1101
+ * @description The time the rating was last updated.
1102
+ * @example 1671028894
1103
+ */
1104
+ updated_at?: number;
1105
+ contact?: components["schemas"]["contact_reference"];
1106
+ /**
1107
+ * Conversation Rating Teammate
1108
+ * @description The teammate, bot or workflow the rating is attributed to.
1109
+ */
1110
+ teammate?: {
1111
+ /**
1112
+ * @description The type of the rated actor. `workflow` when a workflow requested the rating and no teammate took part.
1113
+ * @example admin
1114
+ * @enum {string}
1115
+ */
1116
+ type?: "admin" | "team" | "bot" | "workflow";
1117
+ /**
1118
+ * @description The unique identifier for the rated actor.
1119
+ * @example 123
1120
+ */
1121
+ id?: string;
1122
+ } | null;
1123
+ } | null;
1124
+ /**
1125
+ * Conversation source
1126
+ * @description The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.
1127
+ */
1128
+ conversation_source: {
1129
+ /**
1130
+ * @description The origin of this conversation.
1131
+ * @example email
1132
+ */
1133
+ type?: string;
1134
+ /**
1135
+ * @description The id of the source message.
1136
+ * @example 3
1137
+ */
1138
+ id?: string | null;
1139
+ /**
1140
+ * @description How the conversation was initiated.
1141
+ * @example operator_initiated
1142
+ */
1143
+ delivered_as?: string;
1144
+ /** @description The recipients of the source message. Only present for email conversations. */
1145
+ recipients?: {
1146
+ /**
1147
+ * @description The recipient type. One of `to`, `cc`, or `bcc`.
1148
+ * @example to
1149
+ */
1150
+ type?: string;
1151
+ /**
1152
+ * Format: email
1153
+ * @description The recipient email address.
1154
+ * @example user@example.com
1155
+ */
1156
+ email?: string;
1157
+ /**
1158
+ * @description The reason this recipient was dropped, if applicable.
1159
+ * @example null
1160
+ */
1161
+ drop_reason?: string | null;
1162
+ }[] | null;
1163
+ /** @description The Reply-To header addresses of the source message, where a reply will be routed. Can differ from the sender's From address. Only present for email conversations. */
1164
+ reply_to?: {
1165
+ /**
1166
+ * Format: email
1167
+ * @description The Reply-To email address.
1168
+ * @example replies@example.com
1169
+ */
1170
+ email?: string;
1171
+ /**
1172
+ * @description The display name associated with the Reply-To address.
1173
+ * @example Support Team
1174
+ */
1175
+ name?: string | null;
1176
+ }[] | null;
1177
+ /**
1178
+ * @description Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. In webhook payloads for API version 2.15+, this field returns plain text.
1179
+ * @example
1180
+ */
1181
+ subject?: string;
1182
+ /**
1183
+ * @description The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text.
1184
+ * @example <p>Hey there!</p>
1185
+ */
1186
+ body?: string;
1187
+ author?: components["schemas"]["conversation_source_author"];
1188
+ /** @description A list of attachments for the part. */
1189
+ attachments?: components["schemas"]["part_attachment"][];
1190
+ /**
1191
+ * @description The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.
1192
+ * @example null
1193
+ */
1194
+ url?: string | null;
1195
+ /**
1196
+ * @description Whether or not the source message has been redacted. Only applicable for contact initiated messages.
1197
+ * @example false
1198
+ */
1199
+ redacted?: boolean;
1200
+ email_message_metadata?: components["schemas"]["source_email_message_metadata"];
1201
+ };
1202
+ /**
1203
+ * Contacts
1204
+ * @description The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.
1205
+ */
1206
+ conversation_contacts: {
1207
+ /**
1208
+ * @example contact.list
1209
+ * @enum {string}
1210
+ */
1211
+ type?: "contact.list";
1212
+ /** @description The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature. */
1213
+ contacts?: components["schemas"]["contact_reference"][];
1214
+ };
1215
+ /**
1216
+ * Conversation teammates
1217
+ * @description The list of teammates who participated in the conversation (wrote at least one conversation part).
1218
+ */
1219
+ conversation_teammates: {
1220
+ /**
1221
+ * @description The type of the object - `admin.list`.
1222
+ * @example admin.list
1223
+ */
1224
+ type?: string;
1225
+ /** @description The list of teammates who participated in the conversation (wrote at least one conversation part). */
1226
+ admins?: components["schemas"]["reference"][];
1227
+ } | null;
1228
+ /**
1229
+ * Custom Attributes
1230
+ * @description An object containing the custom attributes on a conversation as key-value pairs. For relationship attributes the value is a list of custom object instance models. System-defined attributes such as "AI Topic and Subtopic", "CX Score rating", "CX Score explanation" and "CX Score reasons" may also be included.
1231
+ * @example {
1232
+ * "paid_subscriber": true,
1233
+ * "monthly_spend": 155.5,
1234
+ * "team_mates": 9,
1235
+ * "start_date_iso8601": "2023-03-04T09:46:14Z",
1236
+ * "end_date_timestamp": 1677923174,
1237
+ * "CX Score rating": 4,
1238
+ * "CX Score explanation": "The conversation was resolved quickly and the customer expressed satisfaction with the outcome.",
1239
+ * "AI Topic and Subtopic": [
1240
+ * {
1241
+ * "topic_name": "Billing",
1242
+ * "subtopic_name": "Payment Issues",
1243
+ * "id": 42
1244
+ * }
1245
+ * ],
1246
+ * "CX Score reasons": [
1247
+ * {
1248
+ * "name": "Resolution speed",
1249
+ * "value": "Fast"
1250
+ * }
1251
+ * ]
1252
+ * }
1253
+ */
1254
+ custom_attributes: {
1255
+ /**
1256
+ * @description Read-only AI Insights classification of the conversation. Present only with the AI add-on; omitted when the conversation has no classification.
1257
+ * @example [
1258
+ * {
1259
+ * "topic_name": "Billing",
1260
+ * "subtopic_name": "Payment Issues",
1261
+ * "id": 42
1262
+ * }
1263
+ * ]
1264
+ */
1265
+ readonly "AI Topic and Subtopic"?: components["schemas"]["ai_topic_subtopic"][];
1266
+ /**
1267
+ * @description Read-only reasons behind the conversation's CX Score. Intercom generates this attribute, so it cannot be set. Omitted when the conversation has no CX Score reasons.
1268
+ * @example [
1269
+ * {
1270
+ * "name": "Resolution speed",
1271
+ * "value": "Fast"
1272
+ * }
1273
+ * ]
1274
+ */
1275
+ readonly "CX Score reasons"?: components["schemas"]["cx_score_reason"][];
1276
+ } & {
1277
+ [key: string]: string | number | boolean | components["schemas"]["datetime"] | components["schemas"]["custom_object_instance_list"];
1278
+ };
1279
+ /**
1280
+ * First contact reply
1281
+ * @description An object containing information on the first users message. For a contact initiated message this will represent the users original message.
1282
+ */
1283
+ conversation_first_contact_reply: {
1284
+ /**
1285
+ * Format: date-time
1286
+ * @example 1663597223
1287
+ */
1288
+ created_at?: number;
1289
+ /** @example conversation */
1290
+ type?: string;
1291
+ /** @example https://developers.intercom.com/ */
1292
+ url?: string | null;
1293
+ } | null;
1294
+ /**
1295
+ * Applied SLA
1296
+ * @description The SLA Applied object contains the details for which SLA has been applied to this conversation.
1297
+ * Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.
1298
+ */
1299
+ sla_applied: {
1300
+ /**
1301
+ * @description object type
1302
+ * @example conversation_sla_summary
1303
+ */
1304
+ type?: string;
1305
+ /**
1306
+ * @description The name of the SLA as given by the teammate when it was created.
1307
+ * @example
1308
+ */
1309
+ sla_name?: string;
1310
+ /**
1311
+ * @description SLA statuses:
1312
+ * - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.
1313
+ * - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.
1314
+ * - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.
1315
+ * @example hit
1316
+ * @enum {string}
1317
+ */
1318
+ sla_status?: "hit" | "missed" | "canceled" | "active";
1319
+ } | null;
1320
+ /**
1321
+ * Conversation statistics
1322
+ * @description A Statistics object containing all information required for reporting, with timestamps and calculated metrics.
1323
+ */
1324
+ conversation_statistics: {
1325
+ /** @example conversation_statistics */
1326
+ type?: string;
1327
+ /**
1328
+ * @description Duration until last assignment before first admin reply. In seconds.
1329
+ * @example 2310
1330
+ */
1331
+ time_to_assignment?: number;
1332
+ /**
1333
+ * @description Duration until first admin reply. Subtracts out of business hours. In seconds.
1334
+ * @example 2310
1335
+ */
1336
+ time_to_admin_reply?: number;
1337
+ /**
1338
+ * @description Duration until conversation was closed first time. Subtracts out of business hours. In seconds.
1339
+ * @example 2310
1340
+ */
1341
+ time_to_first_close?: number;
1342
+ /**
1343
+ * @description Duration until conversation was closed last time. Subtracts out of business hours. In seconds.
1344
+ * @example 2310
1345
+ */
1346
+ time_to_last_close?: number;
1347
+ /**
1348
+ * @description Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.
1349
+ * @example 2310
1350
+ */
1351
+ median_time_to_reply?: number;
1352
+ /**
1353
+ * Format: date-time
1354
+ * @description Time of first text conversation part from a contact.
1355
+ * @example 1663597233
1356
+ */
1357
+ first_contact_reply_at?: number;
1358
+ /**
1359
+ * Format: date-time
1360
+ * @description Time of first assignment after first_contact_reply_at.
1361
+ * @example 1663597233
1362
+ */
1363
+ first_assignment_at?: number;
1364
+ /**
1365
+ * Format: date-time
1366
+ * @description Time of first admin reply after first_contact_reply_at.
1367
+ * @example 1663597233
1368
+ */
1369
+ first_admin_reply_at?: number;
1370
+ /**
1371
+ * Format: date-time
1372
+ * @description Time of first close after first_contact_reply_at.
1373
+ * @example 1663597233
1374
+ */
1375
+ first_close_at?: number;
1376
+ /**
1377
+ * Format: date-time
1378
+ * @description Time of last assignment after first_contact_reply_at.
1379
+ * @example 1663597233
1380
+ */
1381
+ last_assignment_at?: number;
1382
+ /**
1383
+ * Format: date-time
1384
+ * @description Time of first admin reply since most recent assignment.
1385
+ * @example 1663597233
1386
+ */
1387
+ last_assignment_admin_reply_at?: number;
1388
+ /**
1389
+ * Format: date-time
1390
+ * @description Time of the last conversation part from a contact.
1391
+ * @example 1663597233
1392
+ */
1393
+ last_contact_reply_at?: number;
1394
+ /**
1395
+ * Format: date-time
1396
+ * @description Time of the last conversation part from an admin.
1397
+ * @example 1663597233
1398
+ */
1399
+ last_admin_reply_at?: number;
1400
+ /**
1401
+ * Format: date-time
1402
+ * @description Time of the last conversation close.
1403
+ * @example 1663597233
1404
+ */
1405
+ last_close_at?: number;
1406
+ /**
1407
+ * @description The last admin who closed the conversation. Returns a reference to an Admin object.
1408
+ * @example c3po
1409
+ */
1410
+ last_closed_by_id?: string;
1411
+ /**
1412
+ * @description Number of reopens after first_contact_reply_at.
1413
+ * @example 1
1414
+ */
1415
+ count_reopens?: number;
1416
+ /**
1417
+ * @description Number of assignments after first_contact_reply_at.
1418
+ * @example 1
1419
+ */
1420
+ count_assignments?: number;
1421
+ /**
1422
+ * @description Total number of conversation parts.
1423
+ * @example 1
1424
+ */
1425
+ count_conversation_parts?: number;
1426
+ /** @description An array of conversation response time objects */
1427
+ assigned_team_first_response_time?: components["schemas"]["conversation_response_time"][];
1428
+ /** @description An array of conversation response time objects within office hours */
1429
+ assigned_team_first_response_time_in_office_hours?: components["schemas"]["conversation_response_time"][];
1430
+ /**
1431
+ * @description Time from conversation assignment to conversation close in seconds.
1432
+ * @example 2310
1433
+ */
1434
+ handling_time?: number;
1435
+ /**
1436
+ * @description Adjusted handling time for conversation in seconds. This is the active handling time excluding idle periods when teammates are not actively working on the conversation.
1437
+ * @example 1800
1438
+ */
1439
+ adjusted_handling_time?: number | null;
1440
+ } | null;
1441
+ /**
1442
+ * Linked Objects
1443
+ * @description An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.
1444
+ */
1445
+ linked_object_list: {
1446
+ /**
1447
+ * @description Always list.
1448
+ * @example list
1449
+ * @enum {string}
1450
+ */
1451
+ type?: "list";
1452
+ /**
1453
+ * @description The total number of linked objects.
1454
+ * @example 100
1455
+ */
1456
+ total_count?: number;
1457
+ /**
1458
+ * @description Whether or not there are more linked objects than returned.
1459
+ * @example false
1460
+ */
1461
+ has_more?: boolean;
1462
+ /** @description An array containing the linked conversations and linked tickets. */
1463
+ data?: components["schemas"]["linked_object"][];
1464
+ };
1465
+ /**
1466
+ * AI Agent
1467
+ * @description Data related to AI Agent involvement in the conversation.
1468
+ */
1469
+ ai_agent: {
1470
+ /**
1471
+ * @description The type of the source that triggered AI Agent involvement in the conversation.
1472
+ * @example workflow
1473
+ * @enum {string|null}
1474
+ */
1475
+ source_type?: "essentials_plan_setup" | "profile" | "workflow" | "workflow_preview" | "fin_preview" | null;
1476
+ /**
1477
+ * @description The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`.
1478
+ * @example My AI Workflow
1479
+ */
1480
+ source_title?: string | null;
1481
+ /**
1482
+ * @description The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`
1483
+ * @example ai_answer
1484
+ * @enum {string|null}
1485
+ */
1486
+ last_answer_type?: null | "ai_answer" | "custom_answer";
1487
+ /**
1488
+ * @description The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.
1489
+ * @example assumed_resolution
1490
+ * @enum {string|null}
1491
+ */
1492
+ resolution_state?: "assumed_resolution" | "confirmed_resolution" | "escalated" | "negative_feedback" | "procedure_handoff" | null;
1493
+ /**
1494
+ * @description The customer satisfaction rating given to AI Agent, from 1-5.
1495
+ * @example 4
1496
+ */
1497
+ rating?: number | null;
1498
+ /**
1499
+ * @description The customer satisfaction rating remark given to AI Agent.
1500
+ * @example Very helpful!
1501
+ */
1502
+ rating_remark?: string | null;
1503
+ /**
1504
+ * Format: date-time
1505
+ * @description The time when the AI agent rating was created.
1506
+ * @example 1663597260
1507
+ */
1508
+ created_at?: number | null;
1509
+ /**
1510
+ * Format: date-time
1511
+ * @description The time when the AI agent rating was last updated.
1512
+ * @example 1663597260
1513
+ */
1514
+ updated_at?: number | null;
1515
+ content_sources?: components["schemas"]["content_sources_list"];
1516
+ };
1517
+ /**
1518
+ * Sales Agent
1519
+ * @description Data related to Sales Agent involvement in the conversation.
1520
+ */
1521
+ sales_agent: {
1522
+ /**
1523
+ * @description The fixed outcome of the sales agent interaction, used for billing and tracking.
1524
+ * @example qualified
1525
+ * @enum {string|null}
1526
+ */
1527
+ outcome?: "qualified" | "disqualified" | "product_discovery" | "escalated_to_support" | "spam" | null;
1528
+ /**
1529
+ * @description The identifier of the user-defined routing outcome selected by the sales agent.
1530
+ * @example enterprise_sales
1531
+ */
1532
+ routing_outcome?: string | null;
1533
+ /**
1534
+ * @description A flat key-value map of memory fields collected by the sales agent during the conversation.
1535
+ * @example {
1536
+ * "email": "user@example.com",
1537
+ * "company.name": "Acme Inc"
1538
+ * }
1539
+ */
1540
+ collected_data?: {
1541
+ [key: string]: string;
1542
+ } | null;
1543
+ };
1544
+ /**
1545
+ * Conversation Channel
1546
+ * @description The channel through which a conversation was originally initiated and its current channel.
1547
+ */
1548
+ conversation_channel: {
1549
+ /**
1550
+ * @description The channel through which the conversation was originally initiated. Possible values include `messenger`, `zendesk_sunshine`, `zendesk_ticket`, `twitter`, `email`. Returns `null` if channel data is unavailable.
1551
+ * @example messenger
1552
+ */
1553
+ initial?: string | null;
1554
+ /**
1555
+ * @description The current channel of the conversation. May differ from `initial` if the conversation was migrated between channels. Returns `null` if channel data is unavailable.
1556
+ * @example messenger
1557
+ */
1558
+ current?: string | null;
1559
+ };
1560
+ /**
1561
+ * File
1562
+ * @description The value describing a file upload set for a custom attribute
1563
+ */
1564
+ file_attribute: {
1565
+ /** @example upload */
1566
+ type?: string;
1567
+ /**
1568
+ * @description The name of the file
1569
+ * @example Screenshot.png
1570
+ */
1571
+ name?: string;
1572
+ /**
1573
+ * @description The url of the file. This is a temporary URL and will expire after 30 minutes.
1574
+ * @example https://intercom-attachments-1.com/.../Screenshot.png
1575
+ */
1576
+ url?: string;
1577
+ /**
1578
+ * @description The type of file
1579
+ * @example image/png
1580
+ */
1581
+ content_type?: string;
1582
+ /**
1583
+ * @description The size of the file in bytes
1584
+ * @example 11308309
1585
+ */
1586
+ filesize?: number;
1587
+ /**
1588
+ * @description The width of the file in pixels, if applicable
1589
+ * @example 3024
1590
+ */
1591
+ width?: number;
1592
+ /**
1593
+ * @description The height of the file in pixels, if applicable
1594
+ * @example 1964
1595
+ */
1596
+ height?: number;
1597
+ };
1598
+ /**
1599
+ * Conversation External Reference
1600
+ * @description A reference linking a conversation to a record in an external helpdesk or CRM system, surfaced for Fin Standalone workspaces.
1601
+ */
1602
+ conversation_external_reference: {
1603
+ /**
1604
+ * @description The type of external system the reference points to. Possible values include `zendesk_ticket`, `zendesk_sunshine_conversation`, `salesforce_case`, `salesforce_in_app_message_conversation`, `freshdesk_ticket`, `freshchat_conversation`, `hubspot_conversation`, `custom_helpdesk_conversation`, `api_conversation`.
1605
+ * @example zendesk_ticket
1606
+ */
1607
+ type?: string;
1608
+ /**
1609
+ * @description The identifier of the record in the external system. Always serialized as a string, since some external IDs exceed 32-bit integer range.
1610
+ * @example 3633338
1611
+ */
1612
+ id?: string;
1613
+ };
1614
+ /**
1615
+ * Conversation Monitor Evaluation
1616
+ * @description A QA monitor evaluation of this conversation. Returned in the `monitor_evaluations` array on conversation responses when `include_monitors=true` is passed.
1617
+ */
1618
+ conversation_monitor_evaluation: {
1619
+ /**
1620
+ * @description The unique identifier of the monitor that produced this evaluation.
1621
+ * @example 12345
1622
+ */
1623
+ monitor_id?: string;
1624
+ /**
1625
+ * @description The name of the monitor at the time of evaluation. Null if the monitor has since been deleted.
1626
+ * @example Customer complaint handling
1627
+ */
1628
+ monitor_name?: string | null;
1629
+ /**
1630
+ * @description The type of the monitor. Null if the monitor has since been deleted.
1631
+ * @example prompt
1632
+ */
1633
+ monitor_type?: string | null;
1634
+ /**
1635
+ * @description The evaluation outcome reported by the monitor: `included` (the conversation matches the monitor's criteria), `excluded`, `error` or `awaiting_async_data`.
1636
+ * @example included
1637
+ */
1638
+ result?: string;
1639
+ /**
1640
+ * @description The reasoning provided by the monitor for its result. May be null if no reasoning was generated.
1641
+ * @example The customer mentioned wanting a refund without resolution.
1642
+ */
1643
+ explanation?: string | null;
1644
+ /**
1645
+ * Format: date-time
1646
+ * @description The time the monitor evaluated this conversation. Null in the rare case the underlying record's timestamp is not yet set.
1647
+ * @example 1719493065
1648
+ */
1649
+ evaluated_at?: number | null;
1650
+ };
1651
+ /**
1652
+ * Conversation Scorecard
1653
+ * @description A QA scorecard result for this conversation. Returned in the `scorecards` array on conversation responses when `include_scorecards=true` is passed.
1654
+ */
1655
+ conversation_scorecard: {
1656
+ /**
1657
+ * @description The unique identifier of the scorecard definition.
1658
+ * @example 67890
1659
+ */
1660
+ scorecard_id?: string;
1661
+ /**
1662
+ * @description The unique identifier of the specific scorecard version that produced this result.
1663
+ * @example 67891
1664
+ */
1665
+ scorecard_version_id?: string;
1666
+ /**
1667
+ * @description The name of the scorecard.
1668
+ * @example Standard QA Review
1669
+ */
1670
+ name?: string;
1671
+ /**
1672
+ * @description The type of scorecard.
1673
+ * @example human
1674
+ */
1675
+ scorecard_type?: string;
1676
+ /**
1677
+ * @description Whether the conversation passed the scorecard. Null when the scorecard has not been scored.
1678
+ * @example true
1679
+ */
1680
+ passed?: boolean | null;
1681
+ /**
1682
+ * @description The numeric score for the scorecard. Null when the scorecard has not been scored.
1683
+ * @example 0.85
1684
+ */
1685
+ score?: number | null;
1686
+ /**
1687
+ * @description The numeric score produced by AI evaluation, if applicable. Null when not AI-scored.
1688
+ * @example 0.9
1689
+ */
1690
+ ai_score?: number | null;
1691
+ /**
1692
+ * Format: date-time
1693
+ * @description The time the scorecard was last evaluated. Null in the rare case the underlying record's timestamp is not yet set.
1694
+ * @example 1719493065
1695
+ */
1696
+ evaluated_at?: number | null;
1697
+ reviewed_teammate?: components["schemas"]["conversation_scorecard_reviewed_teammate"];
1698
+ reviewer?: components["schemas"]["conversation_scorecard_reviewer"];
1699
+ /**
1700
+ * @description The status of the review of this scorecard, as shown in the QA reviews list in Intercom. `unreviewed` while the review is waiting for a reviewer's verdict; `submitted` once the review has been submitted; `passed_review`, `needs_fix`, `wont_fix` or `fix_complete` when a teammate set a specific outcome. Null when no review exists for this scorecard.
1701
+ * @example submitted
1702
+ * @enum {string|null}
1703
+ */
1704
+ review_status?: "unreviewed" | "submitted" | "passed_review" | "needs_fix" | "wont_fix" | "fix_complete" | null;
1705
+ submitted_by?: components["schemas"]["conversation_scorecard_submitted_by"];
1706
+ revised_by?: components["schemas"]["conversation_scorecard_revised_by"];
1707
+ /**
1708
+ * @description The notes teammates left on the QA review linked to this scorecard entry. Empty when the scorecard has no linked review.
1709
+ * @example [
1710
+ * {
1711
+ * "id": "9001",
1712
+ * "created_at": 1734537900,
1713
+ * "updated_at": 1734537900,
1714
+ * "author": {
1715
+ * "type": "admin",
1716
+ * "admin_id": "884120017"
1717
+ * },
1718
+ * "body": "Great empathy in the second reply."
1719
+ * }
1720
+ * ]
1721
+ */
1722
+ notes?: components["schemas"]["conversation_scorecard_note"][];
1723
+ /** @description Per-evaluator results within this scorecard. */
1724
+ evaluators?: components["schemas"]["conversation_scorecard_evaluator"][];
1725
+ };
1726
+ /**
1727
+ * Tag
1728
+ * @description A tag allows you to label your contacts, companies, and conversations and list them using that tag.
1729
+ */
1730
+ tag_basic: {
1731
+ /**
1732
+ * @description value is "tag"
1733
+ * @example tag
1734
+ */
1735
+ type?: string;
1736
+ /**
1737
+ * @description The id of the tag
1738
+ * @example 123456
1739
+ */
1740
+ id?: string;
1741
+ /**
1742
+ * @description The name of the tag
1743
+ * @example Test tag
1744
+ */
1745
+ name?: string;
1746
+ };
1747
+ /**
1748
+ * Segment
1749
+ * @description A segment is a group of your contacts defined by the rules that you set.
1750
+ */
1751
+ segment: {
1752
+ /**
1753
+ * @description The type of object.
1754
+ * @example segment
1755
+ * @enum {string}
1756
+ */
1757
+ type?: "segment";
1758
+ /**
1759
+ * @description The unique identifier representing the segment.
1760
+ * @example 56203d253cba154d39010062
1761
+ */
1762
+ id?: string;
1763
+ /**
1764
+ * @description The name of the segment.
1765
+ * @example Active
1766
+ */
1767
+ name?: string;
1768
+ /**
1769
+ * @description The time the segment was created.
1770
+ * @example 1394621988
1771
+ */
1772
+ created_at?: number;
1773
+ /**
1774
+ * @description The time the segment was updated.
1775
+ * @example 1394622004
1776
+ */
1777
+ updated_at?: number;
1778
+ /**
1779
+ * @description Type of the contact: contact (lead) or user.
1780
+ * @example contact
1781
+ * @enum {string}
1782
+ */
1783
+ person_type?: "contact" | "user";
1784
+ /**
1785
+ * @description The number of items in the user segment. It's returned when the request has `include_count` with a value. A company segment only gets a count when a contact segment has the same name, and it shows that segment's count.
1786
+ * @example 3
1787
+ */
1788
+ count?: number | null;
1789
+ };
1790
+ /**
1791
+ * Company Note
1792
+ * @description A note as it appears inside a company's `notes` list. Fetch the full note with the retrieve note endpoint.
1793
+ */
1794
+ company_note: {
1795
+ /**
1796
+ * @description String representing the object's type. Always has the value `note`.
1797
+ * @example note
1798
+ */
1799
+ type?: string;
1800
+ /**
1801
+ * @description The id of the note.
1802
+ * @example 17495962
1803
+ */
1804
+ id?: string;
1805
+ /**
1806
+ * @description The relative URL of the note.
1807
+ * @example /notes/17495962
1808
+ */
1809
+ url?: string;
1810
+ /**
1811
+ * @description The body text of the note.
1812
+ * @example <p>Text for the note.</p>
1813
+ */
1814
+ body?: string;
1815
+ };
1816
+ /**
1817
+ * Addressable List
1818
+ * @description A list used to access other resources from a parent model.
1819
+ */
1820
+ addressable_list: {
1821
+ /**
1822
+ * Format: uri
1823
+ * @description The addressable object type
1824
+ * @example note
1825
+ */
1826
+ type?: string;
1827
+ /**
1828
+ * @description The id of the addressable object
1829
+ * @example 123
1830
+ */
1831
+ id?: string;
1832
+ /**
1833
+ * Format: uri
1834
+ * @description Url to get more company resources for this contact
1835
+ * @example /contacts/5ba682d23d7cf92bef87bfd4/notes
1836
+ */
1837
+ url?: string;
1838
+ };
1839
+ /**
1840
+ * Company Data
1841
+ * @description An object containing data about the companies that a contact is associated with.
1842
+ */
1843
+ company_data: {
1844
+ /**
1845
+ * @description The unique identifier for the company which is given by Intercom.
1846
+ * @example 5ba682d23d7cf92bef87bfd4
1847
+ */
1848
+ id?: string;
1849
+ /**
1850
+ * @description The type of the object. Always company.
1851
+ * @example company
1852
+ * @enum {string}
1853
+ */
1854
+ type?: "company";
1855
+ /**
1856
+ * Format: uri
1857
+ * @description The relative URL of the company.
1858
+ * @example /companies/5ba682d23d7cf92bef87bfd4
1859
+ */
1860
+ url?: string;
1861
+ };
1862
+ /**
1863
+ * Social Profile
1864
+ * @description A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.
1865
+ */
1866
+ social_profile: {
1867
+ /**
1868
+ * @description value is "social_profile"
1869
+ * @example social_profile
1870
+ */
1871
+ type?: string;
1872
+ /**
1873
+ * @description The name of the Social media profile
1874
+ * @example Facebook
1875
+ */
1876
+ name?: string;
1877
+ /**
1878
+ * Format: uri
1879
+ * @description The name of the Social media profile
1880
+ * @example http://twitter.com/th1sland
1881
+ */
1882
+ url?: string;
1883
+ };
1884
+ /**
1885
+ * Tag
1886
+ * @description A tag allows you to label your contacts, companies, conversations, tickets, articles, internal articles, content snippets and external pages, and list them using that tag.
1887
+ */
1888
+ tag: {
1889
+ /**
1890
+ * @description value is "tag"
1891
+ * @example tag
1892
+ */
1893
+ type?: string;
1894
+ /**
1895
+ * @description The id of the tag
1896
+ * @example 123456
1897
+ */
1898
+ id?: string;
1899
+ /**
1900
+ * @description The name of the tag
1901
+ * @example Test tag
1902
+ */
1903
+ name?: string;
1904
+ /**
1905
+ * Format: timestamp
1906
+ * @description The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, ticket, article, internal article, content snippet, or external page, when listing the tags on a contact, or when it is returned as part of an external page. `null` when the tag has just been removed from an article, internal article, content snippet or external page. Removing a tag from a contact, conversation or ticket returns the original value.
1907
+ * @example 1663597223
1908
+ */
1909
+ applied_at?: number | null;
1910
+ /** @description The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, ticket, article, internal article, content snippet, or external page, when listing the tags on a contact, or when it is returned as part of an external page. `null` when the tag has just been removed from an article, internal article, content snippet or external page. Removing a tag from a contact, conversation or ticket returns the original value. When no admin is recorded, `type` is `nobody_admin` and `id` is `null`. */
1911
+ applied_by?: components["schemas"]["reference"] | null;
1912
+ };
1913
+ /**
1914
+ * Contact Reference
1915
+ * @description reference to contact object
1916
+ */
1917
+ contact_reference: {
1918
+ /**
1919
+ * @description always contact
1920
+ * @example contact
1921
+ * @enum {string}
1922
+ */
1923
+ type?: "contact";
1924
+ /**
1925
+ * @description The unique identifier for the contact which is given by Intercom.
1926
+ * @example 5ba682d23d7cf92bef87bfd4
1927
+ */
1928
+ id?: string;
1929
+ /**
1930
+ * @description The unique identifier for the contact which is provided by the Client.
1931
+ * @example 70
1932
+ */
1933
+ external_id?: string | null;
1934
+ };
1935
+ /**
1936
+ * Conversation source author
1937
+ * @description The author who started the conversation. Can be a Contact, Admin, or Bot.
1938
+ */
1939
+ conversation_source_author: {
1940
+ /**
1941
+ * @description The type of the author.
1942
+ * @example admin
1943
+ */
1944
+ type?: string;
1945
+ /**
1946
+ * @description The id of the author.
1947
+ * @example 274
1948
+ */
1949
+ id?: string | null;
1950
+ /**
1951
+ * @description The name of the author.
1952
+ * @example Jane Doe
1953
+ */
1954
+ name?: string | null;
1955
+ /**
1956
+ * Format: email
1957
+ * @description The email of the author.
1958
+ * @example jane.doe@example.com
1959
+ */
1960
+ email?: string | null;
1961
+ };
1962
+ /**
1963
+ * Part attachment
1964
+ * @description The file attached to a part
1965
+ */
1966
+ part_attachment: {
1967
+ /**
1968
+ * @description The type of attachment
1969
+ * @example upload
1970
+ */
1971
+ type?: string;
1972
+ /**
1973
+ * @description The name of the attachment
1974
+ * @example example.png
1975
+ */
1976
+ name?: string;
1977
+ /**
1978
+ * @description The URL of the attachment
1979
+ * @example https://picsum.photos/200/300
1980
+ */
1981
+ url?: string;
1982
+ /**
1983
+ * @description The content type of the attachment
1984
+ * @example image/png
1985
+ */
1986
+ content_type?: string;
1987
+ /**
1988
+ * @description The size of the attachment
1989
+ * @example 100
1990
+ */
1991
+ filesize?: number;
1992
+ /**
1993
+ * @description The width of the attachment
1994
+ * @example 100
1995
+ */
1996
+ width?: number;
1997
+ /**
1998
+ * @description The height of the attachment
1999
+ * @example 100
2000
+ */
2001
+ height?: number;
2002
+ };
2003
+ /**
2004
+ * Email Message Metadata
2005
+ * @description Contains metadata if the message was sent as an email
2006
+ */
2007
+ source_email_message_metadata: {
2008
+ /**
2009
+ * @description The unique identifier for the email message as specified in the Message-ID header
2010
+ * @example <CADKw7xrXzqSn8v3mP8K8Q8yZ6K8Q8yZ6@mail.gmail.com>
2011
+ */
2012
+ message_id?: string | null;
2013
+ /**
2014
+ * @description The subject of the email
2015
+ * @example Question about my order
2016
+ */
2017
+ subject?: string;
2018
+ /**
2019
+ * Email Address Headers
2020
+ * @description A list of an email address headers.
2021
+ */
2022
+ email_address_headers?: components["schemas"]["email_address_header"][];
2023
+ /**
2024
+ * @description The HTML content of any quoted or forwarded email history from the initial inbound message
2025
+ * @example <div><span>On Jan 28, wrote:</span><blockquote>Previous thread</blockquote></div>
2026
+ */
2027
+ history?: string;
2028
+ };
2029
+ /**
2030
+ * Reference
2031
+ * @description reference to another object
2032
+ */
2033
+ reference: {
2034
+ /** @example contact */
2035
+ type?: string;
2036
+ /** @example 1a2b3c */
2037
+ id?: string | null;
2038
+ };
2039
+ /**
2040
+ * AI Topic and Subtopic
2041
+ * @description A single AI-generated topic and subtopic classification for a conversation. Surfaced inside `custom_attributes` under the "AI Topic and Subtopic" key as an array of these objects. Requires the AI add-on; the key is omitted when the conversation has no classification.
2042
+ */
2043
+ ai_topic_subtopic: {
2044
+ /**
2045
+ * @description The name of the AI-generated topic.
2046
+ * @example Billing
2047
+ */
2048
+ topic_name?: string;
2049
+ /**
2050
+ * @description The name of the AI-generated subtopic, if any.
2051
+ * @example Payment Issues
2052
+ */
2053
+ subtopic_name?: string | null;
2054
+ /**
2055
+ * @description The id of the subtopic.
2056
+ * @example 42
2057
+ */
2058
+ id?: number | null;
2059
+ };
2060
+ /**
2061
+ * CX Score reason
2062
+ * @description A single reason behind a conversation's CX Score. Surfaced inside `custom_attributes` under the "CX Score reasons" key as an array of these objects.
2063
+ */
2064
+ cx_score_reason: {
2065
+ /**
2066
+ * @description The name of the reason.
2067
+ * @example Resolution speed
2068
+ */
2069
+ name?: string;
2070
+ /**
2071
+ * @description The value recorded for the reason.
2072
+ * @example Fast
2073
+ */
2074
+ value?: string;
2075
+ };
2076
+ datetime: string | number;
2077
+ /**
2078
+ * Custom Object Instances
2079
+ * @description The list of associated custom object instances for a given reference attribute on the parent object.
2080
+ */
2081
+ custom_object_instance_list: {
2082
+ /** @example order.list */
2083
+ type?: string;
2084
+ /** @description The list of associated custom object instances for a given reference attribute on the parent object. */
2085
+ instances?: components["schemas"]["custom_object_instance"][];
2086
+ };
2087
+ /**
2088
+ * Conversation response time
2089
+ * @description Details of first response time of assigned team in seconds.
2090
+ */
2091
+ conversation_response_time: {
2092
+ /**
2093
+ * @description Id of the assigned team.
2094
+ * @example 100
2095
+ */
2096
+ team_id?: number;
2097
+ /**
2098
+ * @description Name of the assigned Team, null if team does not exist, Unassigned if no team is assigned.
2099
+ * @example Team One
2100
+ */
2101
+ team_name?: string;
2102
+ /**
2103
+ * @description First response time of assigned team in seconds.
2104
+ * @example 2310
2105
+ */
2106
+ response_time?: number;
2107
+ };
2108
+ /**
2109
+ * Linked Object
2110
+ * @description A linked conversation or ticket.
2111
+ */
2112
+ linked_object: {
2113
+ /**
2114
+ * @description ticket or conversation
2115
+ * @example ticket
2116
+ * @enum {string}
2117
+ */
2118
+ type?: "ticket" | "conversation";
2119
+ /**
2120
+ * @description The ID of the linked object
2121
+ * @example 7583
2122
+ */
2123
+ id?: string;
2124
+ /**
2125
+ * @description Category of the Linked Ticket Object.
2126
+ * @example Customer
2127
+ * @enum {string|null}
2128
+ */
2129
+ category?: "Customer" | "Back-office" | "Tracker" | null;
2130
+ };
2131
+ /** Content Source List */
2132
+ content_sources_list: {
2133
+ /**
2134
+ * @example content_source.list
2135
+ * @enum {string}
2136
+ */
2137
+ type?: "content_source.list";
2138
+ /**
2139
+ * @description The total number of content sources used by AI Agent in the conversation.
2140
+ * @example 1
2141
+ */
2142
+ total_count?: number;
2143
+ /** @description The content sources used by AI Agent in the conversation. */
2144
+ content_sources?: components["schemas"]["content_source"][];
2145
+ };
2146
+ /**
2147
+ * Reviewed Teammate
2148
+ * @description The teammate (or AI agent) whose handling of the conversation was reviewed by this scorecard.
2149
+ */
2150
+ conversation_scorecard_reviewed_teammate: {
2151
+ /**
2152
+ * @description The kind of reviewee. `ai` if the conversation was handled by Fin or scored without a specific teammate; `admin` if a specific teammate was reviewed.
2153
+ * @example admin
2154
+ * @enum {string}
2155
+ */
2156
+ type?: "ai" | "admin";
2157
+ /**
2158
+ * @description The id of the admin who was reviewed. Present only when `type` is `admin`.
2159
+ * @example 991267715
2160
+ */
2161
+ admin_id?: string | null;
2162
+ };
2163
+ /**
2164
+ * Reviewer
2165
+ * @description Who the review of this scorecard is assigned to. `ai` when it is assigned to Fin; `admin` when it is assigned to a teammate. Null when no review exists for this scorecard or the review is unassigned.
2166
+ */
2167
+ conversation_scorecard_reviewer: {
2168
+ /**
2169
+ * @description The kind of reviewer. `ai` if the review is assigned to Fin; `admin` if it is assigned to a teammate.
2170
+ * @example admin
2171
+ * @enum {string}
2172
+ */
2173
+ type?: "ai" | "admin";
2174
+ /**
2175
+ * @description The id of the admin the review is assigned to. Present only when `type` is `admin`.
2176
+ * @example 884120017
2177
+ */
2178
+ admin_id?: string | null;
2179
+ } | null;
2180
+ /**
2181
+ * Submitted By
2182
+ * @description Who last submitted the review of this scorecard, which can differ from the `reviewer` it is assigned to. `ai` when Fin submitted it; `admin` when a teammate did. Null while the review is unreviewed or when no review exists for this scorecard.
2183
+ */
2184
+ conversation_scorecard_submitted_by: {
2185
+ /**
2186
+ * @description The kind of submitter. `ai` if Fin submitted the review; `admin` if a teammate did.
2187
+ * @example admin
2188
+ * @enum {string}
2189
+ */
2190
+ type?: "ai" | "admin";
2191
+ /**
2192
+ * @description The id of the admin who submitted the review. Present only when `type` is `admin`.
2193
+ * @example 884120017
2194
+ */
2195
+ admin_id?: string | null;
2196
+ } | null;
2197
+ /**
2198
+ * Revised By
2199
+ * @description Who last changed the review of this scorecard after it was submitted. `ai` when Fin made the change; `admin` when a teammate did. Null while the review is unreviewed, when it has not been changed since it was submitted, or when no review exists for this scorecard.
2200
+ */
2201
+ conversation_scorecard_revised_by: {
2202
+ /**
2203
+ * @description The kind of reviser. `ai` if Fin changed the review; `admin` if a teammate did.
2204
+ * @example admin
2205
+ * @enum {string}
2206
+ */
2207
+ type?: "ai" | "admin";
2208
+ /**
2209
+ * @description The id of the admin who last changed the review. Present only when `type` is `admin`.
2210
+ * @example 884120017
2211
+ */
2212
+ admin_id?: string | null;
2213
+ } | null;
2214
+ /**
2215
+ * Scorecard Note
2216
+ * @description A note a teammate left on the QA review of this scorecard.
2217
+ */
2218
+ conversation_scorecard_note: {
2219
+ /**
2220
+ * @description The id of the note.
2221
+ * @example 9001
2222
+ */
2223
+ id?: string;
2224
+ /**
2225
+ * Format: date-time
2226
+ * @description The time the note was created.
2227
+ * @example 1734537900
2228
+ */
2229
+ created_at?: number;
2230
+ /**
2231
+ * Format: date-time
2232
+ * @description The time the note was last edited. Equal to `created_at` when the note has never been edited.
2233
+ * @example 1734537900
2234
+ */
2235
+ updated_at?: number;
2236
+ author?: components["schemas"]["conversation_scorecard_note_author"];
2237
+ /**
2238
+ * @description The text of the note exactly as the teammate entered it. Plain text; it is not rendered as HTML.
2239
+ * @example Great empathy in the second reply.
2240
+ */
2241
+ body?: string;
2242
+ };
2243
+ /**
2244
+ * Conversation Scorecard Evaluator
2245
+ * @description A single evaluator within a scorecard, including its result for this conversation.
2246
+ */
2247
+ conversation_scorecard_evaluator: {
2248
+ /**
2249
+ * @description The unique identifier of the evaluator (criterion) within the scorecard.
2250
+ * @example 54321
2251
+ */
2252
+ evaluator_id?: string;
2253
+ /**
2254
+ * @description The name of the evaluator (criterion). Null if the evaluator's name could not be resolved.
2255
+ * @example Tone of voice
2256
+ */
2257
+ name?: string | null;
2258
+ /** @description The evaluator's result for this conversation. Null if the evaluator was not scored. */
2259
+ result?: components["schemas"]["conversation_scorecard_evaluator_result"] | null;
2260
+ };
2261
+ /**
2262
+ * Email Address Header
2263
+ * @description Contains data for an email address header for a conversation part that was sent as an email.
2264
+ */
2265
+ email_address_header: {
2266
+ /**
2267
+ * @description The type of email address header
2268
+ * @example from
2269
+ */
2270
+ type?: string;
2271
+ /**
2272
+ * @description The email address
2273
+ * @example jdoe@example.com
2274
+ */
2275
+ email_address?: string;
2276
+ /**
2277
+ * @description The name associated with the email address
2278
+ * @example Joe Example
2279
+ */
2280
+ name?: string | null;
2281
+ };
2282
+ /**
2283
+ * Custom Object Instance
2284
+ * @description A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.
2285
+ */
2286
+ custom_object_instance: {
2287
+ /**
2288
+ * @description The Intercom defined id representing the custom object instance.
2289
+ * @example 16032025
2290
+ */
2291
+ id?: string;
2292
+ /**
2293
+ * @description The id you have defined for the custom object instance.
2294
+ * @example 0001d1c1e65a7a19e9f59ae2
2295
+ */
2296
+ external_id?: string;
2297
+ /**
2298
+ * Format: date-time
2299
+ * @description The time when the Custom Object instance was created in the external system it originated from.
2300
+ * @example 1571672154
2301
+ */
2302
+ external_created_at?: number | null;
2303
+ /**
2304
+ * Format: date-time
2305
+ * @description The time when the Custom Object instance was last updated in the external system it originated from.
2306
+ * @example 1571672154
2307
+ */
2308
+ external_updated_at?: number | null;
2309
+ /**
2310
+ * Format: date-time
2311
+ * @description The time the attribute was created as a UTC Unix timestamp
2312
+ * @example 1671028894
2313
+ */
2314
+ created_at?: number;
2315
+ /**
2316
+ * Format: date-time
2317
+ * @description The time the attribute was last updated as a UTC Unix timestamp
2318
+ * @example 1671028894
2319
+ */
2320
+ updated_at?: number;
2321
+ /**
2322
+ * @description The identifier of the custom object type that defines the structure of the custom object instance.
2323
+ * @example Order
2324
+ */
2325
+ type?: string;
2326
+ /**
2327
+ * @description The custom attributes you have set on the custom object instance.
2328
+ *
2329
+ * Each value is returned with the type of the attribute it is set on: a string, integer, number or boolean, or `null` when the attribute is unset. A list attribute returns the label of the selected option. A reference attribute returns an object holding the referenced records, under `contacts` for a contact reference, `conversations` for a conversation reference, or `instances` for a reference to another custom object type.
2330
+ * @example {
2331
+ * "order_number": "ORDER-12345",
2332
+ * "total_amount": 99.99
2333
+ * }
2334
+ */
2335
+ custom_attributes?: {
2336
+ [key: string]: (string | null) | number | boolean | Record<string, unknown>;
2337
+ };
2338
+ } | null;
2339
+ /**
2340
+ * Content Source
2341
+ * @description The content source used by AI Agent in the conversation.
2342
+ */
2343
+ content_source: {
2344
+ /**
2345
+ * @description The type of the content source.
2346
+ * @example content_snippet
2347
+ * @enum {string}
2348
+ */
2349
+ content_type?: "file" | "article" | "external_content" | "content_snippet" | "workflow_connector_action" | "internal_article";
2350
+ /**
2351
+ * @description The internal URL linking to the content source for teammates.
2352
+ * @example /fin-ai-agent/content?content=content_snippet&id=3234924
2353
+ */
2354
+ url?: string;
2355
+ /**
2356
+ * @description The title of the content source.
2357
+ * @example My internal content snippet
2358
+ */
2359
+ title?: string;
2360
+ /**
2361
+ * @description The ISO 639 language code of the content source.
2362
+ * @example en
2363
+ */
2364
+ locale?: string;
2365
+ };
2366
+ /**
2367
+ * Note Author
2368
+ * @description Who wrote the note. Null when the teammate who wrote it has since been deleted.
2369
+ */
2370
+ conversation_scorecard_note_author: {
2371
+ /**
2372
+ * @description The kind of author. `admin` when a teammate wrote the note; `ai` when Fin did.
2373
+ * @example admin
2374
+ * @enum {string}
2375
+ */
2376
+ type?: "ai" | "admin";
2377
+ /**
2378
+ * @description The id of the admin who wrote the note. Present only when `type` is `admin`.
2379
+ * @example 884120017
2380
+ */
2381
+ admin_id?: string | null;
2382
+ } | null;
2383
+ /**
2384
+ * Conversation Scorecard Evaluator Result
2385
+ * @description The outcome of a single evaluator within a scorecard.
2386
+ */
2387
+ conversation_scorecard_evaluator_result: {
2388
+ /**
2389
+ * @description The evaluator's selected value (typically a label such as `pass`, `fail`, or a category identifier).
2390
+ * @example pass
2391
+ */
2392
+ value?: string | null;
2393
+ /**
2394
+ * @description The label of the rating option matching `value` (for example `Needs improvement`). Omitted when the label could not be resolved.
2395
+ * @example Pass
2396
+ */
2397
+ value_label?: string;
2398
+ /**
2399
+ * @description The origin of the result (for example, `ai` or `human`).
2400
+ * @example ai
2401
+ */
2402
+ source?: string | null;
2403
+ /**
2404
+ * @description A free-text explanation of the result.
2405
+ * @example The agent acknowledged the issue and resolved it within the same response.
2406
+ */
2407
+ reasoning?: string | null;
2408
+ /**
2409
+ * @description Identifiers for structured reasons assigned to the result, if any.
2410
+ * @example [
2411
+ * "101",
2412
+ * "102"
2413
+ * ]
2414
+ */
2415
+ reason_ids?: string[] | null;
2416
+ /**
2417
+ * @description The structured reasons chosen for this result. Omitted when none were chosen.
2418
+ * @example [
2419
+ * {
2420
+ * "name": "Clear and concise"
2421
+ * },
2422
+ * {
2423
+ * "name": "Empathetic tone"
2424
+ * }
2425
+ * ]
2426
+ */
2427
+ reasons?: components["schemas"]["conversation_scorecard_evaluator_reason"][];
2428
+ /**
2429
+ * @description Free-text entered by the reviewer to supplement or stand in for the structured `reason_ids` — typically captured when the reviewer selects an "Other" option or adds a custom note. Null when not provided.
2430
+ * @example Agent acknowledged the issue but missed the follow-up question about billing.
2431
+ */
2432
+ other_text?: string | null;
2433
+ };
2434
+ /**
2435
+ * Evaluator Reason
2436
+ * @description A single structured reason assigned to an evaluator's result.
2437
+ */
2438
+ conversation_scorecard_evaluator_reason: {
2439
+ /**
2440
+ * @description The name of the reason. Null if the reason's name could not be resolved.
2441
+ * @example Clear and concise
2442
+ */
2443
+ name?: string | null;
2444
+ };
2445
+ };
2446
+ responses: never;
2447
+ parameters: never;
2448
+ requestBodies: never;
2449
+ headers: never;
2450
+ pathItems: never;
2451
+ };
2452
+ export type SchemaIntercomVersion = components["schemas"]["intercom_version"];
2453
+ export type SchemaContactList = components["schemas"]["contact_list"];
2454
+ export type SchemaError = components["schemas"]["error"];
2455
+ export type SchemaConversationList = components["schemas"]["conversation_list"];
2456
+ export type SchemaCompanyScroll = components["schemas"]["company_scroll"];
2457
+ export type SchemaContact = components["schemas"]["contact"];
2458
+ export type SchemaCursorPages = components["schemas"]["cursor_pages"];
2459
+ export type SchemaConversationListItem = components["schemas"]["conversation_list_item"];
2460
+ export type SchemaCompany = components["schemas"]["company"];
2461
+ export type SchemaContactTags = components["schemas"]["contact_tags"];
2462
+ export type SchemaContactNotes = components["schemas"]["contact_notes"];
2463
+ export type SchemaContactCompanies = components["schemas"]["contact_companies"];
2464
+ export type SchemaContactLocation = components["schemas"]["contact_location"];
2465
+ export type SchemaContactSocialProfiles = components["schemas"]["contact_social_profiles"];
2466
+ export type SchemaContactSubscriptionTypes = components["schemas"]["contact_subscription_types"];
2467
+ export type SchemaMergeHistoryItem = components["schemas"]["merge_history_item"];
2468
+ export type SchemaTags = components["schemas"]["tags"];
2469
+ export type SchemaConversationRating = components["schemas"]["conversation_rating"];
2470
+ export type SchemaConversationSource = components["schemas"]["conversation_source"];
2471
+ export type SchemaConversationContacts = components["schemas"]["conversation_contacts"];
2472
+ export type SchemaConversationTeammates = components["schemas"]["conversation_teammates"];
2473
+ export type SchemaCustomAttributes = components["schemas"]["custom_attributes"];
2474
+ export type SchemaConversationFirstContactReply = components["schemas"]["conversation_first_contact_reply"];
2475
+ export type SchemaSlaApplied = components["schemas"]["sla_applied"];
2476
+ export type SchemaConversationStatistics = components["schemas"]["conversation_statistics"];
2477
+ export type SchemaLinkedObjectList = components["schemas"]["linked_object_list"];
2478
+ export type SchemaAiAgent = components["schemas"]["ai_agent"];
2479
+ export type SchemaSalesAgent = components["schemas"]["sales_agent"];
2480
+ export type SchemaConversationChannel = components["schemas"]["conversation_channel"];
2481
+ export type SchemaFileAttribute = components["schemas"]["file_attribute"];
2482
+ export type SchemaConversationExternalReference = components["schemas"]["conversation_external_reference"];
2483
+ export type SchemaConversationMonitorEvaluation = components["schemas"]["conversation_monitor_evaluation"];
2484
+ export type SchemaConversationScorecard = components["schemas"]["conversation_scorecard"];
2485
+ export type SchemaTagBasic = components["schemas"]["tag_basic"];
2486
+ export type SchemaSegment = components["schemas"]["segment"];
2487
+ export type SchemaCompanyNote = components["schemas"]["company_note"];
2488
+ export type SchemaAddressableList = components["schemas"]["addressable_list"];
2489
+ export type SchemaCompanyData = components["schemas"]["company_data"];
2490
+ export type SchemaSocialProfile = components["schemas"]["social_profile"];
2491
+ export type SchemaTag = components["schemas"]["tag"];
2492
+ export type SchemaContactReference = components["schemas"]["contact_reference"];
2493
+ export type SchemaConversationSourceAuthor = components["schemas"]["conversation_source_author"];
2494
+ export type SchemaPartAttachment = components["schemas"]["part_attachment"];
2495
+ export type SchemaSourceEmailMessageMetadata = components["schemas"]["source_email_message_metadata"];
2496
+ export type SchemaReference = components["schemas"]["reference"];
2497
+ export type SchemaAiTopicSubtopic = components["schemas"]["ai_topic_subtopic"];
2498
+ export type SchemaCxScoreReason = components["schemas"]["cx_score_reason"];
2499
+ export type SchemaDatetime = components["schemas"]["datetime"];
2500
+ export type SchemaCustomObjectInstanceList = components["schemas"]["custom_object_instance_list"];
2501
+ export type SchemaConversationResponseTime = components["schemas"]["conversation_response_time"];
2502
+ export type SchemaLinkedObject = components["schemas"]["linked_object"];
2503
+ export type SchemaContentSourcesList = components["schemas"]["content_sources_list"];
2504
+ export type SchemaConversationScorecardReviewedTeammate = components["schemas"]["conversation_scorecard_reviewed_teammate"];
2505
+ export type SchemaConversationScorecardReviewer = components["schemas"]["conversation_scorecard_reviewer"];
2506
+ export type SchemaConversationScorecardSubmittedBy = components["schemas"]["conversation_scorecard_submitted_by"];
2507
+ export type SchemaConversationScorecardRevisedBy = components["schemas"]["conversation_scorecard_revised_by"];
2508
+ export type SchemaConversationScorecardNote = components["schemas"]["conversation_scorecard_note"];
2509
+ export type SchemaConversationScorecardEvaluator = components["schemas"]["conversation_scorecard_evaluator"];
2510
+ export type SchemaEmailAddressHeader = components["schemas"]["email_address_header"];
2511
+ export type SchemaCustomObjectInstance = components["schemas"]["custom_object_instance"];
2512
+ export type SchemaContentSource = components["schemas"]["content_source"];
2513
+ export type SchemaConversationScorecardNoteAuthor = components["schemas"]["conversation_scorecard_note_author"];
2514
+ export type SchemaConversationScorecardEvaluatorResult = components["schemas"]["conversation_scorecard_evaluator_result"];
2515
+ export type SchemaConversationScorecardEvaluatorReason = components["schemas"]["conversation_scorecard_evaluator_reason"];
2516
+ export type $defs = Record<string, never>;
2517
+ export interface operations {
2518
+ ListContacts: {
2519
+ parameters: {
2520
+ query?: {
2521
+ /** @description Pass `true` to include a `merge_history` array on each contact in the response. Returned for contacts of any role, with at most the 10 most recent merges. */
2522
+ include_merge_history?: boolean;
2523
+ /** @description By default, `name` and `email` values in the response, including nested ones such as social profile names, are HTML-escaped (for example, `&` is returned as `&amp;`). Custom attributes and tags are never escaped. Pass `false` to return them unescaped. */
2524
+ escape_identity?: boolean;
2525
+ /** @description The number of results per page. Defaults to `10`, with a maximum of `150`; larger values are treated as `150`. Only the leading digits are read, so `1.5` is treated as `1`. A value that doesn't start with a positive integer, such as `0` or `abc`, returns a `400` error with code `invalid_per_page`. */
2526
+ per_page?: number;
2527
+ /** @description The cursor value from `pages.next.starting_after` in a previous response. An empty value is ignored. A value that isn't a valid cursor returns a `400` error with code `client_error`. */
2528
+ starting_after?: string;
2529
+ };
2530
+ header?: {
2531
+ "Intercom-Version"?: components["schemas"]["intercom_version"];
2532
+ };
2533
+ path?: never;
2534
+ cookie?: never;
2535
+ };
2536
+ requestBody?: never;
2537
+ responses: {
2538
+ /** @description successful */
2539
+ 200: {
2540
+ headers: {
2541
+ [name: string]: unknown;
2542
+ };
2543
+ content: {
2544
+ "application/json": components["schemas"]["contact_list"];
2545
+ };
2546
+ };
2547
+ /** @description Bad Request */
2548
+ 400: {
2549
+ headers: {
2550
+ [name: string]: unknown;
2551
+ };
2552
+ content: {
2553
+ "application/json": components["schemas"]["error"];
2554
+ };
2555
+ };
2556
+ /** @description Unauthorized */
2557
+ 401: {
2558
+ headers: {
2559
+ [name: string]: unknown;
2560
+ };
2561
+ content: {
2562
+ "application/json": components["schemas"]["error"];
2563
+ };
2564
+ };
2565
+ };
2566
+ };
2567
+ listConversations: {
2568
+ parameters: {
2569
+ query?: {
2570
+ /** @description How many results per page */
2571
+ per_page?: number;
2572
+ /** @description String used to get the next page of conversations. */
2573
+ starting_after?: string;
2574
+ /**
2575
+ * @description If set to true, the response will include a `monitor_evaluations` array on each conversation with the latest QA monitor evaluation for each monitor that has evaluated it.
2576
+ * @example true
2577
+ */
2578
+ include_monitors?: boolean;
2579
+ /**
2580
+ * @description If set to true, the response will include a `scorecards` array on each conversation with any QA scorecard results.
2581
+ * @example true
2582
+ */
2583
+ include_scorecards?: boolean;
2584
+ };
2585
+ header?: {
2586
+ "Intercom-Version"?: components["schemas"]["intercom_version"];
2587
+ };
2588
+ path?: never;
2589
+ cookie?: never;
2590
+ };
2591
+ requestBody?: never;
2592
+ responses: {
2593
+ /** @description successful */
2594
+ 200: {
2595
+ headers: {
2596
+ [name: string]: unknown;
2597
+ };
2598
+ content: {
2599
+ "application/json": components["schemas"]["conversation_list"];
2600
+ };
2601
+ };
2602
+ /** @description Invalid request */
2603
+ 400: {
2604
+ headers: {
2605
+ [name: string]: unknown;
2606
+ };
2607
+ content: {
2608
+ "application/json": components["schemas"]["error"];
2609
+ };
2610
+ };
2611
+ /** @description Unauthorized */
2612
+ 401: {
2613
+ headers: {
2614
+ [name: string]: unknown;
2615
+ };
2616
+ content: {
2617
+ "application/json": components["schemas"]["error"];
2618
+ };
2619
+ };
2620
+ /** @description API plan restricted */
2621
+ 403: {
2622
+ headers: {
2623
+ [name: string]: unknown;
2624
+ };
2625
+ content: {
2626
+ "application/json": components["schemas"]["error"];
2627
+ };
2628
+ };
2629
+ };
2630
+ };
2631
+ scrollOverAllCompanies: {
2632
+ parameters: {
2633
+ query?: {
2634
+ /**
2635
+ * @description The `scroll_param` from the previous response. Omit it to start a new scroll.
2636
+ * @example 69352cd2-ab5b-42ac-b004-a13d4e55e9b0
2637
+ */
2638
+ scroll_param?: string;
2639
+ };
2640
+ header?: {
2641
+ "Intercom-Version"?: components["schemas"]["intercom_version"];
2642
+ };
2643
+ path?: never;
2644
+ cookie?: never;
2645
+ };
2646
+ requestBody?: never;
2647
+ responses: {
2648
+ /** @description Successful */
2649
+ 200: {
2650
+ headers: {
2651
+ [name: string]: unknown;
2652
+ };
2653
+ content: {
2654
+ "application/json": components["schemas"]["company_scroll"];
2655
+ };
2656
+ };
2657
+ /** @description Bad Request */
2658
+ 400: {
2659
+ headers: {
2660
+ [name: string]: unknown;
2661
+ };
2662
+ content: {
2663
+ "application/json": components["schemas"]["error"];
2664
+ };
2665
+ };
2666
+ /** @description Unauthorized */
2667
+ 401: {
2668
+ headers: {
2669
+ [name: string]: unknown;
2670
+ };
2671
+ content: {
2672
+ "application/json": components["schemas"]["error"];
2673
+ };
2674
+ };
2675
+ /** @description Scroll Parameter Not Found */
2676
+ 404: {
2677
+ headers: {
2678
+ [name: string]: unknown;
2679
+ };
2680
+ content: {
2681
+ "application/json": components["schemas"]["error"];
2682
+ };
2683
+ };
2684
+ /** @description Service Unavailable */
2685
+ 503: {
2686
+ headers: {
2687
+ [name: string]: unknown;
2688
+ };
2689
+ content: {
2690
+ "application/json": components["schemas"]["error"];
2691
+ };
2692
+ };
2693
+ };
2694
+ };
2695
+ }
2696
+ //# sourceMappingURL=openapi.d.ts.map