From c6abdf573e140072a92ceea9814c778e5a4de97c Mon Sep 17 00:00:00 2001 From: adisa narula Date: Fri, 14 Mar 2025 12:31:12 +0000 Subject: [PATCH 1/3] Update open api doc --- descriptions/0/api.intercom.io.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 3177c4f..bd25ce7 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -16232,11 +16232,16 @@ components: assignment: type: object properties: - assignee_id: + admin_assignee_id: type: string description: The ID of the admin to which the ticket is assigned. If not provided, the ticket will be unassigned. example: '123' + team_assignee_id: + type: string + description: The ID of the team to which the ticket is assigned. + If not provided, the ticket will be unassigned. + example: '8' required: - ticket_type_id - contacts From a8161c71ef1aac59dede1aef555198acff94a877 Mon Sep 17 00:00:00 2001 From: adisa narula Date: Tue, 25 Mar 2025 14:57:20 +0000 Subject: [PATCH 2/3] Update OpenAPI doc for POST /enqueue/tickets --- descriptions/0/api.intercom.io.yaml | 99 +++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index bd25ce7..f6a02ff 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -11503,6 +11503,78 @@ paths: ticket_attributes: _default_title_: example _default_description_: there is a problem + "/tickets/enqueue": + post: + summary: Enqueues ticket creation and returns the enqueue status. We recommend using this endpoint if you'd like to create tickets without waiting for immediate processing. + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can enqueue a job to create a new ticket. + operationId: enqueueCreateTicket + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: enqueue_status + status: success + job_id: 20 + job_url: https://api.intercom.io/jobs/status/20 + schema: + "$ref": "#/components/schemas/enqueue_status" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: c7bf358f-135e-48d7-8286-a4988a8a1456 + errors: + - code: parameter_invalid + message: "Missing required ticket }/attributes" + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + allOf: + - "$ref": "#/components/schemas/create_ticket_request" + properties: + skip_notifications: + type: boolean + description: Option to disable notifications when a Ticket is created. + example: true + examples: + successful_response: + summary: Successful response + value: + status: success + job_id: 20 + job_url: https://api.intercom.io/jobs/status/20 "/tickets/{id}": put: summary: Update a ticket @@ -17152,6 +17224,33 @@ components: required: - type - errors + enqueue_status: + title: Enqueue Status + type: enqueue_status + description: Status of the enqueued job. + properties: + type: + type: string + description: Always enqueue_status + enum: + - enqueue_status + default: enqueue_status + example: enqueue_status + status: + type: string + description: Result of the enqueue + enum: + - success + - failed + example: success + job_id: + type: string + description: Id of the job that was created. Note this is not the id of the resource being created (i.e. ticket) + example: 20 + job_url: + type: string + description: Url of the job that was created. This url should be used to fetch the status of the job. + example: https://api.intercom.io/jobs/status/20 external_page: title: External Page type: object From 85e1af9f9605b6a1bc66d173ce865842d5e57851 Mon Sep 17 00:00:00 2001 From: adisa narula Date: Tue, 25 Mar 2025 15:00:05 +0000 Subject: [PATCH 3/3] update spacing --- descriptions/0/api.intercom.io.yaml | 144 ++++++++++++++-------------- 1 file changed, 72 insertions(+), 72 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index f6a02ff..681d8ee 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -11503,78 +11503,78 @@ paths: ticket_attributes: _default_title_: example _default_description_: there is a problem - "/tickets/enqueue": - post: - summary: Enqueues ticket creation and returns the enqueue status. We recommend using this endpoint if you'd like to create tickets without waiting for immediate processing. - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - tags: - - Tickets - description: You can enqueue a job to create a new ticket. - operationId: enqueueCreateTicket - responses: - '200': - description: Successful response - content: - application/json: - examples: - Successful response: - value: - type: enqueue_status - status: success - job_id: 20 - job_url: https://api.intercom.io/jobs/status/20 - schema: - "$ref": "#/components/schemas/enqueue_status" - '401': - description: Unauthorized - content: - application/json: - examples: - Unauthorized: - value: - type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b - errors: - - code: unauthorized - message: Access Token Invalid - schema: - "$ref": "#/components/schemas/error" - '400': - description: Bad Request - content: - application/json: - examples: - Bad Request: - value: - type: error.list - request_id: c7bf358f-135e-48d7-8286-a4988a8a1456 - errors: - - code: parameter_invalid - message: "Missing required ticket }/attributes" - schema: - "$ref": "#/components/schemas/error" - requestBody: - content: - application/json: - schema: - allOf: - - "$ref": "#/components/schemas/create_ticket_request" - properties: - skip_notifications: - type: boolean - description: Option to disable notifications when a Ticket is created. - example: true - examples: - successful_response: - summary: Successful response - value: - status: success - job_id: 20 - job_url: https://api.intercom.io/jobs/status/20 + "/tickets/enqueue": + post: + summary: Enqueues ticket creation and returns the enqueue status. We recommend using this endpoint if you'd like to create tickets without waiting for immediate processing. + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can enqueue a job to create a new ticket. + operationId: enqueueCreateTicket + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: enqueue_status + status: success + job_id: 20 + job_url: https://api.intercom.io/jobs/status/20 + schema: + "$ref": "#/components/schemas/enqueue_status" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: c7bf358f-135e-48d7-8286-a4988a8a1456 + errors: + - code: parameter_invalid + message: "Missing required ticket }/attributes" + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + allOf: + - "$ref": "#/components/schemas/create_ticket_request" + properties: + skip_notifications: + type: boolean + description: Option to disable notifications when a Ticket is created. + example: true + examples: + successful_response: + summary: Successful response + value: + status: success + job_id: 20 + job_url: https://api.intercom.io/jobs/status/20 "/tickets/{id}": put: summary: Update a ticket