diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index cb2c00f7..c00a7a44 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -30898,7 +30898,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of internal articles. @@ -30983,7 +30983,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of articles. @@ -31348,7 +31348,7 @@ components: items: "$ref": "#/components/schemas/article_search_highlights" pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" internal_article_search_response: title: Internal Article Search Response type: object @@ -31376,7 +31376,7 @@ components: items: "$ref": "#/components/schemas/internal_article" pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" article_statistics: title: Article Statistics type: object @@ -31657,7 +31657,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of versions. @@ -32331,7 +32331,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of redirects. @@ -32408,7 +32408,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of collections. @@ -37785,7 +37785,20 @@ components: description: The current page example: 1 next: - "$ref": "#/components/schemas/starting_after_paging" + type: object + nullable: true + description: Fetch the next page by sending this `starting_after` cursor. + Omitted on the last page. + properties: + page: + type: integer + description: The number of the next page + example: 2 + starting_after: + type: string + description: The cursor to send in the next request to get the next + page of results. + example: your-cursor-from-response per_page: type: integer description: Number of results per page @@ -41262,12 +41275,15 @@ components: nullable: true description: Optional. Human readable description of the error. example: Access Token Invalid - field: - type: string + data: + type: object nullable: true - description: Optional. Used to identify a particular field or query - parameter that was in error. - example: email + additionalProperties: true + description: Optional. Extra detail about the error, for example + `required_permissions` on a 403 `action_forbidden` error. + example: + required_permissions: + - read_conversations required: - code required: @@ -42614,11 +42630,10 @@ components: required: - name intercom_version: - description: Intercom API version.
By default, it's equal to the version - set in the app package. + description: Intercom API version.
If you omit the header, the API uses the + version set in your app package, and 1.0 if none is set. type: string example: Preview - default: Preview enum: - '1.0' - '1.1' @@ -43748,8 +43763,15 @@ components: next: type: string format: uri - description: A link to the next page of results. A response that does not - contain a next link does not have further data to fetch. + description: A link to the next page of results. Omitted on the last page. + Some lists never include `next` or `prev`, so compare `page` with `total_pages` + to tell whether more pages remain. + nullable: true + prev: + type: string + format: uri + description: A link to the previous page of results. Omitted on the first + page. nullable: true per_page: type: integer @@ -46982,7 +47004,7 @@ components: type: error.list request_id: 12a938a3-314e-4939-b773-5cd45738bd21 errors: - - code: data_invalid + - code: not_found message: Integration not found schema: "$ref": "#/components/schemas/error" @@ -46996,7 +47018,7 @@ components: type: error.list request_id: 12a938a3-314e-4939-b773-5cd45738bd21 errors: - - code: data_invalid + - code: parameter_invalid message: Invalid or duplicated record reference schema: "$ref": "#/components/schemas/error" @@ -47010,8 +47032,8 @@ components: type: error.list request_id: 12a938a3-314e-4939-b773-5cd45738bd21 errors: - - code: data_invalid - message: Contact not found or could not be created + - code: parameter_invalid + message: Parameter invalid schema: "$ref": "#/components/schemas/error" servers: diff --git a/descriptions/2.17/api.intercom.io.yaml b/descriptions/2.17/api.intercom.io.yaml index b6b484a5..4c5fcf6d 100644 --- a/descriptions/2.17/api.intercom.io.yaml +++ b/descriptions/2.17/api.intercom.io.yaml @@ -26910,7 +26910,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of internal articles. @@ -26995,7 +26995,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of articles. @@ -27356,7 +27356,7 @@ components: items: "$ref": "#/components/schemas/article_search_highlights" pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" internal_article_search_response: title: Internal Article Search Response type: object @@ -27384,7 +27384,7 @@ components: items: "$ref": "#/components/schemas/internal_article" pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" article_statistics: title: Article Statistics type: object @@ -27663,7 +27663,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of versions. @@ -28333,7 +28333,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of redirects. @@ -28407,7 +28407,7 @@ components: - list example: list pages: - "$ref": "#/components/schemas/cursor_pages" + "$ref": "#/components/schemas/pages_link" total_count: type: integer description: A count of the total number of collections. @@ -33480,7 +33480,20 @@ components: description: The current page example: 1 next: - "$ref": "#/components/schemas/starting_after_paging" + type: object + nullable: true + description: Fetch the next page by sending this `starting_after` cursor. + Omitted on the last page. + properties: + page: + type: integer + description: The number of the next page + example: 2 + starting_after: + type: string + description: The cursor to send in the next request to get the next + page of results. + example: your-cursor-from-response per_page: type: integer description: Number of results per page @@ -36156,12 +36169,15 @@ components: nullable: true description: Optional. Human readable description of the error. example: Access Token Invalid - field: - type: string + data: + type: object nullable: true - description: Optional. Used to identify a particular field or query - parameter that was in error. - example: email + additionalProperties: true + description: Optional. Extra detail about the error, for example + `required_permissions` on a 403 `action_forbidden` error. + example: + required_permissions: + - read_conversations required: - code required: @@ -37396,11 +37412,10 @@ components: - "192.168.1.0/24" - "10.0.0.1" intercom_version: - description: Intercom API version.
By default, it's equal to the version - set in the app package. + description: Intercom API version.
If you omit the header, the API uses the + version set in your app package, and 1.0 if none is set. type: string example: '2.17' - default: '2.17' enum: - '1.0' - '1.1' @@ -38389,8 +38404,15 @@ components: next: type: string format: uri - description: A link to the next page of results. A response that does not - contain a next link does not have further data to fetch. + description: A link to the next page of results. Omitted on the last page. + Some lists never include `next` or `prev`, so compare `page` with `total_pages` + to tell whether more pages remain. + nullable: true + prev: + type: string + format: uri + description: A link to the previous page of results. Omitted on the first + page. nullable: true per_page: type: integer @@ -41077,7 +41099,7 @@ components: type: error.list request_id: 12a938a3-314e-4939-b773-5cd45738bd21 errors: - - code: data_invalid + - code: not_found message: Integration not found schema: "$ref": "#/components/schemas/error" @@ -41091,7 +41113,7 @@ components: type: error.list request_id: 12a938a3-314e-4939-b773-5cd45738bd21 errors: - - code: data_invalid + - code: parameter_invalid message: Invalid or duplicated record reference schema: "$ref": "#/components/schemas/error" @@ -41105,8 +41127,8 @@ components: type: error.list request_id: 12a938a3-314e-4939-b773-5cd45738bd21 errors: - - code: data_invalid - message: Contact not found or could not be created + - code: parameter_invalid + message: Parameter invalid schema: "$ref": "#/components/schemas/error" servers: