diff --git a/packages/generator/spec.json b/packages/generator/spec.json index c7afe3f52..4526dc25a 100644 --- a/packages/generator/spec.json +++ b/packages/generator/spec.json @@ -587,6 +587,9 @@ "patch": { "description": "Updates board classification settings for an existing team.

Required scope

organizations:teams:write

Rate limiting

Level 2

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

", "operationId": "enterprise-dataclassification-team-settings-set", + "x-settings": { + "skip-tests": true + }, "parameters": [ { "description": "id of the organization", @@ -654,6 +657,9 @@ "get": { "description": "Retrieves board classification for a board.

Required scope

boards:read

Rate limiting

Level 2

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

", "operationId": "enterprise-dataclassification-board-get", + "x-settings": { + "skip-tests": true + }, "parameters": [ { "description": "id of the organization", @@ -719,6 +725,9 @@ "post": { "description": "Updates board classification for an existing board.

Required scope

boards:write

Rate limiting

Level 2

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

", "operationId": "enterprise-dataclassification-board-set", + "x-settings": { + "skip-tests": true + }, "parameters": [ { "description": "id of the organization", @@ -1424,106 +1433,16 @@ "description": "Board created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, "summary": "Create board", @@ -1607,106 +1526,13 @@ "description": "Board search results." }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, "summary": "Get boards", @@ -1747,129 +1573,39 @@ "description": "Board copied" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Copy board", - "tags": ["boards"] - } - }, - "/v2/boards/{board_id}": { - "get": { - "description": "Retrieves information about a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-specific-board", - "parameters": [ - { - "description": "Unique identifier (ID) of the board that you want to retrieve.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Copy board", + "tags": ["boards"] + } + }, + "/v2/boards/{board_id}": { + "get": { + "description": "Retrieves information about a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-specific-board", + "parameters": [ + { + "description": "Unique identifier (ID) of the board that you want to retrieve.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/json": { "schema": { @@ -1880,106 +1616,13 @@ "description": "Board retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, "summary": "Get specific board", @@ -2024,127 +1667,37 @@ "description": "The board update operation has been accepted and will be processed asynchronously. If the operation exceeds the expected duration, a response will be returned.\nTo monitor the status of the board update, use the Get specific board API. This API allows you to verify whether the board has been successfully updated." }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Update board", - "tags": ["boards"] - }, - "delete": { - "description": "Deletes a board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-board", - "parameters": [ - { - "description": "Unique identifier (ID) of the board that you want to delete.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Update board", + "tags": ["boards"] + }, + "delete": { + "description": "Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-board", + "parameters": [ + { + "description": "Unique identifier (ID) of the board that you want to delete.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { "content": { "application/json": { "schema": { @@ -2155,106 +1708,16 @@ "description": "Board deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, "summary": "Delete board", @@ -2298,119 +1761,73 @@ "description": "App card item created" }, "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Create app card item", + "tags": ["app_cards"] + } + }, + "/v2/boards/{board_id}/app_cards/{item_id}": { + "get": { + "description": "Retrieves information for a specific app card item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-app-card-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to retrieve.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/AppCardItem" } } }, - "description": "Malformed request" + "description": "App card item retrieved" + }, + "400": { + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Create app card item", + "summary": "Get app card item", "tags": ["app_cards"] - } - }, - "/v2/boards/{board_id}/app_cards/{item_id}": { - "get": { - "description": "Retrieves information for a specific app card item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-app-card-item", + }, + "patch": { + "description": "Updates an app card item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-app-card-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "description": "Unique identifier (ID) of the board where you want to update the item.", "in": "path", "name": "board_id", "required": true, @@ -2419,7 +1836,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to retrieve.", + "description": "Unique identifier (ID) of the item that you want to update.", "in": "path", "name": "item_id", "required": true, @@ -2428,6 +1845,16 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCardUpdateRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { @@ -2437,120 +1864,30 @@ } } }, - "description": "App card item retrieved" + "description": "Card item updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Get app card item", + "summary": "Update app card item", "tags": ["app_cards"] }, - "patch": { - "description": "Updates an app card item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-app-card-item", + "delete": { + "description": "Deletes an app card item from a board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-app-card-item", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to update the item.", + "description": "Unique identifier (ID) of the board from which you want to delete an item.", "in": "path", "name": "board_id", "required": true, @@ -2559,7 +1896,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to update.", + "description": "Unique identifier (ID) of the item that you want to delete.", "in": "path", "name": "item_id", "required": true, @@ -2568,139 +1905,195 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCardUpdateRequest" - } - } - }, - "required": true - }, "responses": { - "200": { + "204": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AppCardItem" + "type": "object" } } }, - "description": "Card item updated" + "description": "App card item deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Delete app card item", + "tags": ["app_cards"] + } + }, + "/v2/boards/{board_id}/cards": { + "post": { + "description": "Adds a card item to a board

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-card-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board where you want to create the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CardCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CardItem" } } }, - "description": "Malformed request" + "description": "Card item created" + }, + "400": { + "$ref": "#/components/responses/400" }, "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Create card item", + "tags": ["cards"] + } + }, + "/v2/boards/{board_id}/cards/{item_id}": { + "get": { + "description": "Retrieves information for a specific card item on a board

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-card-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to retrieve.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/CardItem" } } }, - "description": "Not found" + "description": "Card item retrieved" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" }, "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Get card item", + "tags": ["cards"] + }, + "patch": { + "description": "Updates a card item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-card-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board where you want to update the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to update.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CardUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/CardItem" } } }, - "description": "Too many requests" + "description": "Card item updated" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Update app card item", - "tags": ["app_cards"] + "summary": "Update card item", + "tags": ["cards"] }, "delete": { - "description": "Deletes an app card item from a board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-app-card-item", + "description": "Deletes a card item from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-card-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete an item.", + "description": "Unique identifier (ID) of the board from which you want to delete the item.", "in": "path", "name": "board_id", "required": true, @@ -2727,122 +2120,29 @@ } } }, - "description": "App card item deleted" + "description": "Card item deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Delete app card item", - "tags": ["app_cards"] + "summary": "Delete card item", + "tags": ["cards"] } }, - "/v2/boards/{board_id}/cards": { + "/v2/boards/{board_id}/connectors": { "post": { - "description": "Adds a card item to a board

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-card-item", + "description": "Adds a connector to a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-connector", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to create the item.", + "description": "Unique identifier (ID) of the board for which you want to create the connector.", "in": "path", "name": "board_id", "required": true, @@ -2855,137 +2155,101 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CardCreateRequest" + "$ref": "#/components/schemas/ConnectorCreationData" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CardItem" + "$ref": "#/components/schemas/ConnectorWithLinks" } } }, - "description": "Card item created" + "description": "Connector created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Create connector", + "tags": ["connectors"] + }, + "get": { + "description": "Retrieves a list of connectors for a specific board.\n\nThis method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. For example, if you set the `limit` query parameter to `10` and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is `foo`. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to `foo`.

Required scope

boards:read

Rate limiting

