UNPKG

@stackone/ai

Version:

Tools for agents to perform actions on your SaaS

1,527 lines 72.4 kB
//#region src/openapi/generated/messaging.ts const messagingSpec = { openapi: "3.1.0", paths: { "/unified/messaging/conversations": { get: { operationId: "messaging_list_conversations", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,participants,name,private,created_at,last_message_at", type: "string" } }, { name: "filter", required: false, in: "query", description: "Filter parameters that allow greater customisation of the list response", explode: true, style: "deepObject", schema: { properties: { updated_after: { description: "Use a string with a date to only select results updated after that given date", example: "2020-01-01T00:00:00.000Z", type: "string", format: "date-time", nullable: true, additionalProperties: false } }, nullable: true, type: "object" } }, { name: "page", required: false, in: "query", description: "The page number of the results to fetch", deprecated: true, schema: { nullable: true, type: "string" } }, { name: "page_size", required: false, in: "query", description: "The number of results per page (default value is 25)", schema: { nullable: true, type: "string" } }, { name: "next", required: false, in: "query", description: "The unified cursor", schema: { nullable: true, type: "string" } }, { name: "updated_after", required: false, in: "query", description: "Use a string with a date to only select results updated after that given date", deprecated: true, schema: { format: "date-time", nullable: true, example: "2020-01-01T00:00:00.000Z", type: "string" } } ], responses: { "200": { description: "The list of conversations was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingConversationsPaginated" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "List Conversations", tags: ["Conversations"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "list_conversations", "x-speakeasy-pagination": { type: "cursor", inputs: [{ name: "next", in: "parameters", type: "cursor" }], outputs: { nextCursor: "$.next" } }, "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } }, post: { operationId: "messaging_create_conversation", parameters: [{ name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }], requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingCreateConversationRequestDto" } } } }, responses: { "201": { description: "The conversation was created successfully.", content: { "application/json": { schema: { $ref: "#/components/schemas/CreateResult" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Create Conversation", tags: ["Conversations"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "create_conversation", "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/conversations/{id}": { get: { operationId: "messaging_get_conversation", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,participants,name,private,created_at,last_message_at", type: "string" } } ], responses: { "200": { description: "The conversation with the given identifier was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingConversationResult" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Get Conversation", tags: ["Conversations"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "get_conversation", "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/messages/{id}/attachments/{subResourceId}/download": { get: { operationId: "messaging_download_messaging_attachment", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "subResourceId", required: true, in: "path", schema: { type: "string" } }, { name: "format", required: false, in: "query", description: "The format to download the file in", schema: { nullable: true, example: "base64", type: "string" } }, { name: "export_format", required: false, in: "query", description: "The export format of the file", schema: { nullable: true, example: "text/plain", type: "string" } } ], responses: { "200": { description: "The attachment file was downloaded successfully.", content: { "*/*": { schema: { type: "string", format: "binary" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Download Attachment", tags: ["Messages", "Attachments"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "download_messaging_attachment", "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/messages/{id}/attachments": { get: { operationId: "messaging_list_attachments", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,file_name,file_size,file_type", type: "string" } }, { name: "filter", required: false, in: "query", description: "Filter parameters that allow greater customisation of the list response", explode: true, style: "deepObject", schema: { properties: { updated_after: { description: "Use a string with a date to only select results updated after that given date", example: "2020-01-01T00:00:00.000Z", type: "string", format: "date-time", nullable: true, additionalProperties: false } }, nullable: true, type: "object" } }, { name: "page", required: false, in: "query", description: "The page number of the results to fetch", deprecated: true, schema: { nullable: true, type: "string" } }, { name: "page_size", required: false, in: "query", description: "The number of results per page (default value is 25)", schema: { nullable: true, type: "string" } }, { name: "next", required: false, in: "query", description: "The unified cursor", schema: { nullable: true, type: "string" } }, { name: "updated_after", required: false, in: "query", description: "Use a string with a date to only select results updated after that given date", deprecated: true, schema: { format: "date-time", nullable: true, example: "2020-01-01T00:00:00.000Z", type: "string" } } ], responses: { "200": { description: "The list of attachments was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingAttachmentsPaginated" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "List Attachments", tags: ["Messages", "Attachments"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "list_attachments", "x-speakeasy-pagination": { type: "cursor", inputs: [{ name: "next", in: "parameters", type: "cursor" }], outputs: { nextCursor: "$.next" } }, "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/messages/{id}/attachments/{subResourceId}": { get: { operationId: "messaging_get_attachment", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "subResourceId", required: true, in: "path", schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,file_name,file_size,file_type", type: "string" } } ], responses: { "200": { description: "The attachment with the given identifier was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingAttachmentResult" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Get Attachment", tags: ["Messages", "Attachments"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "get_attachment", "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/users": { get: { operationId: "messaging_list_users", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,email,username,name,first_name,last_name,bot,active", type: "string" } }, { name: "filter", required: false, in: "query", description: "Filter parameters that allow greater customisation of the list response", explode: true, style: "deepObject", schema: { properties: { updated_after: { description: "Use a string with a date to only select results updated after that given date", example: "2020-01-01T00:00:00.000Z", type: "string", format: "date-time", nullable: true, additionalProperties: false } }, nullable: true, type: "object" } }, { name: "page", required: false, in: "query", description: "The page number of the results to fetch", deprecated: true, schema: { nullable: true, type: "string" } }, { name: "page_size", required: false, in: "query", description: "The number of results per page (default value is 25)", schema: { nullable: true, type: "string" } }, { name: "next", required: false, in: "query", description: "The unified cursor", schema: { nullable: true, type: "string" } }, { name: "updated_after", required: false, in: "query", description: "Use a string with a date to only select results updated after that given date", deprecated: true, schema: { format: "date-time", nullable: true, example: "2020-01-01T00:00:00.000Z", type: "string" } } ], responses: { "200": { description: "The list of users was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingUsersPaginated" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "List Users", tags: ["Users"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "list_users", "x-speakeasy-pagination": { type: "cursor", inputs: [{ name: "next", in: "parameters", type: "cursor" }], outputs: { nextCursor: "$.next" } }, "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/users/{id}": { get: { operationId: "messaging_get_user", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,email,username,name,first_name,last_name,bot,active", type: "string" } } ], responses: { "200": { description: "The user with the given identifier was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingUserResult" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Get User", tags: ["Users"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "get_user", "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/conversations/{id}/messages": { get: { operationId: "messaging_list_conversation_messages", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at", type: "string" } }, { name: "filter", required: false, in: "query", description: "Filter parameters that allow greater customisation of the list response", explode: true, style: "deepObject", schema: { properties: { updated_after: { description: "Use a string with a date to only select results updated after that given date", example: "2020-01-01T00:00:00.000Z", type: "string", format: "date-time", nullable: true, additionalProperties: false } }, nullable: true, type: "object" } }, { name: "page", required: false, in: "query", description: "The page number of the results to fetch", deprecated: true, schema: { nullable: true, type: "string" } }, { name: "page_size", required: false, in: "query", description: "The number of results per page (default value is 25)", schema: { nullable: true, type: "string" } }, { name: "next", required: false, in: "query", description: "The unified cursor", schema: { nullable: true, type: "string" } }, { name: "updated_after", required: false, in: "query", description: "Use a string with a date to only select results updated after that given date", deprecated: true, schema: { format: "date-time", nullable: true, example: "2020-01-01T00:00:00.000Z", type: "string" } } ], responses: { "200": { description: "The list of messages in the conversation was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingMessagesPaginated" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "List Conversation Messages", tags: ["Conversations", "Messages"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "list_conversation_messages", "x-speakeasy-pagination": { type: "cursor", inputs: [{ name: "next", in: "parameters", type: "cursor" }], outputs: { nextCursor: "$.next" } }, "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/messages/{id}": { get: { operationId: "messaging_get_message", parameters: [ { name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }, { name: "id", required: true, in: "path", schema: { type: "string" } }, { name: "raw", required: false, in: "query", description: "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", schema: { nullable: true, type: "boolean" } }, { name: "proxy", required: false, in: "query", description: "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", style: "deepObject", explode: true, schema: { additionalProperties: true, nullable: true, type: "object" } }, { name: "fields", required: false, in: "query", description: "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", schema: { nullable: true, example: "id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at", type: "string" } }, { name: "filter", required: false, in: "query", explode: true, style: "deepObject", schema: { type: "object" } } ], responses: { "200": { description: "The message was retrieved.", content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingMessageResult" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Get Message", tags: ["Messages"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "get_message", "x-speakeasy-retries": { statusCodes: [429, 408], strategy: "backoff" } } }, "/unified/messaging/messages": { post: { operationId: "messaging_send_message", parameters: [{ name: "x-account-id", in: "header", description: "The account identifier", required: true, schema: { type: "string" } }], requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/MessagingMessageSendRequestDto" } } } }, responses: { "201": { description: "The message was sent successfully.", content: { "application/json": { schema: { $ref: "#/components/schemas/CreateResult" } } } }, "400": { description: "Invalid request.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadRequestResponse" } } } }, "401": { description: "Unauthorized access.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnauthorizedResponse" } } } }, "403": { description: "Forbidden.", content: { "application/json": { schema: { $ref: "#/components/schemas/ForbiddenResponse" } } } }, "404": { description: "Resource not found.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotFoundResponse" } } } }, "408": { description: "The request has timed out.", headers: { "Retry-After": { description: "A time in seconds after which the request can be retried.", schema: { type: "string" } } }, content: { "application/json": { schema: { $ref: "#/components/schemas/RequestTimedOutResponse" } } } }, "409": { description: "Conflict with current state.", content: { "application/json": { schema: { $ref: "#/components/schemas/ConflictResponse" } } } }, "412": { description: "Precondition failed: linked account belongs to a disabled integration.", content: { "application/json": { schema: { $ref: "#/components/schemas/PreconditionFailedResponse" } } } }, "422": { description: "Validation error.", content: { "application/json": { schema: { $ref: "#/components/schemas/UnprocessableEntityResponse" } } } }, "429": { description: "Too many requests.", content: { "application/json": { schema: { $ref: "#/components/schemas/TooManyRequestsResponse" } } } }, "500": { description: "Server error while executing the request.", content: { "application/json": { schema: { $ref: "#/components/schemas/InternalServerErrorResponse" } } } }, "501": { description: "This functionality is not implemented.", content: { "application/json": { schema: { $ref: "#/components/schemas/NotImplementedResponse" } } } }, "502": { description: "Bad gateway error.", content: { "application/json": { schema: { $ref: "#/components/schemas/BadGatewayResponse" } } } } }, security: [{ basic: [] }], summary: "Send Message", tags: ["Messages"], "x-speakeasy-group": "messaging", "x-speakeasy-name-override": "send_message", "x-speakeasy-retries": { s