diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 4a41474..77de4d3 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -56,7 +56,7 @@ paths: has_inbox_seat: true schema: "$ref": "#/components/schemas/admin_with_app" - "/admins/{id}/away": + "/admins/{admin_id}/away": put: summary: Set an admin to away parameters: @@ -64,7 +64,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: admin_id in: path required: true description: The unique identifier of a given admin @@ -318,7 +318,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/admins/{id}": + "/admins/{admin_id}": get: summary: Retrieve an admin parameters: @@ -326,7 +326,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: admin_id in: path required: true description: The unique identifier of a given admin @@ -1136,7 +1136,7 @@ paths: description: Description of the Article body: Body of the Article state: published - "/articles/{id}": + "/articles/{article_id}": get: summary: Retrieve an article parameters: @@ -1144,7 +1144,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: article_id in: path required: true description: The unique identifier for the article which is given by Intercom. @@ -1917,7 +1917,7 @@ paths: summary: Bad Request value: description: Missing required parameter - "/help_center/collections/{id}": + "/help_center/collections/{collection_id}": get: summary: Retrieve a collection parameters: @@ -1925,7 +1925,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: collection_id in: path required: true description: The unique identifier for the collection which is given by Intercom. @@ -2128,7 +2128,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/help_center/help_centers/{id}": + "/help_center/help_centers/{help_center_id}": get: summary: Retrieve a Help Center parameters: @@ -2136,7 +2136,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: help_center_id in: path required: true description: The unique identifier for the collection which is given by Intercom. @@ -2841,7 +2841,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/companies/{id}": + "/companies/{company_id}": get: summary: Retrieve a company by ID parameters: @@ -2849,7 +2849,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: company_id in: path required: true description: The unique identifier for the company which is given by Intercom @@ -3056,7 +3056,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/companies/{id}/contacts": + "/companies/{company_id}/contacts": get: summary: List attached contacts parameters: @@ -3064,7 +3064,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: company_id in: path required: true description: The unique identifier for the company which is given by Intercom @@ -3122,7 +3122,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/companies/{id}/segments": + "/companies/{company_id}/segments": get: summary: List attached segments for companies parameters: @@ -3130,7 +3130,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: company_id in: path required: true description: The unique identifier for the company which is given by Intercom @@ -3357,7 +3357,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/contacts/{id}/companies": + "/contacts/{contact_id}/companies": post: summary: Attach a Contact to a Company parameters: @@ -3365,7 +3365,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path required: true description: The unique identifier for the contact which is given by Intercom @@ -3558,7 +3558,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/contacts/{contact_id}/companies/{id}": + "/contacts/{contact_id}/companies/{company_id}": delete: summary: Detach a contact from a company parameters: @@ -3573,7 +3573,7 @@ paths: example: 58a430d35458202d41b1e65b schema: type: string - - name: id + - name: company_id in: path required: true description: The unique identifier for the company which is given by Intercom @@ -3649,11 +3649,11 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/contacts/{id}/notes": + "/contacts/{contact_id}/notes": get: summary: List all notes parameters: - - name: id + - name: contact_id in: path required: true description: The unique identifier of a contact. @@ -4126,7 +4126,7 @@ paths: value: id: invalid_id consent_type: opt_in - "/contacts/{contact_id}/subscriptions/{id}": + "/contacts/{contact_id}/subscriptions/{subscription_id}": delete: summary: Remove subscription from a contact tags: @@ -4144,7 +4144,7 @@ paths: required: true schema: type: string - - name: id + - name: subscription_id in: path description: The unique identifier for the subscription type which is given by Intercom @@ -4373,7 +4373,7 @@ paths: summary: Tag not found value: id: '123' - "/contacts/{contact_id}/tags/{id}": + "/contacts/{contact_id}/tags/{tag_id}": delete: summary: Remove tag from a contact tags: @@ -4391,7 +4391,7 @@ paths: required: true schema: type: string - - name: id + - name: tag_id in: path description: The unique identifier for the tag which is given by Intercom example: '7522907' @@ -4449,7 +4449,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/contacts/{id}": + "/contacts/{contact_id}": put: summary: Update a contact parameters: @@ -4457,7 +4457,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: contact_id in: path description: id example: 63a07ddf05a32042dffac965 @@ -5510,7 +5510,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/contacts/{id}/archive": + "/contacts/{contact_id}/archive": post: summary: Archive contact parameters: @@ -5536,7 +5536,7 @@ paths: application/json: schema: "$ref": "#/components/schemas/contact_archived" - "/contacts/{id}/unarchive": + "/contacts/{contact_id}/unarchive": post: summary: Unarchive contact parameters: @@ -5680,7 +5680,7 @@ paths: value: id: 87 admin_id: 991267620 - "/conversations/{conversation_id}/tags/{id}": + "/conversations/{conversation_id}/tags/{tag_id}": delete: summary: Remove tag from a conversation parameters: @@ -5695,9 +5695,9 @@ paths: required: true schema: type: string - - name: id + - name: tag_id in: path - description: id + description: tag_id example: '7522907' required: true schema: @@ -6011,7 +6011,7 @@ paths: type: user id: 123_doesnt_exist body: Hello there - "/conversations/{id}": + "/conversations/{conversation_id}": get: summary: Retrieve a conversation parameters: @@ -6019,7 +6019,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path required: true description: The id of the conversation to target @@ -6805,7 +6805,7 @@ paths: value: '1306054154' pagination: per_page: 5 - "/conversations/{id}/reply": + "/conversations/{conversation_id}/reply": post: summary: Reply to a conversation parameters: @@ -6813,7 +6813,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path required: true description: The Intercom provisioned identifier for the conversation or the @@ -7248,7 +7248,7 @@ paths: type: user intercom_user_id: 6762f1661bb69f9f2193bbbf body: Thanks again :) - "/conversations/{id}/parts": + "/conversations/{conversation_id}/parts": post: summary: Manage a conversation parameters: @@ -7256,7 +7256,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path required: true description: The identifier for the conversation as given by Intercom. @@ -7670,7 +7670,7 @@ paths: type: admin admin_id: 991267717 body: Goodbye :) - "/conversations/{id}/customers": + "/conversations/{conversation_id}/customers": post: summary: Attach a contact to a conversation parameters: @@ -7678,7 +7678,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path required: true description: The identifier for the conversation as given by Intercom. @@ -8057,7 +8057,7 @@ paths: type: conversation_part conversation_id: really_123_doesnt_exist conversation_part_id: really_123_doesnt_exist - "/conversations/{id}/convert": + "/conversations/{conversation_id}/convert": post: summary: Convert a conversation to a ticket parameters: @@ -8065,7 +8065,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: conversation_id in: path required: true description: The id of the conversation to target @@ -9015,7 +9015,7 @@ paths: options: - value: 1-10 archived: false - "/data_attributes/{id}": + "/data_attributes/{data_attribute_id}": put: summary: Update a data attribute parameters: @@ -9023,7 +9023,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: data_attribute_id in: path required: true description: The data attribute id @@ -9934,7 +9934,7 @@ paths: newsfeed_assignments: - newsfeed_id: 53 published_at: 1664638214 - "/news/news_items/{id}": + "/news/news_items/{news_item_id}": get: summary: Retrieve a news item parameters: @@ -9942,7 +9942,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: news_item_id in: path required: true description: The unique identifier for the news item which is given by Intercom. @@ -10165,7 +10165,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/news/newsfeeds/{id}/items": + "/news/newsfeeds/{newsfeed_id}/items": get: summary: List all live newsfeed items parameters: @@ -10173,7 +10173,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: newsfeed_id in: path required: true description: The unique identifier for the news feed item which is given by @@ -10272,7 +10272,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/news/newsfeeds/{id}": + "/news/newsfeeds/{newsfeed_id}": get: summary: Retrieve a newsfeed parameters: @@ -10280,7 +10280,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: newsfeed_id in: path required: true description: The unique identifier for the news feed item which is given by @@ -10321,7 +10321,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/notes/{id}": + "/notes/{note_id}": get: summary: Retrieve a note parameters: @@ -10329,7 +10329,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: note_id in: path required: true description: The unique identifier of a given note @@ -10449,7 +10449,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/segments/{id}": + "/segments/{segment_id}": get: summary: Retrieve a segment parameters: @@ -10457,7 +10457,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: segment_id in: path required: true description: The unique identified of a given segment. @@ -11167,7 +11167,7 @@ paths: name: test users: - id: '123' - "/tags/{id}": + "/tags/{tag_id}": get: summary: Find a specific tag parameters: @@ -11175,7 +11175,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: tag_id in: path description: The unique identifier of a given tag example: '123' @@ -11332,7 +11332,7 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - "/teams/{id}": + "/teams/{team_id}": get: summary: Retrieve a team parameters: @@ -11340,7 +11340,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: team_id in: path required: true description: The unique identifier of a given team. @@ -11679,7 +11679,7 @@ paths: description: Attribute Description data_type: string required_to_create: false - "/ticket_types/{ticket_type_id}/attributes/{id}": + "/ticket_types/{ticket_type_id}/attributes/{attribute_id}": put: summary: Update an existing attribute for a ticket type parameters: @@ -11693,7 +11693,7 @@ paths: description: The unique identifier for the ticket type which is given by Intercom. schema: type: string - - name: id + - name: attribute_id in: path required: true description: The unique identifier for the ticket type attribute which is @@ -12006,7 +12006,7 @@ paths: description: Customer Report Template icon: "\U0001F39F️" category: Customer - "/ticket_types/{id}": + "/ticket_types/{ticket_type_id}": get: summary: Retrieve a ticket type parameters: @@ -12014,7 +12014,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: ticket_type_id in: path required: true description: The unique identifier for the ticket type which is given by Intercom. @@ -12280,7 +12280,7 @@ paths: summary: Ticket type updated value: name: Bug Report 2 - "/tickets/{id}/reply": + "/tickets/{ticket_id}/reply": post: summary: Reply to a ticket operationId: replyTicket @@ -12291,7 +12291,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: ticket_id in: path required: true schema: @@ -12534,7 +12534,7 @@ paths: value: id: 122 admin_id: 991267963 - "/tickets/{ticket_id}/tags/{id}": + "/tickets/{ticket_id}/tags/{tag_id}": delete: summary: Remove tag from a ticket parameters: @@ -12549,7 +12549,7 @@ paths: required: true schema: type: string - - name: id + - name: tag_id in: path description: The unique identifier for the tag which is given by Intercom example: '7522907' @@ -12868,7 +12868,7 @@ paths: message: "Missing required ticket attributes" schema: "$ref": "#/components/schemas/error" - "/tickets/{id}": + "/tickets/{ticket_id}": put: summary: Update a ticket parameters: @@ -12876,7 +12876,7 @@ paths: in: header schema: "$ref": "#/components/schemas/intercom_version" - - name: id + - name: ticket_id in: path required: true description: The unique identifier for the ticket which is given by Intercom