Level 2
", + "operationId": "get-connectors", + "parameters": [ + { + "in": "query", + "name": "limit", + "schema": { + "type": "string", + "default": "10", + "description": "The maximum number of results to return per call. If the number of connectors in the response is greater than the limit specified, the response returns the cursor parameter with a value.", + "maximum": 50, + "minimum": 10 + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "type": "string", + "description": "A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request." + } + }, + { + "description": "Unique identifier (ID) of the board from which you want to retrieve a list of connectors.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/ConnectorsCursorPaged" } } }, - "description": "Too many requests" + "description": "Connectors retrieved" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Create card item", - "tags": ["cards"] + "summary": "Get connectors", + "tags": ["connectors"] } }, - "/v2/boards/{board_id}/cards/{item_id}": { + "/v2/boards/{board_id}/connectors/{connector_id}": { "get": { - "description": "Retrieves information for a specific card item on a board

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-card-item", + "description": "Retrieves information for a specific connector on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-connector", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific connector.", "in": "path", "name": "board_id", "required": true, @@ -2994,9 +2258,9 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to retrieve.", + "description": "Unique identifier (ID) of the connector that you want to retrieve.", "in": "path", - "name": "item_id", + "name": "connector_id", "required": true, "schema": { "type": "string" @@ -3008,124 +2272,31 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CardItem" + "$ref": "#/components/schemas/ConnectorWithLinks" } } }, - "description": "Card item retrieved" + "description": "Connector retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Get card item", - "tags": ["cards"] + "summary": "Get specific connector", + "tags": ["connectors"] }, "patch": { - "description": "Updates a card item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-card-item", + "description": "Updates a connector on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-connector", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to update the item.", + "description": "Unique identifier (ID) of the board for which you want to update the connector.", "in": "path", "name": "board_id", "required": true, @@ -3134,9 +2305,9 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to update.", + "description": "Unique identifier (ID) of the connector that you want to update.", "in": "path", - "name": "item_id", + "name": "connector_id", "required": true, "schema": { "type": "string" @@ -3147,7 +2318,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CardUpdateRequest" + "$ref": "#/components/schemas/ConnectorChangesData" } } }, @@ -3158,124 +2329,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CardItem" + "$ref": "#/components/schemas/ConnectorWithLinks" } } }, - "description": "Card item updated" + "description": "Connector updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Update card item", - "tags": ["cards"] + "summary": "Update connector", + "tags": ["connectors"] }, "delete": { - "description": "Deletes a card item from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-card-item", + "description": "Deletes the specified connector from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-connector", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", + "description": "Unique identifier (ID) of the board from which you want to delete the connector.", "in": "path", "name": "board_id", "required": true, @@ -3284,9 +2365,9 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to delete.", + "description": "Unique identifier (ID) of the connector that you want to delete.", "in": "path", - "name": "item_id", + "name": "connector_id", "required": true, "schema": { "type": "string" @@ -3302,122 +2383,29 @@ } } }, - "description": "Card item deleted" + "description": "Connector deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Delete card item", - "tags": ["cards"] + "summary": "Delete connector", + "tags": ["connectors"] } }, - "/v2/boards/{board_id}/connectors": { + "/v2/boards/{board_id}/documents": { "post": { - "description": "Adds a connector to a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-connector", + "description": "Adds a document item to a board by specifying the URL where the document is hosted.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-document-item-using-url", "parameters": [ { - "description": "Unique identifier (ID) of the board for which you want to create the connector.", + "description": "Unique identifier (ID) of the board where you want to create the item.", "in": "path", "name": "board_id", "required": true, @@ -3430,156 +2418,55 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectorCreationData" + "$ref": "#/components/schemas/DocumentCreateRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectorWithLinks" + "$ref": "#/components/schemas/DocumentItem" } } }, - "description": "Connector created" + "description": "Document item created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Create connector", - "tags": ["connectors"] - }, + "summary": "Create document item using URL", + "tags": ["documents"] + } + }, + "/v2/boards/{board_id}/documents/{item_id}": { "get": { - "description": "Retrieves a list of connectors for a specific board.\n\nThis method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. For example, if you set the `limit` query parameter to `10` and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is `foo`. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to `foo`.

Required scope

boards:read

Rate limiting

Level 2
", - "operationId": "get-connectors", + "description": "Retrieves information for a specific document item on a board

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-document-item", "parameters": [ { - "in": "query", - "name": "limit", - "schema": { - "type": "string", - "default": "10", - "description": "The maximum number of results to return per call. If the number of connectors in the response is greater than the limit specified, the response returns the cursor parameter with a value.", - "maximum": 50, - "minimum": 10 - } - }, - { - "in": "query", - "name": "cursor", + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "in": "path", + "name": "board_id", + "required": true, "schema": { - "type": "string", - "description": "A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request." + "type": "string" } }, { - "description": "Unique identifier (ID) of the board from which you want to retrieve a list of connectors.", + "description": "Unique identifier (ID) of the item that you want to retrieve.", "in": "path", - "name": "board_id", + "name": "item_id", "required": true, "schema": { "type": "string" @@ -3591,126 +2478,31 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectorsCursorPaged" + "$ref": "#/components/schemas/DocumentItem" } } }, - "description": "Connectors retrieved" + "description": "Document item retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Get connectors", - "tags": ["connectors"] - } - }, - "/v2/boards/{board_id}/connectors/{connector_id}": { - "get": { - "description": "Retrieves information for a specific connector on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-connector", + "summary": "Get document item", + "tags": ["documents"] + }, + "patch": { + "description": "Updates a document item on a board

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-document-item-using-url", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific connector.", + "description": "Unique identifier (ID) of the board where you want to update the item.", "in": "path", "name": "board_id", "required": true, @@ -3719,138 +2511,58 @@ } }, { - "description": "Unique identifier (ID) of the connector that you want to retrieve.", + "description": "Unique identifier (ID) of the item that you want to update.", "in": "path", - "name": "connector_id", + "name": "item_id", "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentUpdateRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectorWithLinks" + "$ref": "#/components/schemas/DocumentItem" } } }, - "description": "Connector retrieved" + "description": "Document item updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Get specific connector", - "tags": ["connectors"] + "summary": "Update document item using URL", + "tags": ["documents"] }, - "patch": { - "description": "Updates a connector on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-connector", + "delete": { + "description": "Deletes a document item from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-document-item", "parameters": [ { - "description": "Unique identifier (ID) of the board for which you want to update the connector.", + "description": "Unique identifier (ID) of the board from which you want to delete the item.", "in": "path", "name": "board_id", "required": true, @@ -3859,148 +2571,204 @@ } }, { - "description": "Unique identifier (ID) of the connector that you want to update.", + "description": "Unique identifier (ID) of the item that you want to delete.", "in": "path", - "name": "connector_id", + "name": "item_id", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorChangesData" - } - } - }, - "required": true - }, "responses": { - "200": { + "204": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConnectorWithLinks" + "type": "object" } } }, - "description": "Connector updated" + "description": "Document item deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Delete document item", + "tags": ["documents"] + } + }, + "/v2/boards/{board_id}/embeds": { + "post": { + "description": "Adds an embed item containing external content to a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-embed-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board where you want to create the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmbedCreateRequest" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmbedItem" } } }, - "description": "Malformed request" + "description": "Embed item created" + }, + "400": { + "$ref": "#/components/responses/400" }, "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Create embed item", + "tags": ["embeds"] + } + }, + "/v2/boards/{board_id}/embeds/{item_id}": { + "get": { + "description": "Retrieves information for a specific embed item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-embed-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to retrieve.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/EmbedItem" } } }, - "description": "Not found" + "description": "Embed item retrieved" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" }, "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Get embed item", + "tags": ["embeds"] + }, + "patch": { + "description": "Updates an embed item on a board based on the data properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-embed-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board where you want to update the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to update.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EmbedUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/EmbedItem" } } }, - "description": "Too many requests" + "description": "Embed item updated" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Update connector", - "tags": ["connectors"] + "summary": "Update embed item", + "tags": ["embeds"] }, "delete": { - "description": "Deletes the specified connector from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-connector", + "description": "Deletes an embed item from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-embed-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete the connector.", + "description": "Unique identifier (ID) of the board from which you want to delete the item.", "in": "path", "name": "board_id", "required": true, @@ -4009,9 +2777,9 @@ } }, { - "description": "Unique identifier (ID) of the connector that you want to delete.", + "description": "Unique identifier (ID) of the item that you want to delete.", "in": "path", - "name": "connector_id", + "name": "item_id", "required": true, "schema": { "type": "string" @@ -4027,119 +2795,29 @@ } } }, - "description": "Connector deleted" + "description": "Embed item deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Delete connector", - "tags": ["connectors"] + "summary": "Delete embed item", + "tags": ["embeds"] } }, - "/v2/boards/{board_id}/documents": { + "/v2/boards/{board_id}/images": { "post": { - "description": "Adds a document item to a board by specifying the URL where the document is hosted.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-document-item-using-url", + "x-settings": { + "skip-tests": true + }, + "description": "Adds an image item to a board by specifying an image URL.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-image-item-using-url", "parameters": [ { "description": "Unique identifier (ID) of the board where you want to create the item.", @@ -4155,7 +2833,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentCreateRequest" + "$ref": "#/components/schemas/ImageCreateRequest" } } }, @@ -4166,123 +2844,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentItem" + "$ref": "#/components/schemas/ImageItem" } } }, - "description": "Document item created" + "description": "Image item created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Create document item using URL", - "tags": ["documents"] + "summary": "Create image item using URL", + "tags": ["images"] } }, - "/v2/boards/{board_id}/documents/{item_id}": { + "/v2/boards/{board_id}/images/{item_id}": { "get": { - "description": "Retrieves information for a specific document item on a board

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-document-item", + "x-settings": { + "skip-tests": true + }, + "description": "Retrieves information for a specific image item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-image-item", "parameters": [ { "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", @@ -4308,121 +2896,31 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentItem" + "$ref": "#/components/schemas/ImageItem" } } }, - "description": "Document item retrieved" + "description": "Image item retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Get document item", - "tags": ["documents"] + "summary": "Get image item", + "tags": ["images"] }, "patch": { - "description": "Updates a document item on a board

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-document-item-using-url", + "x-settings": { + "skip-tests": true + }, + "description": "Updates an image item on a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-image-item-using-url", "parameters": [ { "description": "Unique identifier (ID) of the board where you want to update the item.", @@ -4447,7 +2945,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentUpdateRequest" + "$ref": "#/components/schemas/ImageUpdateRequest" } } }, @@ -4458,121 +2956,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentItem" + "$ref": "#/components/schemas/ImageItem" } } }, - "description": "Document item updated" + "description": "Image item updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Update document item using URL", - "tags": ["documents"] + "summary": "Update image item using URL", + "tags": ["images"] }, "delete": { - "description": "Deletes a document item from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-document-item", + "x-settings": { + "skip-tests": true + }, + "description": "Deletes an image item from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-image-item", "parameters": [ { "description": "Unique identifier (ID) of the board from which you want to delete the item.", @@ -4602,2047 +3013,68 @@ } } }, - "description": "Document item deleted" + "description": "Image item deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Delete document item", - "tags": ["documents"] - } - }, - "/v2/boards/{board_id}/embeds": { - "post": { - "description": "Adds an embed item containing external content to a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-embed-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board where you want to create the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmbedCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmbedItem" - } - } - }, - "description": "Embed item created" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Create embed item", - "tags": ["embeds"] - } - }, - "/v2/boards/{board_id}/embeds/{item_id}": { - "get": { - "description": "Retrieves information for a specific embed item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-embed-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to retrieve.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmbedItem" - } - } - }, - "description": "Embed item retrieved" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Get embed item", - "tags": ["embeds"] - }, - "patch": { - "description": "Updates an embed item on a board based on the data properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-embed-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board where you want to update the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to update.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmbedUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmbedItem" - } - } - }, - "description": "Embed item updated" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Update embed item", - "tags": ["embeds"] - }, - "delete": { - "description": "Deletes an embed item from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-embed-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to delete.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - }, - "description": "Embed item deleted" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Delete embed item", - "tags": ["embeds"] - } - }, - "/v2/boards/{board_id}/images": { - "post": { - "x-settings": { - "skip-tests": true - }, - "description": "Adds an image item to a board by specifying an image URL.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-image-item-using-url", - "parameters": [ - { - "description": "Unique identifier (ID) of the board where you want to create the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImageCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImageItem" - } - } - }, - "description": "Image item created" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Create image item using URL", - "tags": ["images"] - } - }, - "/v2/boards/{board_id}/images/{item_id}": { - "get": { - "x-settings": { - "skip-tests": true - }, - "description": "Retrieves information for a specific image item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-image-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to retrieve.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImageItem" - } - } - }, - "description": "Image item retrieved" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Get image item", - "tags": ["images"] - }, - "patch": { - "x-settings": { - "skip-tests": true - }, - "description": "Updates an image item on a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-image-item-using-url", - "parameters": [ - { - "description": "Unique identifier (ID) of the board where you want to update the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to update.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImageUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImageItem" - } - } - }, - "description": "Image item updated" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Update image item using URL", - "tags": ["images"] - }, - "delete": { - "x-settings": { - "skip-tests": true - }, - "description": "Deletes an image item from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-image-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to delete.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - }, - "description": "Image item deleted" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Delete image item", - "tags": ["images"] - } - }, - "/v2/boards/{board_id}/items": { - "get": { - "description": "Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values.\n\nThis method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. For example, if you set the `limit` query parameter to `10` and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is `foo`. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to `foo`.

Required scope

boards:read

Rate limiting

