Skip to content

Commit 6c377de

Browse files
committed
Update overrides
1 parent 35e72f6 commit 6c377de

File tree

2 files changed

+263
-3
lines changed

2 files changed

+263
-3
lines changed

descriptions/2.14/api.intercom.io.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3400,7 +3400,7 @@ paths:
34003400
required: true
34013401
description: The unique identifier for the contact which is given by Intercom
34023402
schema:
3403-
type: integer
3403+
type: string
34043404
tags:
34053405
- Companies
34063406
- Contacts
@@ -18687,7 +18687,7 @@ components:
1868718687
description: The data export api is used to view all message sent & viewed in
1868818688
a given timeframe.
1868918689
properties:
18690-
job_identfier:
18690+
job_identifier:
1869118691
type: string
1869218692
description: The identifier for your job.
1869318693
example: orzzsbd7hk67xyu

fern/openapi-overrides.yml

Lines changed: 261 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,11 +525,58 @@ paths:
525525
- conversations
526526
x-fern-sdk-method-name: find
527527
x-fern-request-name: FindConversationRequest
528+
# conversation_id is incorrectly typed as an integer in the spec, but is actually a string.
529+
parameters:
530+
- name: Intercom-Version
531+
in: header
532+
schema:
533+
"$ref": "#/components/schemas/intercom_version"
534+
- name: conversation_id
535+
in: path
536+
required: true
537+
description: The id of the conversation to target
538+
example: '123'
539+
schema:
540+
type: string
541+
- name: display_as
542+
in: query
543+
required: false
544+
description: Set to plaintext to retrieve conversation messages in plain text.
545+
example: plaintext
546+
schema:
547+
type: string
548+
- name: include_translations
549+
in: query
550+
required: false
551+
description: If set to true, conversation parts will be translated to the detected language of the conversation.
552+
example: true
553+
schema:
554+
type: boolean
528555
put:
529556
x-fern-sdk-group-name:
530557
- conversations
531558
x-fern-sdk-method-name: update
532559
x-fern-request-name: UpdateConversationRequest
560+
# conversation_id is incorrectly typed as an integer in the spec, but is actually a string.
561+
parameters:
562+
- name: Intercom-Version
563+
in: header
564+
schema:
565+
"$ref": "#/components/schemas/intercom_version"
566+
- name: conversation_id
567+
in: path
568+
required: true
569+
description: The id of the conversation to target
570+
example: 123
571+
schema:
572+
type: string
573+
- name: display_as
574+
in: query
575+
required: false
576+
description: Set to plaintext to retrieve conversation messages in plain text.
577+
example: plaintext
578+
schema:
579+
type: string
533580
/conversations/{conversation_id}/reply:
534581
post:
535582
requestBody:
@@ -558,6 +605,156 @@ paths:
558605
- conversations
559606
x-fern-sdk-method-name: runAssignmentRules
560607
x-fern-request-name: AutoAssignConversationRequest
608+
summary: Run Assignment Rules on a conversation
609+
parameters:
610+
- name: Intercom-Version
611+
in: header
612+
schema:
613+
"$ref": "#/components/schemas/intercom_version"
614+
- name: conversation_id
615+
in: path
616+
required: true
617+
description: The identifier for the conversation as given by Intercom.
618+
example: '123'
619+
schema:
620+
type: string
621+
tags:
622+
- Conversations
623+
operationId: autoAssignConversation
624+
description: |
625+
{% admonition type="danger" name="Deprecation of Run Assignment Rules" %}
626+
Run assignment rules is now deprecated in version 2.12 and future versions and will be permanently removed on December 31, 2026. After this date, any requests made to this endpoint will fail.
627+
{% /admonition %}
628+
You can let a conversation be automatically assigned following assignment rules.
629+
{% admonition type="warning" name="When using workflows" %}
630+
It is not possible to use this endpoint with Workflows.
631+
{% /admonition %}
632+
responses:
633+
'200':
634+
description: Assign a conversation using assignment rules
635+
content:
636+
application/json:
637+
examples:
638+
Assign a conversation using assignment rules:
639+
value:
640+
type: conversation
641+
id: '409'
642+
created_at: 1719492880
643+
updated_at: 1719492881
644+
waiting_since:
645+
snoozed_until:
646+
source:
647+
type: conversation
648+
id: '403918285'
649+
delivered_as: admin_initiated
650+
subject: ''
651+
body: "<p>this is the message body</p>"
652+
author:
653+
type: admin
654+
id: '991267623'
655+
name: Ciaran197 Lee
656+
657+
attachments: []
658+
url:
659+
redacted: false
660+
contacts:
661+
type: contact.list
662+
contacts:
663+
- type: contact
664+
id: 667d61108a68186f43bafe09
665+
external_id: '70'
666+
first_contact_reply:
667+
admin_assignee_id:
668+
team_assignee_id:
669+
open: false
670+
state: closed
671+
read: false
672+
tags:
673+
type: tag.list
674+
tags: []
675+
priority: not_priority
676+
sla_applied:
677+
statistics:
678+
conversation_rating:
679+
teammates:
680+
title:
681+
custom_attributes: {}
682+
topics: {}
683+
ticket:
684+
linked_objects:
685+
type: list
686+
data: []
687+
total_count: 0
688+
has_more: false
689+
ai_agent:
690+
ai_agent_participated: false
691+
conversation_parts:
692+
type: conversation_part.list
693+
conversation_parts:
694+
- type: conversation_part
695+
id: '107'
696+
part_type: default_assignment
697+
body:
698+
created_at: 1719492881
699+
updated_at: 1719492881
700+
notified_at: 1719492881
701+
assigned_to:
702+
type: nobody_admin
703+
id:
704+
author:
705+
id: '991267624'
706+
type: bot
707+
name: Operator
708+
709+
attachments: []
710+
external_id:
711+
redacted: false
712+
total_count: 1
713+
schema:
714+
"$ref": "#/components/schemas/conversation"
715+
'404':
716+
description: Not found
717+
content:
718+
application/json:
719+
examples:
720+
Not found:
721+
value:
722+
type: error.list
723+
request_id: 9d88a5a7-6df9-42ff-b324-2387db7be984
724+
errors:
725+
- code: not_found
726+
message: Resource Not Found
727+
schema:
728+
"$ref": "#/components/schemas/error"
729+
'401':
730+
description: Unauthorized
731+
content:
732+
application/json:
733+
examples:
734+
Unauthorized:
735+
value:
736+
type: error.list
737+
request_id: 8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92
738+
errors:
739+
- code: unauthorized
740+
message: Access Token Invalid
741+
schema:
742+
"$ref": "#/components/schemas/error"
743+
'403':
744+
description: API plan restricted
745+
content:
746+
application/json:
747+
examples:
748+
API plan restricted:
749+
value:
750+
type: error.list
751+
request_id: '037980c4-84cb-4d3a-ad64-66e4e563a275'
752+
errors:
753+
- code: api_plan_restricted
754+
message: Active subscription needed.
755+
schema:
756+
"$ref": "#/components/schemas/error"
757+
561758
/conversations/{conversation_id}/customers:
562759
post:
563760
x-fern-sdk-group-name:
@@ -1800,7 +1997,70 @@ components:
18001997
- away_mode_reassign
18011998
- has_inbox_seat
18021999
- team_ids
1803-
# The spec incorrectly labels default_locale and translated_content as required
2000+
# The spec incorrectly labels default_locale, translated_content, and job_title as required
2001+
properties:
2002+
type:
2003+
type: string
2004+
description: String representing the object's type. Always has the value
2005+
`admin`.
2006+
example: admin
2007+
id:
2008+
type: string
2009+
description: The id representing the admin.
2010+
example: '1295'
2011+
name:
2012+
type: string
2013+
description: The name of the admin.
2014+
example: Joe Example
2015+
email:
2016+
type: string
2017+
description: The email of the admin.
2018+
2019+
job_title:
2020+
type: string
2021+
description: The job title of the admin.
2022+
example: Associate
2023+
away_mode_enabled:
2024+
type: boolean
2025+
description: Identifies if this admin is currently set in away mode.
2026+
example: false
2027+
away_mode_reassign:
2028+
type: boolean
2029+
description: Identifies if this admin is set to automatically reassign new
2030+
conversations to the apps default inbox.
2031+
example: false
2032+
away_status_reason_id:
2033+
type: integer
2034+
nullable: true
2035+
description: The unique identifier of the away status reason
2036+
example: 12345
2037+
has_inbox_seat:
2038+
type: boolean
2039+
description: Identifies if this admin has a paid inbox seat to restrict/allow
2040+
features that require them.
2041+
example: true
2042+
team_ids:
2043+
type: array
2044+
description: This object represents the avatar associated with the admin.
2045+
example:
2046+
- 814865
2047+
items:
2048+
type: integer
2049+
# The spec incorrectly labels avatar as a string type, while server responses show it as an object.
2050+
avatar:
2051+
type: object
2052+
nullable: true
2053+
description: The avatar object associated with the admin
2054+
properties:
2055+
image_url:
2056+
type: string
2057+
format: uri
2058+
description: URL of the admin's avatar image
2059+
example: https://example.org/128Wash.jpg
2060+
required:
2061+
- image_url
2062+
team_priority_level:
2063+
"$ref": "#/components/schemas/team_priority_level"
18042064
article_list_item:
18052065
required:
18062066
- id

0 commit comments

Comments
 (0)