diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 87033ee..5bce1e1 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -11504,77 +11504,80 @@ paths: _default_title_: example _default_description_: there is a problem "/tickets/enqueue": - post: - summary: Enqueue create ticket - parameters: - - name: Intercom-Version - in: header - schema: - "$ref": "#/components/schemas/intercom_version" - tags: - - Tickets - description: 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. - 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: + post: + summary: Enqueue create ticket + description: Enqueues ticket creation for asynchronous processing, returning if the job was enqueued successfully to be processed. We attempt to perform a best-effort validation on inputs before tasks are enqueued. If the given parameters are incorrect, we won't enqueue the job. + operationId: enqueueCreateTicket + tags: + - Tickets + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + 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: + ticket_type_id: 88 + contacts: + - id: 6762f2d81bb69f9f2193bc54 + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + responses: + '200': + description: Successful response + content: + application/json: examples: - Bad Request: + 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-a4988a8a1456 + request_id: c7bf358f-135e-48d7-8286-a4988a8a1d9b errors: - - code: parameter_invalid - message: "Missing required ticket }/attributes" + - code: unauthorized + message: Access Token Invalid schema: "$ref": "#/components/schemas/error" - requestBody: + '400': + description: Bad Request 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 + Bad Request: value: - status: success - job_id: 20 - job_url: https://api.intercom.io/jobs/status/20 + type: error.list + request_id: c7bf358f-135e-48d7-8286-a4988a8a1456 + errors: + - code: parameter_invalid + message: "Missing required ticket attributes" + schema: + "$ref": "#/components/schemas/error" "/tickets/{id}": put: summary: Update a ticket @@ -17242,31 +17245,21 @@ components: - type - errors enqueue_status: - title: Enqueue Status - type: enqueue_status - description: Status of the enqueued job. + title: Enqueue status + type: object + description: Details of the job that was enqueued. 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 + description: Indicates if the job was successfully enqueued. The status can be either 'success' or '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) + description: Id of the job that was enqueued. 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. + description: API endpoint URL to check the job status. example: https://api.intercom.io/jobs/status/20 external_page: title: External Page