diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 7002a97..1a3ec61 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -2591,8 +2591,15 @@ paths: - name: folder_id in: query required: false - description: The ID of the folder to search in. + description: The ID of the folder to search in. Results will include articles from this folder and all its descendant folders. example: 123 + schema: + type: integer + - name: phrase + in: query + required: false + description: The search phrase to filter internal articles by. + example: getting started schema: type: string tags: @@ -2612,10 +2619,12 @@ paths: data: internal_articles: - id: '55' + title: Getting Started Guide body: Body of the Article owner_id: 991266252 author_id: 991266252 locale: en + folder_id: 123 pages: type: pages page: 1 @@ -2637,6 +2646,242 @@ paths: message: Access Token Invalid schema: "$ref": "#/components/schemas/error" + "/folders": + get: + summary: List all folders + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + description: The page number + schema: + type: integer + example: 1 + - name: per_page + in: query + description: Number of results per page + schema: + type: integer + example: 50 + maximum: 150 + - name: parent_folder_id + in: query + required: false + description: Filter folders by parent folder ID. Use this to list only direct children of a specific folder. + schema: + type: integer + example: 1 + tags: + - Folders + operationId: listFolders + description: "You can fetch a list of all folders for organizing content by making a GET request to `https://api.intercom.io/folders`." + responses: + '200': + description: successful + content: + application/json: + example: + type: list + data: + - id: 6 + name: Product Documentation + description: Internal product docs + emoji: "📚" + parent_folder_id: null + content_count: 5 + created_at: 1672928359 + updated_at: 1672928610 + total_count: 1 + pages: + type: pages + page: 1 + per_page: 50 + total_pages: 1 + schema: + "$ref": "#/components/schemas/internal_article_folder_list" + '401': + description: Unauthorized + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a folder + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Folders + operationId: createFolder + description: "You can create a new folder for organizing content by making a POST request to `https://api.intercom.io/folders`." + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_internal_article_folder_request" + example: + folder: + name: Product Documentation + description: Internal product docs + emoji: "📚" + responses: + '200': + description: folder created + content: + application/json: + example: + id: 6 + name: Product Documentation + description: Internal product docs + emoji: "📚" + parent_folder_id: null + content_count: 0 + created_at: 1672928359 + updated_at: 1672928359 + schema: + "$ref": "#/components/schemas/internal_article_folder" + '422': + description: Validation error + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + "/folders/{id}": + get: + summary: Retrieve a folder + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the folder + schema: + type: integer + example: 6 + tags: + - Folders + operationId: retrieveFolder + description: "You can fetch the details of a single folder by making a GET request to `https://api.intercom.io/folders/`." + responses: + '200': + description: folder found + content: + application/json: + example: + id: 6 + name: Product Documentation + description: Internal product docs + emoji: "📚" + parent_folder_id: null + content_count: 5 + created_at: 1672928359 + updated_at: 1672928610 + schema: + "$ref": "#/components/schemas/internal_article_folder" + '404': + description: Folder not found + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a folder + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the folder + schema: + type: integer + example: 6 + tags: + - Folders + operationId: updateFolder + description: "You can update a folder by making a PUT request to `https://api.intercom.io/folders/`." + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_internal_article_folder_request" + example: + folder: + name: Updated Product Documentation + emoji: "📖" + responses: + '200': + description: folder updated + content: + application/json: + example: + id: 6 + name: Updated Product Documentation + description: Internal product docs + emoji: "📖" + parent_folder_id: null + content_count: 5 + created_at: 1672928359 + updated_at: 1672928900 + schema: + "$ref": "#/components/schemas/internal_article_folder" + '404': + description: Folder not found + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a folder + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the folder + schema: + type: integer + example: 6 + tags: + - Folders + operationId: deleteFolder + description: "You can delete a folder (if it contains no content) by making a DELETE request to `https://api.intercom.io/folders/`." + responses: + '200': + description: folder deleted + content: + application/json: + example: + id: 6 + object: folder + deleted: true + schema: + "$ref": "#/components/schemas/deleted_folder_object" + '404': + description: Folder not found + content: + application/json: + schema: + "$ref": "#/components/schemas/error" + '422': + description: Folder contains content + content: + application/json: + schema: + "$ref": "#/components/schemas/error" "/companies": post: summary: Create or Update a company @@ -16706,6 +16951,151 @@ components: description: An array of Internal Article objects items: "$ref": "#/components/schemas/internal_article_list_item" + internal_article_folder: + title: Internal Article Folder + type: object + x-tags: + - Internal Articles + description: A folder for organizing internal articles + properties: + id: + type: integer + description: The unique identifier for the folder + example: 6 + name: + type: string + description: The name of the folder + example: Product Documentation + description: + type: string + nullable: true + description: The description of the folder + example: Internal product documentation + emoji: + type: string + nullable: true + description: An emoji associated with the folder + example: "📚" + parent_folder_id: + type: integer + nullable: true + description: The ID of the parent folder, or null if this is a root folder + example: null + content_count: + type: integer + description: The number of content items in this folder + example: 5 + created_at: + type: integer + format: date-time + description: The time when the folder was created (seconds) + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the folder was last updated (seconds) + example: 1672928610 + internal_article_folder_list: + title: Internal Article Folder List + type: object + x-tags: + - Internal Articles + description: A list of folders for internal articles + properties: + type: + type: string + enum: + - list + example: list + data: + type: array + items: + "$ref": "#/components/schemas/internal_article_folder" + total_count: + type: integer + description: Total number of folders + example: 2 + pages: + "$ref": "#/components/schemas/cursor_pages" + create_internal_article_folder_request: + title: Create Internal Article Folder Request + type: object + x-tags: + - Internal Articles + description: Request payload for creating a folder + required: + - folder + properties: + folder: + type: object + required: + - name + properties: + name: + type: string + description: The name of the folder + example: Product Documentation + description: + type: string + description: The description of the folder + example: Internal product documentation + emoji: + type: string + description: An emoji for the folder + example: "📚" + parent_folder_id: + type: integer + nullable: true + description: The ID of the parent folder + example: null + deleted_folder_object: + title: Deleted Folder Object + type: object + description: Response returned when a folder is deleted + properties: + id: + type: integer + description: The unique identifier for the deleted folder + example: 6 + object: + type: string + description: The type of object - `folder`. + enum: + - folder + example: folder + deleted: + type: boolean + description: Whether the folder was successfully deleted. + example: true + update_internal_article_folder_request: + title: Update Internal Article Folder Request + type: object + x-tags: + - Internal Articles + description: Request payload for updating a folder + required: + - folder + properties: + folder: + type: object + properties: + name: + type: string + description: The name of the folder + example: Updated Product Documentation + description: + type: string + description: The description of the folder + example: Updated internal product documentation + emoji: + type: string + description: An emoji for the folder + example: "📖" + parent_folder_id: + type: integer + nullable: true + description: The ID of the parent folder + example: null article_list: title: Articles type: object @@ -16832,6 +17222,11 @@ components: "$ref": "#/components/schemas/article_translated_content" tags: "$ref": "#/components/schemas/tags" + folder_id: + type: integer + nullable: true + description: The ID of the folder this article belongs to, or null if not in a folder. + example: 6 internal_article_list_item: title: Internal Articles type: object @@ -16880,6 +17275,11 @@ components: type: string description: The default locale of the article. example: en + folder_id: + type: integer + nullable: true + description: The ID of the folder this article belongs to, or null if not in a folder. + example: 6 article_search_highlights: title: Article Search Highlights type: object @@ -19285,6 +19685,11 @@ components: example: collection translated_content: "$ref": "#/components/schemas/article_translated_content" + folder_id: + type: integer + nullable: true + description: The ID of the folder to place this article in, or null to leave it without a folder. + example: 6 required: - title - author_id @@ -19310,6 +19715,11 @@ components: type: integer description: The id of the owner of the article. example: 1295 + folder_id: + type: integer + nullable: true + description: The ID of the folder to place this article in, or null to leave it without a folder. + example: 6 required: - title - owner_id @@ -24341,6 +24751,11 @@ components: example: collection translated_content: "$ref": "#/components/schemas/article_translated_content" + folder_id: + type: integer + nullable: true + description: The ID of the folder to place this article in, or null to remove it from its folder. + example: 6 update_internal_article_request: description: You can Update an Internal Article type: object @@ -24360,8 +24775,13 @@ components: example: 1295 owner_id: type: integer - description: The id of the author of the article. + description: The id of the owner of the article. example: 1295 + folder_id: + type: integer + nullable: true + description: The ID of the folder to place this article in, or null to remove it from its folder. + example: 6 update_collection_request: description: You can update a collection type: object