Skip to content

add package_package_code to conversation_part and ticket_part #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mailsongabriel merged 2 commits into from
Mar 13, 2025
Merged

add package_package_code to conversation_part and ticket_part #225

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4085fbb
add package_package_code to conversation_part and ticket_part
dan0505 Mar 13, 2025
224af68
fix typo and get conversations schema
dan0505 Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 36 additions & 6 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3754,10 +3754,10 @@ paths:
operationId: UpdateContact
description: |
You can update an existing contact (ie. user or lead).

{% admonition type="info" %}
This endpoint handles both **contact updates** and **custom object associations**.

See _`update a contact with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
{% /admonition %}
responses:
Expand Down Expand Up @@ -5174,7 +5174,7 @@ paths:
ai_agent:
ai_agent_participated: false
schema:
"$ref": "#/components/schemas/paginated_response"
"$ref": "#/components/schemas/conversation_list"
'401':
description: Unauthorized
content:
Expand Down Expand Up @@ -5432,6 +5432,7 @@ paths:
id: '123456'
name: Test tag
event_details:
app_package_code: null
- type: conversation_part
id: 2
part_type: custom_action_started
Expand All @@ -5454,6 +5455,7 @@ paths:
event_details:
action:
name: Jira Create Issue
app_package_code: test-integration
- type: conversation_part
id: 3
part_type: conversation_attribute_updated_by_admin
Expand All @@ -5478,6 +5480,7 @@ paths:
name: jira_issue_key
value:
name: PROJ-007
app_package_code: null
- type: conversation_part
id: 4
part_type: custom_action_finished
Expand All @@ -5501,6 +5504,7 @@ paths:
action:
name: Jira Create Issue
result: success
app_package_code: null
total_count: 4
schema:
"$ref": "#/components/schemas/conversation"
Expand Down Expand Up @@ -5581,7 +5585,7 @@ paths:

{% admonition type="info" %}
This endpoint handles both **conversation updates** and **custom object associations**.

See _`update a conversation with an association to a custom object instance`_ in the request/response examples to see the custom object association format.
{% /admonition %}

Expand Down Expand Up @@ -5668,6 +5672,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
- type: conversation_part
id: '130'
part_type: conversation_attribute_updated_by_admin
Expand All @@ -5686,6 +5691,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 2
update a conversation with an association to a custom object instance:
value:
Expand Down Expand Up @@ -6187,6 +6193,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
Admin note reply:
value:
Expand Down Expand Up @@ -6274,6 +6281,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
Admin quick_reply reply:
value:
Expand Down Expand Up @@ -6349,6 +6357,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
User last conversation reply:
value:
Expand Down Expand Up @@ -6427,6 +6436,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
schema:
"$ref": "#/components/schemas/conversation"
Expand Down Expand Up @@ -6624,6 +6634,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
Snooze a conversation:
value:
Expand Down Expand Up @@ -6699,6 +6710,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
Open a conversation:
value:
Expand Down Expand Up @@ -6774,6 +6786,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
Assign a conversation:
value:
Expand Down Expand Up @@ -6851,6 +6864,7 @@ paths:
redacted: false
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
schema:
"$ref": "#/components/schemas/conversation"
Expand Down Expand Up @@ -7275,6 +7289,7 @@ paths:
redacted: true
metadata: {}
email_message_metadata:
app_package_code: null
total_count: 1
schema:
"$ref": "#/components/schemas/conversation"
Expand Down Expand Up @@ -7402,6 +7417,7 @@ paths:
email: joe@bloggs.com
attachments: []
redacted: false
app_package_code: test-integration
- type: ticket_part
id: '152'
part_type: ticket_state_updated_by_admin
Expand All @@ -7416,6 +7432,7 @@ paths:
email: operator+this_is_an_id442_that_should_be_at_least_@intercom.io
attachments: []
redacted: false
app_package_code: test-integration
total_count: 2
open: true
linked_objects:
Expand Down Expand Up @@ -11044,6 +11061,7 @@ paths:
email: admin419@email.com
attachments: []
redacted: false
app_package_code: test-integration
Admin quick_reply reply:
value:
type: ticket_part
Expand Down Expand Up @@ -11637,6 +11655,7 @@ paths:
email: operator+this_is_an_id692_that_should_be_at_least_@intercom.io
attachments: []
redacted: false
app_package_code: test-integration
- type: ticket_part
id: '180'
part_type: assignment
Expand Down Expand Up @@ -11879,6 +11898,7 @@ paths:
email: admin509@email.com
attachments: []
redacted: false
app_package_code: test-integration
total_count: 1
open: true
linked_objects:
Expand Down Expand Up @@ -15132,6 +15152,11 @@ components:
event_details:
"$ref": "#/components/schemas/event_details"
nullable: true
app_package_code:
type: string
nullable: true
example: "test-integration"
description: The app package code if this part was created via API. null if the part was not created via API.
conversation_part_author:
title: Conversation part author
type: object
Expand Down Expand Up @@ -15180,7 +15205,7 @@ components:
total_count:
type: integer
description: ''
example: 2
example: 1
conversation_rating:
title: Conversation Rating
type: object
Expand Down Expand Up @@ -18767,6 +18792,11 @@ components:
type: boolean
description: Whether or not the ticket part has been redacted.
example: false
app_package_code:
type: string
nullable: false
example: text-integration
description: The app package code if this part was created via API. Note this field won't show if the part was not created via API.
ticket_part_author:
title: Ticket part author
type: object
Expand Down Expand Up @@ -20011,7 +20041,7 @@ tags:
description: What is a conversation?
url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation
- name: Custom Object Instances
description: |
description: |
Everything about your Custom Object instances.
{% admonition type="warning" name="Permission Requirements" %}
From now on, to access this endpoint, you need additional permissions. Please head over to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub) app package authentication settings to configure the required permissions.
Expand Down