Level 2
", - "operationId": "get-items", - "parameters": [ - { - "in": "query", - "name": "limit", - "schema": { - "type": "string", - "default": "10", - "description": "The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value.", - "maximum": 50, - "minimum": 10 - } - }, - { - "in": "query", - "name": "type", - "schema": { - "type": "string", - "enum": [ - "text", - "shape", - "sticky_note", - "image", - "document", - "card", - "app_card", - "preview", - "frame", - "embed" - ], - "description": "If you want to get a list of items of a specific type, specify an item type. For example, if you want to retrieve the list of card items, set `type` to `cards`.\n Possible values: `app_card`, `card`, `document`, `embed`, `frame`, `image`, `shape`, `sticky_note`, `text`" - } - }, - { - "in": "query", - "name": "cursor", - "schema": { - "type": "string", - "description": "A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request." - } - }, - { - "description": "Unique identifier (ID) of the board for which you want to retrieve the list of available items.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericItemCursorPaged" - } - } - }, - "description": "Items retrieved" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Get items on board", - "tags": ["items"] - } - }, - "/v2/boards/{board_id}/items/{item_id}": { - "get": { - "description": "Retrieves information for a specific item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-specific-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to retrieve.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericItem" - } - } - }, - "description": "Item retrieved" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Get specific item on board", - "tags": ["items"] - }, - "patch": { - "description": "Updates the position or the parent of an item on a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-item-position-or-parent", - "parameters": [ - { - "description": "Unique identifier (ID) of the board where you want to update the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to update.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericItemUpdate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenericItem" - } - } - }, - "description": "Item updated" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Update item position or parent", - "tags": ["items"] - }, - "delete": { - "description": "Deletes an item from a board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-item", - "parameters": [ - { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier (ID) of the item that you want to delete.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - }, - "description": "Item deleted" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" - } - }, - "summary": "Delete item", - "tags": ["items"] - } - }, - "/v2/boards/{board_id}/members": { - "post": { - "description": "Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "share-board", - "parameters": [ - { - "description": "Unique identifier (ID) of the board to which the board member belongs.", - "in": "path", - "name": "board_id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoardMembersInvite" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InvitationResult" - } - } - }, - "description": "Board members invited" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Share board", - "tags": ["board_members"] - }, + "summary": "Delete image item", + "tags": ["images"] + } + }, + "/v2/boards/{board_id}/items": { "get": { - "description": "Retrieves a pageable list of members for a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-board-members", + "description": "Retrieves a list of items for a specific board. You can retrieve all items on the board, a list of child items inside a parent item, or a list of specific types of items by specifying URL query parameter values.\n\nThis method returns results using a cursor-based approach. A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, on your next call to the same method, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. For example, if you set the `limit` query parameter to `10` and the board contains 20 objects, the first call will return information about the first 10 objects in the response along with a cursor parameter and value. In this example, let's say the cursor parameter value returned in the response is `foo`. If you want to retrieve the next set of objects, on your next call to the same method, set the cursor parameter value to `foo`.

Required scope

boards:read

Rate limiting

Level 2
", + "operationId": "get-items", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "string", - "description": "The maximum number of board members to retrieve.\nDefault: `20`.", + "default": "10", + "description": "The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value.", "maximum": 50, - "minimum": 1 + "minimum": 10 } }, { "in": "query", - "name": "offset", + "name": "type", "schema": { "type": "string", - "description": "The (zero-based) offset of the first item in the collection to return.\nDefault: `0`." + "enum": [ + "text", + "shape", + "sticky_note", + "image", + "document", + "card", + "app_card", + "preview", + "frame", + "embed" + ], + "description": "If you want to get a list of items of a specific type, specify an item type. For example, if you want to retrieve the list of card items, set `type` to `cards`.\n Possible values: `app_card`, `card`, `document`, `embed`, `frame`, `image`, `shape`, `sticky_note`, `text`" } }, { - "description": "Unique identifier (ID) of the board to which the board member belongs.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string", + "description": "A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request." + } + }, + { + "description": "Unique identifier (ID) of the board for which you want to retrieve the list of available items.", "in": "path", "name": "board_id", "required": true, @@ -6656,126 +3088,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BoardMembersPagedResponse" - } - } - }, - "description": "Board members retrieved" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/GenericItemCursorPaged" } } }, - "description": "Too many requests" + "description": "Items retrieved" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Get all board members", - "tags": ["board_members"] + "summary": "Get items on board", + "tags": ["items"] } }, - "/v2/boards/{board_id}/members/{board_member_id}": { + "/v2/boards/{board_id}/items/{item_id}": { "get": { - "description": "Retrieves information for a board member.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-specific-board-member", + "description": "Retrieves information for a specific item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-specific-item", "parameters": [ { - "description": "Unique identifier (ID) of the board to which the board member belongs.", + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", "in": "path", "name": "board_id", "required": true, @@ -6784,9 +3123,9 @@ } }, { - "description": "Unique identifier (ID) of the board member whose role you want to retrieve.", + "description": "Unique identifier (ID) of the item that you want to retrieve.", "in": "path", - "name": "board_member_id", + "name": "item_id", "required": true, "schema": { "type": "string" @@ -6798,274 +3137,243 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BoardMemberWithLinks" + "$ref": "#/components/schemas/GenericItem" } } }, - "description": "Board member retrieved" + "description": "Item retrieved" }, "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Get specific item on board", + "tags": ["items"] + }, + "patch": { + "description": "Updates the position or the parent of an item on a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-item-position-or-parent", + "parameters": [ + { + "description": "Unique identifier (ID) of the board where you want to update the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to update.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenericItemUpdate" + } + } + }, + "required": true + }, + "responses": { + "200": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/GenericItem" } } }, - "description": "Malformed request" + "description": "Item updated" + }, + "400": { + "$ref": "#/components/responses/400" }, "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Update item position or parent", + "tags": ["items"] + }, + "delete": { + "description": "Deletes an item from a board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board from which you want to delete the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to delete.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "type": "object" } } }, - "description": "Not found" + "description": "Item deleted" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" }, "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Delete item", + "tags": ["items"] + } + }, + "/v2/boards/{board_id}/members": { + "post": { + "description": "Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "share-board", + "parameters": [ + { + "description": "Unique identifier (ID) of the board to which the board member belongs.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BoardMembersInvite" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/schemas/InvitationResult" } } }, - "description": "Too many requests" + "description": "Board members invited" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Get specific board member", + "summary": "Share board", "tags": ["board_members"] }, - "patch": { - "description": "Updates the role of a board member.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-board-member", + "get": { + "description": "Retrieves a pageable list of members for a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-board-members", "parameters": [ { - "description": "Unique identifier (ID) of the board for which you want to update the role of the board member.", - "in": "path", - "name": "board_id", - "required": true, + "in": "query", + "name": "limit", "schema": { - "type": "string" + "type": "string", + "description": "The maximum number of board members to retrieve.\nDefault: `20`.", + "maximum": 50, + "minimum": 1 } }, { - "description": "Unique identifier (ID) of the board member whose role you want to update.", + "in": "query", + "name": "offset", + "schema": { + "type": "string", + "description": "The (zero-based) offset of the first item in the collection to return.\nDefault: `0`." + } + }, + { + "description": "Unique identifier (ID) of the board to which the board member belongs.", "in": "path", - "name": "board_member_id", + "name": "board_id", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BoardMemberChanges" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BoardMemberWithLinks" + "$ref": "#/components/schemas/BoardMembersPagedResponse" } } }, - "description": "Board member updated" + "description": "Board members retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Update board member", + "summary": "Get all board members", "tags": ["board_members"] - }, - "delete": { - "description": "Removes a board member from a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "remove-board-member", + } + }, + "/v2/boards/{board_id}/members/{board_member_id}": { + "get": { + "description": "Retrieves information for a board member.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-specific-board-member", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete an item.", + "description": "Unique identifier (ID) of the board to which the board member belongs.", "in": "path", "name": "board_id", "required": true, @@ -7074,7 +3382,7 @@ } }, { - "description": "Unique identifier (ID) of the board member whose role you want to delete.", + "description": "Unique identifier (ID) of the board member whose role you want to retrieve.", "in": "path", "name": "board_member_id", "required": true, @@ -7084,273 +3392,92 @@ } ], "responses": { - "204": { + "200": { "content": { "application/json": { "schema": { - "type": "object" + "$ref": "#/components/schemas/BoardMemberWithLinks" } } }, - "description": "Board member deleted" + "description": "Board member retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Remove board member", + "summary": "Get specific board member", "tags": ["board_members"] - } - }, - "/v2/boards/{board_id}/shapes": { - "post": { - "description": "Adds a shape item to a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-shape-item", + }, + "patch": { + "description": "Updates the role of a board member.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-board-member", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to create the item.", + "description": "Unique identifier (ID) of the board for which you want to update the role of the board member.", "in": "path", "name": "board_id", "required": true, "schema": { "type": "string" } + }, + { + "description": "Unique identifier (ID) of the board member whose role you want to update.", + "in": "path", + "name": "board_member_id", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShapeCreateRequest" + "$ref": "#/components/schemas/BoardMemberChanges" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShapeItem" + "$ref": "#/components/schemas/BoardMemberWithLinks" } } }, - "description": "Shape item created" + "description": "Board member updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Create shape item", - "tags": ["shapes"] - } - }, - "/v2/boards/{board_id}/shapes/{item_id}": { - "get": { - "description": "Retrieves information for a specific shape item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-shape-item", + "summary": "Update board member", + "tags": ["board_members"] + }, + "delete": { + "description": "Removes a board member from a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "remove-board-member", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "description": "Unique identifier (ID) of the board from which you want to delete an item.", "in": "path", "name": "board_id", "required": true, @@ -7359,9 +3486,9 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to retrieve.", + "description": "Unique identifier (ID) of the board member whose role you want to delete.", "in": "path", - "name": "item_id", + "name": "board_member_id", "required": true, "schema": { "type": "string" @@ -7369,157 +3496,57 @@ } ], "responses": { - "200": { + "204": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShapeItem" + "type": "object" } } }, - "description": "Shape item retrieved" + "description": "Board member deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Get shape item", - "tags": ["shapes"] - }, - "patch": { - "description": "Updates a shape item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-shape-item", + "summary": "Remove board member", + "tags": ["board_members"] + } + }, + "/v2/boards/{board_id}/shapes": { + "post": { + "description": "Adds a shape item to a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-shape-item", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to update the item.", + "description": "Unique identifier (ID) of the board where you want to create the item.", "in": "path", "name": "board_id", "required": true, "schema": { "type": "string" } - }, - { - "description": "Unique identifier (ID) of the item that you want to update.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShapeUpdateRequest" + "$ref": "#/components/schemas/ShapeCreateRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { @@ -7527,120 +3554,29 @@ } } }, - "description": "Shape item updated" + "description": "Shape item created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Update shape item", + "summary": "Create shape item", "tags": ["shapes"] - }, - "delete": { - "description": "Deletes a shape item from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-shape-item", + } + }, + "/v2/boards/{board_id}/shapes/{item_id}": { + "get": { + "description": "Retrieves information for a specific shape item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-shape-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", "in": "path", "name": "board_id", "required": true, @@ -7649,7 +3585,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to delete.", + "description": "Unique identifier (ID) of the item that you want to retrieve.", "in": "path", "name": "item_id", "required": true, @@ -7659,273 +3595,95 @@ } ], "responses": { - "204": { + "200": { "content": { "application/json": { "schema": { - "type": "object" + "$ref": "#/components/schemas/ShapeItem" } } }, - "description": "Shape item deleted" + "description": "Shape item retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Delete shape item", + "summary": "Get shape item", "tags": ["shapes"] - } - }, - "/v2/boards/{board_id}/sticky_notes": { - "post": { - "description": "Adds a sticky note item to a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-sticky-note-item", + }, + "patch": { + "description": "Updates a shape item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-shape-item", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to create the item.", + "description": "Unique identifier (ID) of the board where you want to update the item.", "in": "path", "name": "board_id", "required": true, "schema": { "type": "string" } + }, + { + "description": "Unique identifier (ID) of the item that you want to update.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StickyNoteCreateRequest" + "$ref": "#/components/schemas/ShapeUpdateRequest" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StickyNoteItem" + "$ref": "#/components/schemas/ShapeItem" } } }, - "description": "Sticky Note item created" + "description": "Shape item updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Create sticky note item", - "tags": ["sticky_notes"] - } - }, - "/v2/boards/{board_id}/sticky_notes/{item_id}": { - "get": { - "description": "Retrieves information for a specific sticky note item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-sticky-note-item", + "summary": "Update shape item", + "tags": ["shapes"] + }, + "delete": { + "description": "Deletes a shape item from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-shape-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "description": "Unique identifier (ID) of the board from which you want to delete the item.", "in": "path", "name": "board_id", "required": true, @@ -7934,7 +3692,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to retrieve.", + "description": "Unique identifier (ID) of the item that you want to delete.", "in": "path", "name": "item_id", "required": true, @@ -7944,157 +3702,57 @@ } ], "responses": { - "200": { + "204": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StickyNoteItem" + "type": "object" } } }, - "description": "Sticky Note item retrieved" + "description": "Shape item deleted" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/400" }, - "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Get sticky note item", - "tags": ["sticky_notes"] - }, - "patch": { - "description": "Updates a sticky note item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-sticky-note-item", + "summary": "Delete shape item", + "tags": ["shapes"] + } + }, + "/v2/boards/{board_id}/sticky_notes": { + "post": { + "description": "Adds a sticky note item to a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-sticky-note-item", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to update the item.", + "description": "Unique identifier (ID) of the board where you want to create the item.", "in": "path", "name": "board_id", "required": true, "schema": { "type": "string" } - }, - { - "description": "Unique identifier (ID) of the item that you want to update.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StickyNoteUpdateRequest" + "$ref": "#/components/schemas/StickyNoteCreateRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { @@ -8102,120 +3760,29 @@ } } }, - "description": "Sticky Note item updated" + "description": "Sticky Note item created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Update sticky note item", + "summary": "Create sticky note item", "tags": ["sticky_notes"] - }, - "delete": { - "description": "Deletes a sticky note item from the board.

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-sticky-note-item", + } + }, + "/v2/boards/{board_id}/sticky_notes/{item_id}": { + "get": { + "description": "Retrieves information for a specific sticky note item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-sticky-note-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", "in": "path", "name": "board_id", "required": true, @@ -8224,7 +3791,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to delete.", + "description": "Unique identifier (ID) of the item that you want to retrieve.", "in": "path", "name": "item_id", "required": true, @@ -8234,273 +3801,95 @@ } ], "responses": { - "204": { + "200": { "content": { "application/json": { "schema": { - "type": "object" + "$ref": "#/components/schemas/StickyNoteItem" } } }, - "description": "Sticky Note item deleted" + "description": "Sticky Note item retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Delete sticky note item", + "summary": "Get sticky note item", "tags": ["sticky_notes"] - } - }, - "/v2/boards/{board_id}/texts": { - "post": { - "description": "Adds a text item to a board.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "create-text-item", + }, + "patch": { + "description": "Updates a sticky note item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-sticky-note-item", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to create the item.", + "description": "Unique identifier (ID) of the board where you want to update the item.", "in": "path", "name": "board_id", "required": true, "schema": { "type": "string" } + }, + { + "description": "Unique identifier (ID) of the item that you want to update.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TextCreateRequest" + "$ref": "#/components/schemas/StickyNoteUpdateRequest" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TextItem" + "$ref": "#/components/schemas/StickyNoteItem" } } }, - "description": "Text item created" + "description": "Sticky Note item updated" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Create text item", - "tags": ["texts"] - } - }, - "/v2/boards/{board_id}/texts/{item_id}": { - "get": { - "description": "Retrieves information for a specific text item on a board.

Required scope

boards:read

Rate limiting

Level 1
", - "operationId": "get-text-item", + "summary": "Update sticky note item", + "tags": ["sticky_notes"] + }, + "delete": { + "description": "Deletes a sticky note item from the board.

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-sticky-note-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", + "description": "Unique identifier (ID) of the board from which you want to delete the item.", "in": "path", "name": "board_id", "required": true, @@ -8509,7 +3898,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to retrieve.", + "description": "Unique identifier (ID) of the item that you want to delete.", "in": "path", "name": "item_id", "required": true, @@ -8519,157 +3908,57 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TextItem" - } - } - }, - "description": "Text item retrieved" - }, - "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" - }, - "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" - }, - "429": { + "204": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "type": "object" } } }, - "description": "Too many requests" + "description": "Sticky Note item deleted" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, - "summary": "Get text item", - "tags": ["texts"] - }, - "patch": { - "description": "Updates a text item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", - "operationId": "update-text-item", + "summary": "Delete sticky note item", + "tags": ["sticky_notes"] + } + }, + "/v2/boards/{board_id}/texts": { + "post": { + "description": "Adds a text item to a board.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "create-text-item", "parameters": [ { - "description": "Unique identifier (ID) of the board where you want to update the item.", + "description": "Unique identifier (ID) of the board where you want to create the item.", "in": "path", "name": "board_id", "required": true, "schema": { "type": "string" } - }, - { - "description": "Unique identifier (ID) of the item that you want to update.", - "in": "path", - "name": "item_id", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TextUpdateRequest" + "$ref": "#/components/schemas/TextCreateRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { @@ -8677,120 +3966,29 @@ } } }, - "description": "Text item updated" + "description": "Text item created" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Not found" + "$ref": "#/components/responses/404" }, "429": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Too many requests" + "$ref": "#/components/responses/429" } }, - "summary": "Update text item", + "summary": "Create text item", "tags": ["texts"] - }, - "delete": { - "description": "Deletes a text item from the board

Required scope

boards:write

Rate limiting

Level 3
", - "operationId": "delete-text-item", + } + }, + "/v2/boards/{board_id}/texts/{item_id}": { + "get": { + "description": "Retrieves information for a specific text item on a board.

Required scope

boards:read

Rate limiting

Level 1
", + "operationId": "get-text-item", "parameters": [ { - "description": "Unique identifier (ID) of the board from which you want to delete the item.", + "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item.", "in": "path", "name": "board_id", "required": true, @@ -8799,7 +3997,7 @@ } }, { - "description": "Unique identifier (ID) of the item that you want to delete.", + "description": "Unique identifier (ID) of the item that you want to retrieve.", "in": "path", "name": "item_id", "required": true, @@ -8809,117 +4007,131 @@ } ], "responses": { - "204": { + "200": { "content": { "application/json": { "schema": { - "type": "object" + "$ref": "#/components/schemas/TextItem" } } }, - "description": "Text item deleted" + "description": "Text item retrieved" }, "400": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } - } - } - }, - "description": "Malformed request" + "$ref": "#/components/responses/400" }, "404": { - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Get text item", + "tags": ["texts"] + }, + "patch": { + "description": "Updates a text item on a board based on the data and style properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2
", + "operationId": "update-text-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board where you want to update the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to update.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TextUpdateRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TextItem" } } }, - "description": "Not found" + "description": "Text item updated" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "409": { + "$ref": "#/components/responses/409" }, "429": { + "$ref": "#/components/responses/429" + } + }, + "summary": "Update text item", + "tags": ["texts"] + }, + "delete": { + "description": "Deletes a text item from the board

Required scope

boards:write

Rate limiting

Level 3
", + "operationId": "delete-text-item", + "parameters": [ + { + "description": "Unique identifier (ID) of the board from which you want to delete the item.", + "in": "path", + "name": "board_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier (ID) of the item that you want to delete.", + "in": "path", + "name": "item_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { "content": { "application/json": { "schema": { - "type": "object", - "description": "Test error obj", - "properties": { - "code": { - "type": "string", - "description": "Code of the error", - "example": "error" - }, - "message": { - "type": "string", - "description": "Description of the error", - "example": "Error message" - }, - "status": { - "type": "integer", - "format": "int32", - "description": "Status code of the error", - "example": 400 - }, - "type": { - "type": "string", - "description": "Type of the error", - "example": "error" - } - } + "type": "object" } } }, - "description": "Too many requests." + "description": "Text item deleted" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" } }, "summary": "Delete text item", @@ -9392,6 +4604,40 @@ }, "description": "Not found" }, + "409": { + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Test error obj", + "properties": { + "code": { + "type": "string", + "description": "Code of the error", + "example": "error" + }, + "message": { + "type": "string", + "description": "Description of the error", + "example": "Error message" + }, + "status": { + "type": "integer", + "format": "int32", + "description": "Status code of the error", + "example": 409 + }, + "type": { + "type": "string", + "description": "Type of the error", + "example": "error" + } + } + } + } + }, + "description": "Conflict" + }, "429": { "content": { "application/json": { @@ -11863,6 +7109,19 @@ }, "/v2/boards/{board_id_PlatformFileUpload}/documents": { "post": { + "x-readme": { + "explorer-enabled": false, + "samples-languages": ["shell"], + "code-samples": [ + { + "language": "curl", + "code": "curl -X \"POST\" \"https://api.miro.com/v2/boards/{board_id_PlatformFileUpload}/documents\" \\\n-H \"accept: application/json\" \\\n-H \"Authorization: Bearer {{ACCESS_TOKEN}}\" \\\n-H \"Content-Type: multipart/form-data\" \\\n-F \"data={\\\"title\\\":\\\"testpdf\\\",\\\"position\\\":{\\\"x\\\":3000,\\\"y\\\":3000}};type=application/json\" \\\n-F \"resource=@/Users/user/test.pdf;type=application/pdf\"\n", + "name": "Custom cURL snippet", + "install": "brew install curl", + "correspondingExample": "documentPostExample" + } + ] + }, "description": "Adds a document item to a board by selecting file from device.

Required scope

boards:write

Rate limiting

Level 2
", "operationId": "create-document-item-using-file-from-device", "parameters": [ @@ -11918,6 +7177,41 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DocumentItem" + }, + "examples": { + "documentPostExample": { + "value": { + "id": "3458764517517819000", + "type": "document", + "data": { + "imageUrl": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/resources/documents/3458764515979043608?format=preview&redirect=false", + "title": "testpdf" + }, + "geometry": { + "width": 512, + "height": 512 + }, + "position": { + "x": 3000, + "y": 3000, + "origin": "center", + "relativeTo": "canvas_center" + }, + "links": { + "self": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/documents/3458764597687208572" + }, + "createdAt": "2024-08-21T11:19:57Z", + "createdBy": { + "id": "3458764569867985278", + "type": "user" + }, + "modifiedAt": "2024-08-21T11:19:57Z", + "modifiedBy": { + "id": "3458764569867985278", + "type": "user" + } + } + } } } }, @@ -11930,6 +7224,19 @@ }, "/v2/boards/{board_id_PlatformFileUpload}/documents/{item_id}": { "patch": { + "x-readme": { + "explorer-enabled": false, + "samples-languages": ["shell"], + "code-samples": [ + { + "language": "curl", + "code": "curl -X \"PATCH\" \"https://api.miro.com/v2/boards/{board_id_PlatformFileUpload}/documents/{item_id}\" \\\n-H \"accept: application/json\" \\\n-H \"Authorization: Bearer {{ACCESS_TOKEN}}\" \\\n-H \"Content-Type: multipart/form-data\" \\\n-F \"data={\\\"title\\\":\\\"testpdf\\\",\\\"position\\\":{\\\"x\\\":3000,\\\"y\\\":3000}};type=application/json\" \\\n-F \"resource=@/Users/user/test.pdf;type=application/pdf\"\n", + "name": "Custom cURL snippet", + "install": "brew install curl", + "correspondingExample": "documentPatchExample" + } + ] + }, "description": "Updates a document item on a board by using file from a device.

Required scope

boards:write

Rate limiting

Level 2
", "operationId": "update-document-item-using-file-from-device", "parameters": [ @@ -11968,6 +7275,41 @@ "application/json": { "schema": { "$ref": "#/components/schemas/DocumentItem" + }, + "examples": { + "documentPatchExample": { + "value": { + "id": "3458764517517819000", + "type": "document", + "data": { + "imageUrl": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/resources/documents/3458764515979043608?format=preview&redirect=false", + "title": "testpdf" + }, + "geometry": { + "width": 512, + "height": 512 + }, + "position": { + "x": 3000, + "y": 3000, + "origin": "center", + "relativeTo": "canvas_center" + }, + "links": { + "self": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/documents/3458764597687208572" + }, + "createdAt": "2024-08-21T11:19:57Z", + "createdBy": { + "id": "3458764569867985278", + "type": "user" + }, + "modifiedAt": "2024-08-21T11:19:57Z", + "modifiedBy": { + "id": "3458764569867985278", + "type": "user" + } + } + } } } }, @@ -11980,6 +7322,19 @@ }, "/v2/boards/{board_id_PlatformFileUpload}/images": { "post": { + "x-readme": { + "explorer-enabled": false, + "samples-languages": ["shell"], + "code-samples": [ + { + "language": "curl", + "code": "curl -X \"POST\" \"https://api.miro.com/v2/boards/{board_id_PlatformFileUpload}/images\" \\\n -H \"accept: application/json\" \\\n -H \"Authorization: Bearer {{ACCESS_TOKEN}} \\\n -H \"Content-Type: multipart/form-data\" \\\n -F \"data={\\\"position\\\":{\\\"x\\\":3000,\\\"y\\\":3000}};type=application/json\" \\\n -F \"resource=@image.png;type=image/png\"\n", + "name": "Custom cURL snippet", + "install": "brew install curl", + "correspondingExample": "imagePostExample" + } + ] + }, "x-settings": { "skip-tests": true }, @@ -12012,6 +7367,41 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ImageItem" + }, + "examples": { + "imagePostExample": { + "value": { + "id": "3458764597687208572", + "type": "image", + "data": { + "imageUrl": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/resources/images/3458764515979043608?format=preview&redirect=false", + "title": "image" + }, + "geometry": { + "width": 512, + "height": 512 + }, + "position": { + "x": 3000, + "y": 3000, + "origin": "center", + "relativeTo": "canvas_center" + }, + "links": { + "self": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/images/3458764597687208572" + }, + "createdAt": "2024-08-21T11:19:57Z", + "createdBy": { + "id": "3458764569867985278", + "type": "user" + }, + "modifiedAt": "2024-08-21T11:19:57Z", + "modifiedBy": { + "id": "3458764569867985278", + "type": "user" + } + } + } } } }, @@ -12024,6 +7414,19 @@ }, "/v2/boards/{board_id_PlatformFileUpload}/images/{item_id}": { "patch": { + "x-readme": { + "explorer-enabled": false, + "samples-languages": ["shell"], + "code-samples": [ + { + "language": "curl", + "code": "curl -X \"PATCH\" \"https://api.miro.com/v2/boards/{board_id_PlatformFileUpload}/images/{item_id}\" \\\n -H \"accept: application/json\" \\\n -H \"Authorization: Bearer {{ACCESS_TOKEN}} \\\n -H \"Content-Type: multipart/form-data\" \\\n -F \"data={\\\"position\\\":{\\\"x\\\":3000,\\\"y\\\":3000}};type=application/json\" \\\n -F \"resource=@image.png;type=image/png\"\n", + "name": "Custom cURL snippet", + "install": "brew install curl", + "correspondingExample": "imagePatchExample" + } + ] + }, "x-settings": { "skip-tests": true }, @@ -12065,6 +7468,41 @@ "application/json": { "schema": { "$ref": "#/components/schemas/ImageItem" + }, + "examples": { + "imagePatchExample": { + "value": { + "id": "3458764597687208572", + "type": "image", + "data": { + "imageUrl": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/resources/images/3458764515979043608?format=preview&redirect=false", + "title": "image" + }, + "geometry": { + "width": 512, + "height": 512 + }, + "position": { + "x": 3000, + "y": 3000, + "origin": "center", + "relativeTo": "canvas_center" + }, + "links": { + "self": "https://api.miro.com/v2/boards/board_id_PlatformFileUpload/images/3458764597687208572" + }, + "createdAt": "2024-08-21T11:19:57Z", + "createdBy": { + "id": "3458764569867985278", + "type": "user" + }, + "modifiedAt": "2024-08-21T11:19:57Z", + "modifiedBy": { + "id": "3458764569867985278", + "type": "user" + } + } + } } } }, @@ -16323,6 +11761,9 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "429": { "$ref": "#/components/responses/429" } @@ -16360,6 +11801,9 @@ "404": { "$ref": "#/components/responses/404" }, + "409": { + "$ref": "#/components/responses/409" + }, "429": { "$ref": "#/components/responses/429" } @@ -16579,6 +12023,11 @@ "type": "string", "description": "Event type of the audit event", "example": "sign_in_succeeded" + }, + "category": { + "type": "string", + "description": "Event category of the audit event.", + "example": "authentication" } } }, @@ -19660,7 +15109,7 @@ "enum": ["app_card", "text", "shape", "sticky_note", "image", "document", "card", "frame", "embed"], "example": "text" }, - "ImageUrlDataPlatformbulkcreateoperation": { + "ImageUrlData": { "type": "object", "description": "Contains information about the image URL.", "properties": { @@ -19678,7 +15127,7 @@ }, "required": ["url"] }, - "ImageUrlDataChangesPlatformbulkcreateoperation": { + "ImageUrlDataChanges": { "type": "object", "description": "Contains information about the image URL.", "properties": { @@ -19821,40 +15270,6 @@ }, "required": ["url"] }, - "ImageUrlData": { - "type": "object", - "description": "Contains information about the image URL.", - "properties": { - "title": { - "type": "string", - "description": "A short text header to identify the image.", - "example": "Sample image title" - }, - "url": { - "type": "string", - "default": "https://miro.com/static/images/page/mr-index/localization/en/slider/ideation_brainstorming.png", - "description": "URL of the image.", - "example": "https://miro.com/static/images/page/mr-index/localization/en/slider/ideation_brainstorming.png" - } - }, - "required": ["url"] - }, - "ImageUrlDataChanges": { - "type": "object", - "description": "Contains information about the image URL.", - "properties": { - "title": { - "type": "string", - "description": "A short text header to identify the image.", - "example": "Test image title" - }, - "url": { - "type": "string", - "description": "URL of the image.", - "example": "https://miro.com/static/images/page/mr-index/localization/en/slider/ideation_brainstorming.png" - } - } - }, "FrameChanges": { "type": "object", "description": "Contains frame item data, such as the title, frame type, or frame format.", @@ -21523,7 +16938,7 @@ "$ref": "#/components/schemas/PositionChange" }, "geometry": { - "$ref": "#/components/schemas/Geometry" + "$ref": "#/components/schemas/MindMapNodeGeometry" }, "parent": { "$ref": "#/components/schemas/Parent" @@ -22141,6 +17556,18 @@ } } }, + "MindMapNodeGeometry": { + "type": "object", + "description": "Contains width of the item.", + "properties": { + "width": { + "type": "number", + "format": "double", + "description": "Width of the item, in pixels.", + "example": 320 + } + } + }, "MindmapNodeStyle": { "type": "object", "description": "Contains information about the node style, such as the node color or fillOpacity.", @@ -22463,6 +17890,11 @@ "description": "Title for the document.", "example": "foo.png" }, + "altText": { + "type": "string", + "description": "A description (alt-text) to help people understand what is depicted here.", + "example": "Sample image alt text" + }, "position": { "$ref": "#/components/schemas/PositionChange" }, @@ -24077,7 +19509,7 @@ } } }, - "BasicErrorTeamsEnterprisePlan": { + "BasicError": { "type": "object", "properties": { "status": { @@ -24618,28 +20050,6 @@ "$ref": "#/components/schemas/PageType" } } - }, - "BasicError": { - "type": "object", - "properties": { - "status": { - "type": "number", - "description": "HTTP status code." - }, - "code": { - "type": "string", - "description": "Description of the status code." - }, - "message": { - "type": "string", - "description": "Explanation for the error" - }, - "type": { - "type": "string", - "description": "Type of the object returned.", - "default": "error" - } - } } }, "parameters": { diff --git a/packages/miro-api-python/.openapi-generator/FILES b/packages/miro-api-python/.openapi-generator/FILES index 027b99dfc..5e4c5fd46 100644 --- a/packages/miro-api-python/.openapi-generator/FILES +++ b/packages/miro-api-python/.openapi-generator/FILES @@ -62,7 +62,6 @@ miro_api/docs/AuditPage.md miro_api/docs/AuditTeam.md miro_api/docs/BasicError.md miro_api/docs/BasicErrorOrganizationsEnterprisePlan.md -miro_api/docs/BasicErrorTeamsEnterprisePlan.md miro_api/docs/Board.md miro_api/docs/BoardChanges.md miro_api/docs/BoardClassificationBoardLevelApi.md @@ -122,6 +121,7 @@ miro_api/docs/CopyBoardChanges.md miro_api/docs/CreateBoardExportRequest.md miro_api/docs/CreateBoardSubscriptionRequest.md miro_api/docs/CreateDocumentItemUsingFileFromDeviceRequestData.md +miro_api/docs/CreateFrameItem400Response.md miro_api/docs/CreateProjectRequest.md miro_api/docs/CreateTeamRequest.md miro_api/docs/CreatedBy.md @@ -202,7 +202,6 @@ miro_api/docs/GetAllGroups404Response.md miro_api/docs/GetAllGroups429Response.md miro_api/docs/GetBoardItemContentLogsResponse.md miro_api/docs/GetBoardUserInfoLastOpenedBy.md -miro_api/docs/GetBoards400Response.md miro_api/docs/GetItemsByGroupId200Response.md miro_api/docs/GetItemsByGroupId200ResponseData.md miro_api/docs/GetMetrics200ResponseInner.md @@ -224,8 +223,6 @@ miro_api/docs/ImageItemPlatformFileUpload.md miro_api/docs/ImageUpdateRequest.md miro_api/docs/ImageUrlData.md miro_api/docs/ImageUrlDataChanges.md -miro_api/docs/ImageUrlDataChangesPlatformbulkcreateoperation.md -miro_api/docs/ImageUrlDataPlatformbulkcreateoperation.md miro_api/docs/ImagesApi.md miro_api/docs/InvitationError.md miro_api/docs/InvitationResult.md @@ -249,6 +246,7 @@ miro_api/docs/Items.md miro_api/docs/ItemsApi.md miro_api/docs/ItemsPage.md miro_api/docs/ItemsPlatformcreateitemsinbulkusingfilefromdevice.md +miro_api/docs/MindMapNodeGeometry.md miro_api/docs/MindMapNodesExperimentalApi.md miro_api/docs/MindmapCreateRequest.md miro_api/docs/MindmapCursorPaged.md @@ -376,6 +374,7 @@ miro_api/docs/UpdateBoardsDataClassificationLabel.md miro_api/docs/UpdateBoardsDataClassificationLabelRequest.md miro_api/docs/UpdateCardStyle.md miro_api/docs/UpdateConnectorStyle.md +miro_api/docs/UpdateFrameItem409Response.md miro_api/docs/UpdateFrameStyle.md miro_api/docs/UpdateProjectMemberRequest.md miro_api/docs/UpdateProjectRequest.md @@ -419,7 +418,6 @@ miro_api/models/audit_page.py miro_api/models/audit_team.py miro_api/models/basic_error.py miro_api/models/basic_error_organizations_enterprise_plan.py -miro_api/models/basic_error_teams_enterprise_plan.py miro_api/models/board.py miro_api/models/board_changes.py miro_api/models/board_content_log_data.py @@ -469,6 +467,7 @@ miro_api/models/copy_board_changes.py miro_api/models/create_board_export_request.py miro_api/models/create_board_subscription_request.py miro_api/models/create_document_item_using_file_from_device_request_data.py +miro_api/models/create_frame_item400_response.py miro_api/models/create_project_request.py miro_api/models/create_team_request.py miro_api/models/created_by.py @@ -545,7 +544,6 @@ miro_api/models/get_all_groups404_response.py miro_api/models/get_all_groups429_response.py miro_api/models/get_board_item_content_logs_response.py miro_api/models/get_board_user_info_last_opened_by.py -miro_api/models/get_boards400_response.py miro_api/models/get_items_by_group_id200_response.py miro_api/models/get_items_by_group_id200_response_data.py miro_api/models/get_metrics200_response_inner.py @@ -566,8 +564,6 @@ miro_api/models/image_item_platform_file_upload.py miro_api/models/image_update_request.py miro_api/models/image_url_data.py miro_api/models/image_url_data_changes.py -miro_api/models/image_url_data_changes_platformbulkcreateoperation.py -miro_api/models/image_url_data_platformbulkcreateoperation.py miro_api/models/invitation_error.py miro_api/models/invitation_result.py miro_api/models/item.py @@ -589,6 +585,7 @@ miro_api/models/item_type_change.py miro_api/models/items.py miro_api/models/items_page.py miro_api/models/items_platformcreateitemsinbulkusingfilefromdevice.py +miro_api/models/mind_map_node_geometry.py miro_api/models/mindmap_create_request.py miro_api/models/mindmap_cursor_paged.py miro_api/models/mindmap_data.py @@ -701,6 +698,7 @@ miro_api/models/update_boards_data_classification_label.py miro_api/models/update_boards_data_classification_label_request.py miro_api/models/update_card_style.py miro_api/models/update_connector_style.py +miro_api/models/update_frame_item409_response.py miro_api/models/update_frame_style.py miro_api/models/update_project_member_request.py miro_api/models/update_project_request.py @@ -746,7 +744,6 @@ miro_api/test/test_audit_page.py miro_api/test/test_audit_team.py miro_api/test/test_basic_error.py miro_api/test/test_basic_error_organizations_enterprise_plan.py -miro_api/test/test_basic_error_teams_enterprise_plan.py miro_api/test/test_board.py miro_api/test/test_board_changes.py miro_api/test/test_board_classification_board_level_api.py @@ -806,6 +803,7 @@ miro_api/test/test_copy_board_changes.py miro_api/test/test_create_board_export_request.py miro_api/test/test_create_board_subscription_request.py miro_api/test/test_create_document_item_using_file_from_device_request_data.py +miro_api/test/test_create_frame_item400_response.py miro_api/test/test_create_project_request.py miro_api/test/test_create_team_request.py miro_api/test/test_created_by.py @@ -886,7 +884,6 @@ miro_api/test/test_get_all_groups404_response.py miro_api/test/test_get_all_groups429_response.py miro_api/test/test_get_board_item_content_logs_response.py miro_api/test/test_get_board_user_info_last_opened_by.py -miro_api/test/test_get_boards400_response.py miro_api/test/test_get_items_by_group_id200_response.py miro_api/test/test_get_items_by_group_id200_response_data.py miro_api/test/test_get_metrics200_response_inner.py @@ -908,8 +905,6 @@ miro_api/test/test_image_item_platform_file_upload.py miro_api/test/test_image_update_request.py miro_api/test/test_image_url_data.py miro_api/test/test_image_url_data_changes.py -miro_api/test/test_image_url_data_changes_platformbulkcreateoperation.py -miro_api/test/test_image_url_data_platformbulkcreateoperation.py miro_api/test/test_images_api.py miro_api/test/test_invitation_error.py miro_api/test/test_invitation_result.py @@ -933,6 +928,7 @@ miro_api/test/test_items.py miro_api/test/test_items_api.py miro_api/test/test_items_page.py miro_api/test/test_items_platformcreateitemsinbulkusingfilefromdevice.py +miro_api/test/test_mind_map_node_geometry.py miro_api/test/test_mind_map_nodes_experimental_api.py miro_api/test/test_mindmap_create_request.py miro_api/test/test_mindmap_cursor_paged.py @@ -1060,6 +1056,7 @@ miro_api/test/test_update_boards_data_classification_label.py miro_api/test/test_update_boards_data_classification_label_request.py miro_api/test/test_update_card_style.py miro_api/test/test_update_connector_style.py +miro_api/test/test_update_frame_item409_response.py miro_api/test/test_update_frame_style.py miro_api/test/test_update_project_member_request.py miro_api/test/test_update_project_request.py diff --git a/packages/miro-api-python/miro_api/api/__init__.py b/packages/miro-api-python/miro_api/api/__init__.py index 8d0ed2822..fcb215375 100644 --- a/packages/miro-api-python/miro_api/api/__init__.py +++ b/packages/miro-api-python/miro_api/api/__init__.py @@ -2076,9 +2076,9 @@ def create_shape_item_flowchart( _response_types_map: Dict[str, Optional[str]] = { "201": "ShapeItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2205,9 +2205,9 @@ def delete_shape_item_flowchart( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2337,9 +2337,9 @@ def get_items_experimental( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericItemCursorPaged", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2473,9 +2473,9 @@ def get_shape_item_flowchart( _response_types_map: Dict[str, Optional[str]] = { "200": "ShapeItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2597,9 +2597,9 @@ def get_specific_item_experimental( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2722,9 +2722,9 @@ def update_shape_item_flowchart( _response_types_map: Dict[str, Optional[str]] = { "200": "ShapeItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2854,9 +2854,9 @@ def create_mindmap_nodes_experimental( _response_types_map: Dict[str, Optional[str]] = { "201": "MindmapItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -2986,9 +2986,9 @@ def delete_mindmap_node_experimental( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -5609,6 +5609,7 @@ def enterprise_delete_team_member( "401": None, "403": None, "404": None, + "409": None, "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -6161,6 +6162,7 @@ def enterprise_update_team_member( "401": None, "403": None, "404": None, + "409": None, "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) @@ -7315,9 +7317,9 @@ def create_board_subscription( _response_types_map: Dict[str, Optional[str]] = { "201": "BoardSubscription", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -7437,9 +7439,9 @@ def delete_subscription_by_id( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -7551,9 +7553,9 @@ def get_subscription_by_id( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericSubscription", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -7667,9 +7669,9 @@ def get_user_subscriptions( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericSubscriptionsCursorPaged", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -7790,9 +7792,9 @@ def update_board_subscription( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardSubscription", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -7919,9 +7921,9 @@ def create_app_card_item( _response_types_map: Dict[str, Optional[str]] = { "201": "AppCardItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -8048,9 +8050,9 @@ def delete_app_card_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -8172,9 +8174,9 @@ def get_app_card_item( _response_types_map: Dict[str, Optional[str]] = { "200": "AppCardItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -8297,9 +8299,10 @@ def update_app_card_item( _response_types_map: Dict[str, Optional[str]] = { "200": "AppCardItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -8686,9 +8689,9 @@ def get_board_members( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardMembersPagedResponse", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -8816,9 +8819,9 @@ def get_specific_board_member( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardMemberWithLinks", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -8939,9 +8942,9 @@ def remove_board_member( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9060,9 +9063,9 @@ def share_board( _response_types_map: Dict[str, Optional[str]] = { "201": "InvitationResult", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9198,9 +9201,9 @@ def update_board_member( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardMemberWithLinks", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9330,9 +9333,10 @@ def copy_board( _response_types_map: Dict[str, Optional[str]] = { "201": "BoardWithLinksAndWithoutProject", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9455,9 +9459,10 @@ def create_board( _response_types_map: Dict[str, Optional[str]] = { "201": "BoardWithLinks", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9541,7 +9546,7 @@ def delete_board( ) -> object: """Delete board - Deletes a board.

Required scope

boards:write

Rate limiting

Level 3
+ Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.

Required scope

boards:write

Rate limiting

Level 3
:param board_id: Unique identifier (ID) of the board that you want to delete. (required) :type board_id: str @@ -9577,9 +9582,10 @@ def delete_board( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9713,9 +9719,9 @@ def get_boards( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardsPagedResponse", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9859,9 +9865,9 @@ def get_specific_board( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardWithLinksAndLastOpened", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -9978,9 +9984,10 @@ def update_board( _response_types_map: Dict[str, Optional[str]] = { "200": "BoardWithLinks", "202": None, - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10107,9 +10114,9 @@ def create_card_item( _response_types_map: Dict[str, Optional[str]] = { "201": "CardItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10236,9 +10243,9 @@ def delete_card_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10360,9 +10367,9 @@ def get_card_item( _response_types_map: Dict[str, Optional[str]] = { "200": "CardItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10485,9 +10492,10 @@ def update_card_item( _response_types_map: Dict[str, Optional[str]] = { "200": "CardItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10618,9 +10626,9 @@ def create_connector( _response_types_map: Dict[str, Optional[str]] = { "200": "ConnectorWithLinks", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10750,9 +10758,9 @@ def delete_connector( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -10876,9 +10884,9 @@ def get_connector( _response_types_map: Dict[str, Optional[str]] = { "200": "ConnectorWithLinks", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -11004,9 +11012,9 @@ def get_connectors( _response_types_map: Dict[str, Optional[str]] = { "200": "ConnectorsCursorPaged", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -11139,9 +11147,10 @@ def update_connector( _response_types_map: Dict[str, Optional[str]] = { "200": "ConnectorWithLinks", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -11406,9 +11415,9 @@ def create_document_item_using_url( _response_types_map: Dict[str, Optional[str]] = { "201": "DocumentItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -11535,9 +11544,9 @@ def delete_document_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -11659,9 +11668,9 @@ def get_document_item( _response_types_map: Dict[str, Optional[str]] = { "200": "DocumentItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -11926,9 +11935,10 @@ def update_document_item_using_url( _response_types_map: Dict[str, Optional[str]] = { "200": "DocumentItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12058,9 +12068,9 @@ def create_embed_item( _response_types_map: Dict[str, Optional[str]] = { "201": "EmbedItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12187,9 +12197,9 @@ def delete_embed_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12311,9 +12321,9 @@ def get_embed_item( _response_types_map: Dict[str, Optional[str]] = { "200": "EmbedItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12436,9 +12446,10 @@ def update_embed_item( _response_types_map: Dict[str, Optional[str]] = { "200": "EmbedItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12568,9 +12579,9 @@ def create_frame_item( _response_types_map: Dict[str, Optional[str]] = { "201": "FrameItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12699,9 +12710,9 @@ def delete_frame_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12823,9 +12834,9 @@ def get_frame_item( _response_types_map: Dict[str, Optional[str]] = { "200": "FrameItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -12950,9 +12961,10 @@ def update_frame_item( _response_types_map: Dict[str, Optional[str]] = { "200": "FrameItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "409": "UpdateFrameItem409Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -14135,9 +14147,9 @@ def create_image_item_using_url( _response_types_map: Dict[str, Optional[str]] = { "201": "ImageItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -14264,9 +14276,9 @@ def delete_image_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -14388,9 +14400,9 @@ def get_image_item( _response_types_map: Dict[str, Optional[str]] = { "200": "ImageItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -14655,9 +14667,10 @@ def update_image_item_using_url( _response_types_map: Dict[str, Optional[str]] = { "200": "ImageItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -14787,9 +14800,9 @@ def delete_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -14908,9 +14921,9 @@ def delete_item_experimental( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15040,9 +15053,9 @@ def get_items( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericItemCursorPaged", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15193,9 +15206,9 @@ def get_items_within_frame( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericItemCursorPaged", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": "CreateFrameItem400Response", + "404": "CreateFrameItem400Response", + "429": "CreateFrameItem400Response", } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15334,9 +15347,9 @@ def get_specific_item( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15459,9 +15472,9 @@ def update_item_position_or_parent( _response_types_map: Dict[str, Optional[str]] = { "200": "GenericItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15591,9 +15604,9 @@ def create_shape_item( _response_types_map: Dict[str, Optional[str]] = { "201": "ShapeItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15720,9 +15733,9 @@ def delete_shape_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15844,9 +15857,9 @@ def get_shape_item( _response_types_map: Dict[str, Optional[str]] = { "200": "ShapeItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -15969,9 +15982,10 @@ def update_shape_item( _response_types_map: Dict[str, Optional[str]] = { "200": "ShapeItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -16101,9 +16115,9 @@ def create_sticky_note_item( _response_types_map: Dict[str, Optional[str]] = { "201": "StickyNoteItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -16230,9 +16244,9 @@ def delete_sticky_note_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -16354,9 +16368,9 @@ def get_sticky_note_item( _response_types_map: Dict[str, Optional[str]] = { "200": "StickyNoteItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -16479,9 +16493,10 @@ def update_sticky_note_item( _response_types_map: Dict[str, Optional[str]] = { "200": "StickyNoteItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -17787,9 +17802,9 @@ def create_text_item( _response_types_map: Dict[str, Optional[str]] = { "201": "TextItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -17916,9 +17931,9 @@ def delete_text_item( _response_types_map: Dict[str, Optional[str]] = { "204": "object", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -18040,9 +18055,9 @@ def get_text_item( _response_types_map: Dict[str, Optional[str]] = { "200": "TextItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() @@ -18165,9 +18180,10 @@ def update_text_item( _response_types_map: Dict[str, Optional[str]] = { "200": "TextItem", - "400": "GetBoards400Response", - "404": "GetBoards400Response", - "429": "GetBoards400Response", + "400": None, + "404": None, + "409": None, + "429": None, } response_data = self.api_client.call_api(*_param, _request_timeout=_request_timeout) response_data.read() diff --git a/packages/miro-api-python/miro_api/api_client.py b/packages/miro-api-python/miro_api/api_client.py index e5c6847ab..095d12738 100644 --- a/packages/miro-api-python/miro_api/api_client.py +++ b/packages/miro-api-python/miro_api/api_client.py @@ -82,7 +82,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None, cook self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "OpenAPI-Generator/2.2.0/python" + self.user_agent = "OpenAPI-Generator/2.2.1/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/packages/miro-api-python/miro_api/configuration.py b/packages/miro-api-python/miro_api/configuration.py index 2d28be074..562ed9fb3 100644 --- a/packages/miro-api-python/miro_api/configuration.py +++ b/packages/miro-api-python/miro_api/configuration.py @@ -390,7 +390,7 @@ def to_debug_report(self): "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: v2.0\n" - "SDK Package Version: 2.2.0".format(env=sys.platform, pyversion=sys.version) + "SDK Package Version: 2.2.1".format(env=sys.platform, pyversion=sys.version) ) def get_host_settings(self): diff --git a/packages/miro-api-python/miro_api/models/__init__.py b/packages/miro-api-python/miro_api/models/__init__.py index 2bd7f32f6..b8cca4ce5 100644 --- a/packages/miro-api-python/miro_api/models/__init__.py +++ b/packages/miro-api-python/miro_api/models/__init__.py @@ -39,7 +39,6 @@ from miro_api.models.audit_team import AuditTeam from miro_api.models.basic_error import BasicError from miro_api.models.basic_error_organizations_enterprise_plan import BasicErrorOrganizationsEnterprisePlan -from miro_api.models.basic_error_teams_enterprise_plan import BasicErrorTeamsEnterprisePlan from miro_api.models.board import Board from miro_api.models.board_changes import BoardChanges from miro_api.models.board_content_log_data import BoardContentLogData @@ -95,6 +94,7 @@ from miro_api.models.create_document_item_using_file_from_device_request_data import ( CreateDocumentItemUsingFileFromDeviceRequestData, ) +from miro_api.models.create_frame_item400_response import CreateFrameItem400Response from miro_api.models.create_project_request import CreateProjectRequest from miro_api.models.create_team_request import CreateTeamRequest from miro_api.models.created_by import CreatedBy @@ -181,7 +181,6 @@ from miro_api.models.get_all_groups429_response import GetAllGroups429Response from miro_api.models.get_board_item_content_logs_response import GetBoardItemContentLogsResponse from miro_api.models.get_board_user_info_last_opened_by import GetBoardUserInfoLastOpenedBy -from miro_api.models.get_boards400_response import GetBoards400Response from miro_api.models.get_items_by_group_id200_response import GetItemsByGroupId200Response from miro_api.models.get_items_by_group_id200_response_data import GetItemsByGroupId200ResponseData from miro_api.models.get_metrics200_response_inner import GetMetrics200ResponseInner @@ -204,10 +203,6 @@ from miro_api.models.image_update_request import ImageUpdateRequest from miro_api.models.image_url_data import ImageUrlData from miro_api.models.image_url_data_changes import ImageUrlDataChanges -from miro_api.models.image_url_data_changes_platformbulkcreateoperation import ( - ImageUrlDataChangesPlatformbulkcreateoperation, -) -from miro_api.models.image_url_data_platformbulkcreateoperation import ImageUrlDataPlatformbulkcreateoperation from miro_api.models.invitation_error import InvitationError from miro_api.models.invitation_result import InvitationResult from miro_api.models.item import Item @@ -237,6 +232,7 @@ from miro_api.models.items_platformcreateitemsinbulkusingfilefromdevice import ( ItemsPlatformcreateitemsinbulkusingfilefromdevice, ) +from miro_api.models.mind_map_node_geometry import MindMapNodeGeometry from miro_api.models.mindmap_create_request import MindmapCreateRequest from miro_api.models.mindmap_cursor_paged import MindmapCursorPaged from miro_api.models.mindmap_data import MindmapData @@ -365,6 +361,7 @@ from miro_api.models.update_boards_data_classification_label_request import UpdateBoardsDataClassificationLabelRequest from miro_api.models.update_card_style import UpdateCardStyle from miro_api.models.update_connector_style import UpdateConnectorStyle +from miro_api.models.update_frame_item409_response import UpdateFrameItem409Response from miro_api.models.update_frame_style import UpdateFrameStyle from miro_api.models.update_project_member_request import UpdateProjectMemberRequest from miro_api.models.update_project_request import UpdateProjectRequest diff --git a/packages/miro-api-python/miro_api/models/audit_event.py b/packages/miro-api-python/miro_api/models/audit_event.py index d2fa407fe..1deb87c07 100644 --- a/packages/miro-api-python/miro_api/models/audit_event.py +++ b/packages/miro-api-python/miro_api/models/audit_event.py @@ -41,8 +41,18 @@ class AuditEvent(BaseModel): details: Optional[Dict[str, Any]] = Field(default=None, description="Details json related to the audit event") created_by: Optional[AuditCreatedBy] = Field(default=None, alias="createdBy") event: Optional[StrictStr] = Field(default=None, description="Event type of the audit event") + category: Optional[StrictStr] = Field(default=None, description="Event category of the audit event.") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["id", "context", "object", "createdAt", "details", "createdBy", "event"] + __properties: ClassVar[List[str]] = [ + "id", + "context", + "object", + "createdAt", + "details", + "createdBy", + "event", + "category", + ] model_config = { "populate_by_name": True, @@ -120,6 +130,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "details": obj.get("details"), "createdBy": AuditCreatedBy.from_dict(obj["createdBy"]) if obj.get("createdBy") is not None else None, "event": obj.get("event"), + "category": obj.get("category"), } ) # store additional fields in additional_properties diff --git a/packages/miro-api-python/miro_api/models/mind_map_node_geometry.py b/packages/miro-api-python/miro_api/models/mind_map_node_geometry.py new file mode 100644 index 000000000..76219e1fc --- /dev/null +++ b/packages/miro-api-python/miro_api/models/mind_map_node_geometry.py @@ -0,0 +1,99 @@ +# coding: utf-8 + +""" + Miro Developer Platform + + ### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes. - [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes. ### Miro REST API tutorials Check out our how-to articles with step-by-step instructions and code examples so you can: - [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth) ### Miro App Examples Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0. + + The version of the OpenAPI document: v2.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, Field, StrictFloat, StrictInt +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + + +class MindMapNodeGeometry(BaseModel): + """ + Contains width of the item. + """ # noqa: E501 + + width: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="Width of the item, in pixels.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["width"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of MindMapNodeGeometry from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set( + [ + "additional_properties", + ] + ) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of MindMapNodeGeometry from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({"width": obj.get("width")}) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/packages/miro-api-python/miro_api/models/mindmap_create_request.py b/packages/miro-api-python/miro_api/models/mindmap_create_request.py index e1c26df8e..b9745ddb2 100644 --- a/packages/miro-api-python/miro_api/models/mindmap_create_request.py +++ b/packages/miro-api-python/miro_api/models/mindmap_create_request.py @@ -19,7 +19,7 @@ from pydantic import BaseModel from typing import Any, ClassVar, Dict, List, Optional -from miro_api.models.geometry import Geometry +from miro_api.models.mind_map_node_geometry import MindMapNodeGeometry from miro_api.models.mindmap_data_for_create import MindmapDataForCreate from miro_api.models.parent import Parent from miro_api.models.position_change import PositionChange @@ -34,7 +34,7 @@ class MindmapCreateRequest(BaseModel): data: MindmapDataForCreate position: Optional[PositionChange] = None - geometry: Optional[Geometry] = None + geometry: Optional[MindMapNodeGeometry] = None parent: Optional[Parent] = None additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["data", "position", "geometry", "parent"] @@ -113,7 +113,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: { "data": MindmapDataForCreate.from_dict(obj["data"]) if obj.get("data") is not None else None, "position": PositionChange.from_dict(obj["position"]) if obj.get("position") is not None else None, - "geometry": Geometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None, + "geometry": MindMapNodeGeometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None, "parent": Parent.from_dict(obj["parent"]) if obj.get("parent") is not None else None, } ) diff --git a/packages/miro-api-python/miro_api/models/update_frame_item409_response.py b/packages/miro-api-python/miro_api/models/update_frame_item409_response.py new file mode 100644 index 000000000..f77b52d87 --- /dev/null +++ b/packages/miro-api-python/miro_api/models/update_frame_item409_response.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + Miro Developer Platform + + ### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes. - [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes. ### Miro REST API tutorials Check out our how-to articles with step-by-step instructions and code examples so you can: - [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth) ### Miro App Examples Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro's Developer Platform 2.0. + + The version of the OpenAPI document: v2.0 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + + +class UpdateFrameItem409Response(BaseModel): + """ + Test error obj + """ # noqa: E501 + + code: Optional[StrictStr] = Field(default=None, description="Code of the error") + message: Optional[StrictStr] = Field(default=None, description="Description of the error") + status: Optional[StrictInt] = Field(default=None, description="Status code of the error") + type: Optional[StrictStr] = Field(default=None, description="Type of the error") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["code", "message", "status", "type"] + + model_config = { + "populate_by_name": True, + "validate_assignment": True, + "protected_namespaces": (), + } + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateFrameItem409Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set( + [ + "additional_properties", + ] + ) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateFrameItem409Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "code": obj.get("code"), + "message": obj.get("message"), + "status": obj.get("status"), + "type": obj.get("type"), + } + ) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/packages/miro-api-python/miro_api/models/upload_file_from_device_data.py b/packages/miro-api-python/miro_api/models/upload_file_from_device_data.py index 9666c76d5..6db74c2fa 100644 --- a/packages/miro-api-python/miro_api/models/upload_file_from_device_data.py +++ b/packages/miro-api-python/miro_api/models/upload_file_from_device_data.py @@ -32,11 +32,16 @@ class UploadFileFromDeviceData(BaseModel): """ # noqa: E501 title: Optional[StrictStr] = Field(default=None, description="Title for the document.") + alt_text: Optional[StrictStr] = Field( + default=None, + description="A description (alt-text) to help people understand what is depicted here.", + alias="altText", + ) position: Optional[PositionChange] = None geometry: Optional[FixedRatioGeometry] = None parent: Optional[Parent] = None additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["title", "position", "geometry", "parent"] + __properties: ClassVar[List[str]] = ["title", "altText", "position", "geometry", "parent"] model_config = { "populate_by_name": True, @@ -108,6 +113,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "title": obj.get("title"), + "altText": obj.get("altText"), "position": PositionChange.from_dict(obj["position"]) if obj.get("position") is not None else None, "geometry": FixedRatioGeometry.from_dict(obj["geometry"]) if obj.get("geometry") is not None else None, "parent": Parent.from_dict(obj["parent"]) if obj.get("parent") is not None else None, diff --git a/packages/miro-api/.openapi-generator/FILES b/packages/miro-api/.openapi-generator/FILES index aeaa18aa7..918cc02e5 100644 --- a/packages/miro-api/.openapi-generator/FILES +++ b/packages/miro-api/.openapi-generator/FILES @@ -21,7 +21,6 @@ model/auditPage.ts model/auditTeam.ts model/basicError.ts model/basicErrorOrganizationsEnterprisePlan.ts -model/basicErrorTeamsEnterprisePlan.ts model/board.ts model/boardChanges.ts model/boardContentLogData.ts @@ -71,6 +70,7 @@ model/copyBoardChanges.ts model/createBoardExportRequest.ts model/createBoardSubscriptionRequest.ts model/createDocumentItemUsingFileFromDeviceRequestData.ts +model/createFrameItem400Response.ts model/createProjectRequest.ts model/createTeamRequest.ts model/createdBy.ts @@ -146,7 +146,6 @@ model/getAllGroups404Response.ts model/getAllGroups429Response.ts model/getBoardItemContentLogsResponse.ts model/getBoardUserInfoLastOpenedBy.ts -model/getBoards400Response.ts model/getItemsByGroupId200Response.ts model/getItemsByGroupId200ResponseData.ts model/getMetrics200ResponseInner.ts @@ -167,8 +166,6 @@ model/imageItemPlatformFileUpload.ts model/imageUpdateRequest.ts model/imageUrlData.ts model/imageUrlDataChanges.ts -model/imageUrlDataChangesPlatformbulkcreateoperation.ts -model/imageUrlDataPlatformbulkcreateoperation.ts model/invitationError.ts model/invitationResult.ts model/item.ts @@ -190,6 +187,7 @@ model/itemTypeChange.ts model/items.ts model/itemsPage.ts model/itemsPlatformcreateitemsinbulkusingfilefromdevice.ts +model/mindMapNodeGeometry.ts model/mindmapCreateRequest.ts model/mindmapCursorPaged.ts model/mindmapData.ts @@ -304,6 +302,7 @@ model/updateBoardsDataClassificationLabel.ts model/updateBoardsDataClassificationLabelRequest.ts model/updateCardStyle.ts model/updateConnectorStyle.ts +model/updateFrameItem409Response.ts model/updateFrameStyle.ts model/updateProjectMemberRequest.ts model/updateProjectRequest.ts diff --git a/packages/miro-api/api/apis.ts b/packages/miro-api/api/apis.ts index def18212d..22b5344c3 100644 --- a/packages/miro-api/api/apis.ts +++ b/packages/miro-api/api/apis.ts @@ -5,7 +5,6 @@ import FormData = require('form-data') import {AppCardCreateRequest} from '../model/appCardCreateRequest' import {AppCardItem} from '../model/appCardItem' import {AppCardUpdateRequest} from '../model/appCardUpdateRequest' -import {GetBoards400Response} from '../model/getBoards400Response' import {GetMetrics200ResponseInner} from '../model/getMetrics200ResponseInner' import {GetMetrics404Response} from '../model/getMetrics404Response' @@ -67,6 +66,7 @@ import {EmbedCreateRequest} from '../model/embedCreateRequest' import {EmbedItem} from '../model/embedItem' import {EmbedUpdateRequest} from '../model/embedUpdateRequest' +import {CreateFrameItem400Response} from '../model/createFrameItem400Response' import {GenericItem} from '../model/genericItem' import {GenericItemCursorPaged} from '../model/genericItemCursorPaged' import {ShapeCreateRequest} from '../model/shapeCreateRequest' @@ -76,6 +76,7 @@ import {ShapeUpdateRequest} from '../model/shapeUpdateRequest' import {FrameCreateRequest} from '../model/frameCreateRequest' import {FrameItem} from '../model/frameItem' import {FrameUpdateRequest} from '../model/frameUpdateRequest' +import {UpdateFrameItem409Response} from '../model/updateFrameItem409Response' import {GetAllGroups200Response} from '../model/getAllGroups200Response' import {GetAllGroups400Response} from '../model/getAllGroups400Response' @@ -1286,7 +1287,7 @@ export class MiroApi { } /** - * Deletes a board.

Required scope

boards:write

Rate limiting

Level 3
+ * Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.

Required scope

boards:write

Rate limiting

Level 3
* @summary Delete board * @param boardId Unique identifier (ID) of the board that you want to delete. */ diff --git a/packages/miro-api/highlevel/index.ts b/packages/miro-api/highlevel/index.ts index 98ccbd5ad..00eda8ae9 100644 --- a/packages/miro-api/highlevel/index.ts +++ b/packages/miro-api/highlevel/index.ts @@ -723,7 +723,7 @@ export class Board extends BaseBoard { } /** - * Deletes a board.

Required scope

boards:write

Rate limiting

Level 3
+ * Deletes a board. Deleted boards go to Trash (on paid plans) and can be restored via UI within 90 days after deletion.

Required scope

boards:write

Rate limiting

Level 3
* @summary Delete board */ async delete(): Promise { diff --git a/packages/miro-api/model/auditEvent.ts b/packages/miro-api/model/auditEvent.ts index 477e71ea0..a8c50c63f 100644 --- a/packages/miro-api/model/auditEvent.ts +++ b/packages/miro-api/model/auditEvent.ts @@ -34,6 +34,10 @@ export class AuditEvent { * Event type of the audit event */ 'event'?: string + /** + * Event category of the audit event. + */ + 'category'?: string /** @ignore */ static discriminator: string | undefined = undefined @@ -75,6 +79,11 @@ export class AuditEvent { baseName: 'event', type: 'string', }, + { + name: 'category', + baseName: 'category', + type: 'string', + }, ] /** @ignore */ diff --git a/packages/miro-api/model/getBoards400Response.ts b/packages/miro-api/model/createFrameItem400Response.ts similarity index 95% rename from packages/miro-api/model/getBoards400Response.ts rename to packages/miro-api/model/createFrameItem400Response.ts index dcfb6b154..5748c836b 100644 --- a/packages/miro-api/model/getBoards400Response.ts +++ b/packages/miro-api/model/createFrameItem400Response.ts @@ -14,7 +14,7 @@ * @internal * Test error obj */ -export class GetBoards400Response { +export class CreateFrameItem400Response { /** * Code of the error */ @@ -61,6 +61,6 @@ export class GetBoards400Response { /** @ignore */ static getAttributeTypeMap() { - return GetBoards400Response.attributeTypeMap + return CreateFrameItem400Response.attributeTypeMap } } diff --git a/packages/miro-api/model/imageUrlDataPlatformbulkcreateoperation.ts b/packages/miro-api/model/imageUrlDataPlatformbulkcreateoperation.ts deleted file mode 100644 index 3f2fc9fa0..000000000 --- a/packages/miro-api/model/imageUrlDataPlatformbulkcreateoperation.ts +++ /dev/null @@ -1,48 +0,0 @@ -/** - * Miro Developer Platform - * ### Miro Developer Platform concepts - New to the Miro Developer Platform? Interested in learning more about platform concepts?? [Read our introduction page](https://beta.developers.miro.com/docs/introduction) and familiarize yourself with the Miro Developer Platform capabilities in a few minutes. ### Getting started with the Miro REST API - [Quickstart (video):](https://beta.developers.miro.com/docs/try-out-the-rest-api-in-less-than-3-minutes) try the REST API in less than 3 minutes. - [Quickstart (article):](https://beta.developers.miro.com/docs/build-your-first-hello-world-app-1) get started and try the REST API in less than 3 minutes. ### Miro REST API tutorials Check out our how-to articles with step-by-step instructions and code examples so you can: - [Get started with OAuth 2.0 and Miro](https://beta.developers.miro.com/docs/getting-started-with-oauth) ### Miro App Examples Clone our [Miro App Examples repository](https://github.com/miroapp/app-examples) to get inspiration, customize, and explore apps built on top of Miro\'s Developer Platform 2.0. - * - * The version of the OpenAPI document: v2.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * @internal - * Contains information about the image URL. - */ -export class ImageUrlDataPlatformbulkcreateoperation { - /** - * A short text header to identify the image. - */ - 'title'?: string - /** - * URL of the image. - */ - 'url': string = 'https://miro.com/static/images/page/mr-index/localization/en/slider/ideation_brainstorming.png' - - /** @ignore */ - static discriminator: string | undefined = undefined - - /** @ignore */ - static attributeTypeMap: Array<{name: string; baseName: string; type: string}> = [ - { - name: 'title', - baseName: 'title', - type: 'string', - }, - { - name: 'url', - baseName: 'url', - type: 'string', - }, - ] - - /** @ignore */ - static getAttributeTypeMap() { - return ImageUrlDataPlatformbulkcreateoperation.attributeTypeMap - } -} diff --git a/packages/miro-api/model/imageUrlDataChangesPlatformbulkcreateoperation.ts b/packages/miro-api/model/mindMapNodeGeometry.ts similarity index 79% rename from packages/miro-api/model/imageUrlDataChangesPlatformbulkcreateoperation.ts rename to packages/miro-api/model/mindMapNodeGeometry.ts index 99ecb2223..e9cdbafb4 100644 --- a/packages/miro-api/model/imageUrlDataChangesPlatformbulkcreateoperation.ts +++ b/packages/miro-api/model/mindMapNodeGeometry.ts @@ -12,17 +12,13 @@ /** * @internal - * Contains information about the image URL. + * Contains width of the item. */ -export class ImageUrlDataChangesPlatformbulkcreateoperation { +export class MindMapNodeGeometry { /** - * A short text header to identify the image. + * Width of the item, in pixels. */ - 'title'?: string - /** - * URL of the image. - */ - 'url'?: string + 'width'?: number /** @ignore */ static discriminator: string | undefined = undefined @@ -30,19 +26,14 @@ export class ImageUrlDataChangesPlatformbulkcreateoperation { /** @ignore */ static attributeTypeMap: Array<{name: string; baseName: string; type: string}> = [ { - name: 'title', - baseName: 'title', - type: 'string', - }, - { - name: 'url', - baseName: 'url', - type: 'string', + name: 'width', + baseName: 'width', + type: 'number', }, ] /** @ignore */ static getAttributeTypeMap() { - return ImageUrlDataChangesPlatformbulkcreateoperation.attributeTypeMap + return MindMapNodeGeometry.attributeTypeMap } } diff --git a/packages/miro-api/model/mindmapCreateRequest.ts b/packages/miro-api/model/mindmapCreateRequest.ts index bc7259425..a772ae4cb 100644 --- a/packages/miro-api/model/mindmapCreateRequest.ts +++ b/packages/miro-api/model/mindmapCreateRequest.ts @@ -10,7 +10,7 @@ * Do not edit the class manually. */ -import {Geometry} from './geometry' +import {MindMapNodeGeometry} from './mindMapNodeGeometry' import {MindmapDataForCreate} from './mindmapDataForCreate' import {Parent} from './parent' import {PositionChange} from './positionChange' @@ -18,7 +18,7 @@ import {PositionChange} from './positionChange' export class MindmapCreateRequest { 'data': MindmapDataForCreate 'position'?: PositionChange - 'geometry'?: Geometry + 'geometry'?: MindMapNodeGeometry 'parent'?: Parent /** @ignore */ @@ -39,7 +39,7 @@ export class MindmapCreateRequest { { name: 'geometry', baseName: 'geometry', - type: 'Geometry', + type: 'MindMapNodeGeometry', }, { name: 'parent', diff --git a/packages/miro-api/model/models.ts b/packages/miro-api/model/models.ts index 6983b9cc8..9369d4853 100644 --- a/packages/miro-api/model/models.ts +++ b/packages/miro-api/model/models.ts @@ -19,7 +19,6 @@ export * from './auditPage' export * from './auditTeam' export * from './basicError' export * from './basicErrorOrganizationsEnterprisePlan' -export * from './basicErrorTeamsEnterprisePlan' export * from './board' export * from './boardChanges' export * from './boardContentLogData' @@ -69,6 +68,7 @@ export * from './copyBoardChanges' export * from './createBoardExportRequest' export * from './createBoardSubscriptionRequest' export * from './createDocumentItemUsingFileFromDeviceRequestData' +export * from './createFrameItem400Response' export * from './createProjectRequest' export * from './createTeamRequest' export * from './createdBy' @@ -144,7 +144,6 @@ export * from './getAllGroups404Response' export * from './getAllGroups429Response' export * from './getBoardItemContentLogsResponse' export * from './getBoardUserInfoLastOpenedBy' -export * from './getBoards400Response' export * from './getItemsByGroupId200Response' export * from './getItemsByGroupId200ResponseData' export * from './getMetrics200ResponseInner' @@ -165,8 +164,6 @@ export * from './imageItemPlatformFileUpload' export * from './imageUpdateRequest' export * from './imageUrlData' export * from './imageUrlDataChanges' -export * from './imageUrlDataChangesPlatformbulkcreateoperation' -export * from './imageUrlDataPlatformbulkcreateoperation' export * from './invitationError' export * from './invitationResult' export * from './item' @@ -188,6 +185,7 @@ export * from './itemTypeChange' export * from './items' export * from './itemsPage' export * from './itemsPlatformcreateitemsinbulkusingfilefromdevice' +export * from './mindMapNodeGeometry' export * from './mindmapCreateRequest' export * from './mindmapCursorPaged' export * from './mindmapData' @@ -301,6 +299,7 @@ export * from './updateBoardsDataClassificationLabel' export * from './updateBoardsDataClassificationLabelRequest' export * from './updateCardStyle' export * from './updateConnectorStyle' +export * from './updateFrameItem409Response' export * from './updateFrameStyle' export * from './updateProjectMemberRequest' export * from './updateProjectRequest' @@ -353,7 +352,6 @@ import {AuditPage} from './auditPage' import {AuditTeam} from './auditTeam' import {BasicError} from './basicError' import {BasicErrorOrganizationsEnterprisePlan} from './basicErrorOrganizationsEnterprisePlan' -import {BasicErrorTeamsEnterprisePlan} from './basicErrorTeamsEnterprisePlan' import {Board} from './board' import {BoardChanges} from './boardChanges' import {BoardContentLogData} from './boardContentLogData' @@ -403,6 +401,7 @@ import {CopyBoardChanges} from './copyBoardChanges' import {CreateBoardExportRequest} from './createBoardExportRequest' import {CreateBoardSubscriptionRequest} from './createBoardSubscriptionRequest' import {CreateDocumentItemUsingFileFromDeviceRequestData} from './createDocumentItemUsingFileFromDeviceRequestData' +import {CreateFrameItem400Response} from './createFrameItem400Response' import {CreateProjectRequest} from './createProjectRequest' import {CreateTeamRequest} from './createTeamRequest' import {CreatedBy} from './createdBy' @@ -478,7 +477,6 @@ import {GetAllGroups404Response} from './getAllGroups404Response' import {GetAllGroups429Response} from './getAllGroups429Response' import {GetBoardItemContentLogsResponse} from './getBoardItemContentLogsResponse' import {GetBoardUserInfoLastOpenedBy} from './getBoardUserInfoLastOpenedBy' -import {GetBoards400Response} from './getBoards400Response' import {GetItemsByGroupId200Response} from './getItemsByGroupId200Response' import {GetItemsByGroupId200ResponseData} from './getItemsByGroupId200ResponseData' import {GetMetrics200ResponseInner} from './getMetrics200ResponseInner' @@ -499,8 +497,6 @@ import {ImageItemPlatformFileUpload} from './imageItemPlatformFileUpload' import {ImageUpdateRequest} from './imageUpdateRequest' import {ImageUrlData} from './imageUrlData' import {ImageUrlDataChanges} from './imageUrlDataChanges' -import {ImageUrlDataChangesPlatformbulkcreateoperation} from './imageUrlDataChangesPlatformbulkcreateoperation' -import {ImageUrlDataPlatformbulkcreateoperation} from './imageUrlDataPlatformbulkcreateoperation' import {InvitationError} from './invitationError' import {InvitationResult} from './invitationResult' import {Item} from './item' @@ -522,6 +518,7 @@ import {ItemTypeChange} from './itemTypeChange' import {Items} from './items' import {ItemsPage} from './itemsPage' import {ItemsPlatformcreateitemsinbulkusingfilefromdevice} from './itemsPlatformcreateitemsinbulkusingfilefromdevice' +import {MindMapNodeGeometry} from './mindMapNodeGeometry' import {MindmapCreateRequest} from './mindmapCreateRequest' import {MindmapCursorPaged} from './mindmapCursorPaged' import {MindmapData} from './mindmapData' @@ -635,6 +632,7 @@ import {UpdateBoardsDataClassificationLabel} from './updateBoardsDataClassificat import {UpdateBoardsDataClassificationLabelRequest} from './updateBoardsDataClassificationLabelRequest' import {UpdateCardStyle} from './updateCardStyle' import {UpdateConnectorStyle} from './updateConnectorStyle' +import {UpdateFrameItem409Response} from './updateFrameItem409Response' import {UpdateFrameStyle} from './updateFrameStyle' import {UpdateProjectMemberRequest} from './updateProjectMemberRequest' import {UpdateProjectRequest} from './updateProjectRequest' @@ -889,7 +887,6 @@ let typeMap: {[index: string]: any} = { AuditTeam: AuditTeam, BasicError: BasicError, BasicErrorOrganizationsEnterprisePlan: BasicErrorOrganizationsEnterprisePlan, - BasicErrorTeamsEnterprisePlan: BasicErrorTeamsEnterprisePlan, Board: Board, BoardChanges: BoardChanges, BoardContentLogData: BoardContentLogData, @@ -939,6 +936,7 @@ let typeMap: {[index: string]: any} = { CreateBoardExportRequest: CreateBoardExportRequest, CreateBoardSubscriptionRequest: CreateBoardSubscriptionRequest, CreateDocumentItemUsingFileFromDeviceRequestData: CreateDocumentItemUsingFileFromDeviceRequestData, + CreateFrameItem400Response: CreateFrameItem400Response, CreateProjectRequest: CreateProjectRequest, CreateTeamRequest: CreateTeamRequest, CreatedBy: CreatedBy, @@ -1016,7 +1014,6 @@ let typeMap: {[index: string]: any} = { GetAllGroups429Response: GetAllGroups429Response, GetBoardItemContentLogsResponse: GetBoardItemContentLogsResponse, GetBoardUserInfoLastOpenedBy: GetBoardUserInfoLastOpenedBy, - GetBoards400Response: GetBoards400Response, GetItemsByGroupId200Response: GetItemsByGroupId200Response, GetItemsByGroupId200ResponseData: GetItemsByGroupId200ResponseData, GetMetrics200ResponseInner: GetMetrics200ResponseInner, @@ -1038,8 +1035,6 @@ let typeMap: {[index: string]: any} = { ImageUpdateRequest: ImageUpdateRequest, ImageUrlData: ImageUrlData, ImageUrlDataChanges: ImageUrlDataChanges, - ImageUrlDataChangesPlatformbulkcreateoperation: ImageUrlDataChangesPlatformbulkcreateoperation, - ImageUrlDataPlatformbulkcreateoperation: ImageUrlDataPlatformbulkcreateoperation, InvitationError: InvitationError, InvitationResult: InvitationResult, Item: Item, @@ -1060,6 +1055,7 @@ let typeMap: {[index: string]: any} = { Items: Items, ItemsPage: ItemsPage, ItemsPlatformcreateitemsinbulkusingfilefromdevice: ItemsPlatformcreateitemsinbulkusingfilefromdevice, + MindMapNodeGeometry: MindMapNodeGeometry, MindmapCreateRequest: MindmapCreateRequest, MindmapCursorPaged: MindmapCursorPaged, MindmapData: MindmapData, @@ -1173,6 +1169,7 @@ let typeMap: {[index: string]: any} = { UpdateBoardsDataClassificationLabelRequest: UpdateBoardsDataClassificationLabelRequest, UpdateCardStyle: UpdateCardStyle, UpdateConnectorStyle: UpdateConnectorStyle, + UpdateFrameItem409Response: UpdateFrameItem409Response, UpdateFrameStyle: UpdateFrameStyle, UpdateProjectMemberRequest: UpdateProjectMemberRequest, UpdateProjectRequest: UpdateProjectRequest, diff --git a/packages/miro-api/model/basicErrorTeamsEnterprisePlan.ts b/packages/miro-api/model/updateFrameItem409Response.ts similarity index 89% rename from packages/miro-api/model/basicErrorTeamsEnterprisePlan.ts rename to packages/miro-api/model/updateFrameItem409Response.ts index 17d0ee5f4..aa360ba9c 100644 --- a/packages/miro-api/model/basicErrorTeamsEnterprisePlan.ts +++ b/packages/miro-api/model/updateFrameItem409Response.ts @@ -10,34 +10,33 @@ * Do not edit the class manually. */ -export class BasicErrorTeamsEnterprisePlan { - /** - * HTTP status code. - */ - 'status'?: number +/** + * @internal + * Test error obj + */ +export class UpdateFrameItem409Response { /** - * Description of the status code. + * Code of the error */ 'code'?: string /** - * Explanation for the error + * Description of the error */ 'message'?: string /** - * Type of the object returned. + * Status code of the error */ - 'type'?: string = 'error' + 'status'?: number + /** + * Type of the error + */ + 'type'?: string /** @ignore */ static discriminator: string | undefined = undefined /** @ignore */ static attributeTypeMap: Array<{name: string; baseName: string; type: string}> = [ - { - name: 'status', - baseName: 'status', - type: 'number', - }, { name: 'code', baseName: 'code', @@ -48,6 +47,11 @@ export class BasicErrorTeamsEnterprisePlan { baseName: 'message', type: 'string', }, + { + name: 'status', + baseName: 'status', + type: 'number', + }, { name: 'type', baseName: 'type', @@ -57,6 +61,6 @@ export class BasicErrorTeamsEnterprisePlan { /** @ignore */ static getAttributeTypeMap() { - return BasicErrorTeamsEnterprisePlan.attributeTypeMap + return UpdateFrameItem409Response.attributeTypeMap } } diff --git a/packages/miro-api/model/uploadFileFromDeviceData.ts b/packages/miro-api/model/uploadFileFromDeviceData.ts index 53000a9e7..2199d3247 100644 --- a/packages/miro-api/model/uploadFileFromDeviceData.ts +++ b/packages/miro-api/model/uploadFileFromDeviceData.ts @@ -19,6 +19,10 @@ export class UploadFileFromDeviceData { * Title for the document. */ 'title'?: string + /** + * A description (alt-text) to help people understand what is depicted here. + */ + 'altText'?: string 'position'?: PositionChange 'geometry'?: FixedRatioGeometry 'parent'?: Parent @@ -33,6 +37,11 @@ export class UploadFileFromDeviceData { baseName: 'title', type: 'string', }, + { + name: 'altText', + baseName: 'altText', + type: 'string', + }, { name: 'position', baseName: 'position',