Skip to content

Commit 2da9c1d

Browse files
authored
update Unstable with new changes (#253)
1 parent c046513 commit 2da9c1d

File tree

1 file changed

+85
-27
lines changed

1 file changed

+85
-27
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 85 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6244,7 +6244,7 @@ paths:
62446244
email_message_metadata:
62456245
app_package_code: null
62466246
total_count: 1
6247-
Admin note reply:
6247+
Admin Reply with a Note:
62486248
value:
62496249
type: conversation
62506250
id: '525'
@@ -6332,7 +6332,7 @@ paths:
63326332
email_message_metadata:
63336333
app_package_code: null
63346334
total_count: 1
6335-
Admin quick_reply reply:
6335+
Admin Reply to send Quick Reply Options:
63366336
value:
63376337
type: conversation
63386338
id: '526'
@@ -6545,7 +6545,7 @@ paths:
65456545
intercom_user_id: 6762f1571bb69f9f2193bbbb
65466546
body: Thanks again :)
65476547
admin_note_reply:
6548-
summary: Admin note reply
6548+
summary: Admin Reply with a Note
65496549
value:
65506550
message_type: note
65516551
type: admin
@@ -6555,7 +6555,7 @@ paths:
65556555
\ <ol> <li>Coffee</li> <li>Tea</li> <li>Milk</li> </ol>
65566556
\ </body> </html>"
65576557
admin_quick_reply_reply:
6558-
summary: Admin quick_reply reply
6558+
summary: Admin Reply to send Quick Reply Options
65596559
value:
65606560
message_type: quick_reply
65616561
type: admin
@@ -6565,15 +6565,17 @@ paths:
65656565
uuid: a5e1c524-5ddd-4c3e-9328-6bca5d6e3edb
65666566
- text: 'No'
65676567
uuid: f4a98af1-be56-4948-a57e-e1a83f8484c6
6568-
user_last_conversation_reply:
6569-
summary: User last conversation reply
6568+
contact_quick_reply_reply:
6569+
summary: User reply with quick reply selection
65706570
value:
6571-
message_type: comment
6571+
message_type: quick_reply
65726572
type: user
65736573
intercom_user_id: 6762f1621bb69f9f2193bbbe
6574-
body: Thanks again :)
6575-
not_found:
6576-
summary: Not found
6574+
reply_options:
6575+
- text: 'Yes'
6576+
uuid: a5e1c524-5ddd-4c3e-9328-6bca5d6e3edb
6577+
user_last_conversation_reply:
6578+
summary: User last conversation reply
65776579
value:
65786580
message_type: comment
65796581
type: user
@@ -11141,7 +11143,7 @@ paths:
1114111143
schema:
1114211144
"$ref": "#/components/schemas/error"
1114311145
'200':
11144-
description: Admin quick_reply reply
11146+
description: Admin Reply to send Quick Reply Options
1114511147
content:
1114611148
application/json:
1114711149
examples:
@@ -13124,24 +13126,10 @@ components:
1312413126
reply_options:
1312513127
title: Quick Reply Options
1312613128
type: array
13127-
description: The quick reply options to display. Must be present for quick_reply
13129+
description: The quick reply options to display to the end user. Must be present for quick_reply
1312813130
message types.
1312913131
items:
13130-
title: Quick Reply Option
13131-
type: object
13132-
properties:
13133-
text:
13134-
type: string
13135-
description: The text to display in this quick reply option.
13136-
uuid:
13137-
type: string
13138-
format: uuid
13139-
description: A unique identifier for this quick reply option. This
13140-
value will be available within the metadata of the comment conversation
13141-
part that is created when a user clicks on this reply option.
13142-
required:
13143-
- text
13144-
- uuid
13132+
"$ref": "#/components/schemas/quick_reply_option"
1314513133
attachment_urls:
1314613134
type: array
1314713135
description: A list of image URLs that will be added as attachments. You
@@ -14730,6 +14718,25 @@ components:
1473014718
type: string
1473114719
format: uri
1473214720
maxItems: 10
14721+
reply_options:
14722+
title: Contact Quick Reply
14723+
type: array
14724+
description: The quick reply selection the contact wishes to respond with.
14725+
These map to buttons displayed in the Messenger UI if sent by a bot, or the reply options sent by an Admin via the API.
14726+
items:
14727+
title: Quick Reply Option
14728+
type: object
14729+
properties:
14730+
text:
14731+
type: string
14732+
description: The text of the chosen reply option.
14733+
uuid:
14734+
type: string
14735+
format: uuid
14736+
description: The unique identifier for the quick reply option selected.
14737+
required:
14738+
- text
14739+
- uuid
1473314740
required:
1473414741
- message_type
1473514742
- type
@@ -15368,6 +15375,9 @@ components:
1536815375
email_message_metadata:
1536915376
"$ref": "#/components/schemas/email_message_metadata"
1537015377
nullable: true
15378+
metadata:
15379+
"$ref": "#/components/schemas/conversation_part_metadata"
15380+
nullable: true
1537115381
state:
1537215382
type: string
1537315383
enum:
@@ -15414,6 +15424,14 @@ components:
1541415424
format: email
1541515425
description: The email of the author
1541615426
example: operator+abcd1234@intercom.io
15427+
from_ai_agent:
15428+
type: boolean
15429+
description: If this conversation part was sent by the AI Agent
15430+
example: true
15431+
is_ai_answer:
15432+
type: boolean
15433+
description: If this conversation part body was generated by the AI Agent
15434+
example: false
1541715435
conversation_parts:
1541815436
title: Conversation Parts
1541915437
type: object
@@ -15439,6 +15457,28 @@ components:
1543915457
type: integer
1544015458
description: ''
1544115459
example: 1
15460+
conversation_part_metadata:
15461+
title: Conversation Part Metadata
15462+
description: Metadata for a conversation part
15463+
type: object
15464+
properties:
15465+
quick_reply_options:
15466+
type: array
15467+
description: The quick reply options sent by the Admin or bot, presented in this conversation part.
15468+
items:
15469+
allOf:
15470+
- "$ref": "#/components/schemas/quick_reply_option"
15471+
properties:
15472+
translations:
15473+
type: object
15474+
nullable: true
15475+
description: The translations for the quick reply option.
15476+
example: { "en": "Hello", "fr": "Bonjour" }
15477+
quick_reply_uuid:
15478+
type: string
15479+
format: uuid
15480+
description: The unique identifier for the quick reply option that was clicked by the end user.
15481+
example: '123e4567-e89b-12d3-a456-426614174000'
1544215482
conversation_rating:
1544315483
title: Conversation Rating
1544415484
type: object
@@ -17243,6 +17283,8 @@ components:
1724317283
description: A list of an email address headers.
1724417284
items:
1724517285
"$ref": "#/components/schemas/email_address_header"
17286+
metadata:
17287+
"$ref": "#/components/schemas/conversation_part_metadata"
1724617288
conversation_attribute_updated_by_workflow:
1724717289
title: Part type - conversation_attribute_updated_by_workflow
1724817290
type: object
@@ -18349,6 +18391,22 @@ components:
1834918391
description: Phone number in E.164 format, that has received the SMS to
1835018392
continue the conversation in the Messenger.
1835118393
example: "+1 1234567890"
18394+
quick_reply_option:
18395+
title: Quick Reply Option
18396+
type: object
18397+
properties:
18398+
text:
18399+
type: string
18400+
description: The text to display in this quick reply option.
18401+
uuid:
18402+
type: string
18403+
format: uuid
18404+
description: A unique identifier for this quick reply option. This
18405+
value will be available within the metadata of the comment conversation
18406+
part that is created when a user clicks on this reply option.
18407+
required:
18408+
- text
18409+
- uuid
1835218410
redact_conversation_request:
1835318411
oneOf:
1835418412
- title: Redact Conversation Part Request

0 commit comments

Comments
 (0)