{ "openapi": "3.0.0", "info": { "title": "Proofsign API", "description": "API oficial do proofsign para manipulação de documentos, contas, solicitações de assinatura e integração com software/ERP.\n\n## Autenticação\n\nPara acessar recursos protegidos da API, é necessário utilizar um **Bearer Token** no cabeçalho das requisições.\n\n**Como obter o Bearer Token:**\n1. Acesse o site https://app.proofsign.com.br\n2. Vá em **Ajustes**\n3. Selecione **Configurações** e depois **Integração via API**\n4. Gere um novo token e copie-o para uso nas requisições\n\n**Como usar o Bearer Token:**\nAdicione-o no cabeçalho **Authorization** em todas as requisições no formato:\n`Authorization: Bearer {seu_token_aqui}`", "version": "1.4", "contact": { "name": "proofsign", "url": "https://proofsign.com.br" } }, "servers": [ { "url": "https://app.proofsign.com.br/api/v1", "description": "Servidor de produção" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Token de autenticação obtido em Ajustes > Configurações > Integração via API" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string", "description": "Mensagem de erro" }, "message": { "type": "string", "description": "Detalhes do erro" } } }, "Success": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/folders": { "post": { "tags": [ "Folders" ], "summary": "Cria uma nova pasta no sistema", "description": "Cria uma nova pasta no sistema", "operationId": "post_create_folder_2", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "get": { "tags": [ "Folders" ], "summary": "Lista todas as pastas disponíveis", "description": "Lista todas as pastas disponíveis", "operationId": "get_all_folders", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] } }, "/folders/{id}": { "get": { "tags": [ "Folders" ], "summary": "Obtém informações de uma pasta específica", "description": "Obtém informações de uma pasta específica", "operationId": "get_single_folder", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "put": { "tags": [ "Folders" ], "summary": "Atualiza informações de uma pasta", "description": "Atualiza informações de uma pasta", "operationId": "put_update_folder", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "delete": { "tags": [ "Folders" ], "summary": "Remove uma pasta do sistema", "description": "Remove uma pasta do sistema", "operationId": "delete_folder", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/files": { "get": { "tags": [ "Files" ], "summary": "Lista todos os arquivos disponíveis", "description": "Lista todos os arquivos disponíveis", "operationId": "get_all_files", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] } }, "/files/{id}": { "delete": { "tags": [ "Files" ], "summary": "Remove um arquivo do sistema", "description": "Remove um arquivo do sistema", "operationId": "delete_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "put": { "tags": [ "Files" ], "summary": "Atualiza informações de um arquivo", "description": "Atualiza informações de um arquivo", "operationId": "put_update_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/{id}/duplicate": { "post": { "tags": [ "Files" ], "summary": "Duplica um arquivo existente", "description": "Duplica um arquivo existente", "operationId": "post_duplicate_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/{id}/protect": { "post": { "tags": [ "Files" ], "summary": "Protege um arquivo com senha", "description": "Protege um arquivo com senha", "operationId": "post_protect_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/{id}/sign": { "post": { "tags": [ "Files" ], "summary": "Assina um arquivo", "description": "Assina um arquivo", "operationId": "post_sign_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/sign-multiple": { "post": { "tags": [ "Files" ], "summary": "Assina múltiplos arquivos", "description": "Assina múltiplos arquivos", "operationId": "post_sign_multiple_files", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "signatures": [ { "document_key": "etZtPbRpdvSa3undhLnSr2r7TTByoqth", "xPos": 100, "yPos": 30, "page": 1, "user_id": 5 }, { "document_key": "pknyNUsQoK3tSXrKibIFxwHV9jL84PJH", "xPos": 100, "yPos": 200, "rubric": 1 } ] } } } } } }, "/files/send": { "post": { "tags": [ "Files" ], "summary": "Envia um documento para assinatura", "description": "Envia um documento para assinatura", "operationId": "post_send_document", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/upload": { "post": { "tags": [ "Files" ], "summary": "Faz upload de um arquivo", "description": "Faz upload de um arquivo", "operationId": "post_upload_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/upload-and-send": { "post": { "tags": [ "Files" ], "summary": "Faz upload e envia para assinatura", "description": "Faz upload e envia para assinatura", "operationId": "post_upload_and_send_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/upload-template": { "post": { "tags": [ "Files" ], "summary": "Faz upload de um template", "description": "Faz upload de um template", "operationId": "post_upload_template", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/files/{id}/download": { "get": { "tags": [ "Files" ], "summary": "Baixa um arquivo", "description": "Baixa um arquivo", "operationId": "get_file_download", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/files/{id}/report": { "get": { "tags": [ "Files" ], "summary": "Obtém relatório de um arquivo", "description": "Obtém relatório de um arquivo", "operationId": "get_file_report", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/requests": { "get": { "tags": [ "Requests" ], "summary": "Lista todas as solicitações de assinatura", "description": "Lista todas as solicitações de assinatura", "operationId": "get_all_requests", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] } }, "/requests/{id}/change-signer": { "put": { "tags": [ "Requests" ], "summary": "Altera o signatário de uma solicitação", "description": "Altera o signatário de uma solicitação", "operationId": "put_change_request_signer", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/requests/{id}/doubleauth": { "put": { "tags": [ "Requests" ], "summary": "Atualiza autenticação dupla de uma solicitação", "description": "Atualiza autenticação dupla de uma solicitação", "operationId": "put_update_doubleauth", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/requests/{id}": { "get": { "tags": [ "Requests" ], "summary": "Obtém informações de uma solicitação específica", "description": "Obtém informações de uma solicitação específica", "operationId": "get_single_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/requests/send-with-template": { "post": { "tags": [ "Requests" ], "summary": "Envia solicitação usando template", "description": "Envia solicitação usando template", "operationId": "post_send_request_2", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": { "page": 1, "type": "signature", "width": 200, "height": 75, "xPos": -999, "yPos": -999 } } } } } }, "/requests/send-with-document": { "post": { "tags": [ "Requests" ], "summary": "Envia solicitação com documento", "description": "Envia solicitação com documento", "operationId": "post_send_request_with_document_copy", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/requests/{id}/cancel": { "post": { "tags": [ "Requests" ], "summary": "Cancela uma solicitação", "description": "Cancela uma solicitação", "operationId": "post_cancel_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/requests/{id}/sign": { "post": { "tags": [ "Requests" ], "summary": "Assina uma solicitação", "description": "Assina uma solicitação", "operationId": "post_sign_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/requests/{id}/emails": { "get": { "tags": [ "Requests" ], "summary": "Lista todos os emails enviados de uma solicitação", "description": "Lista todos os emails enviados de uma solicitação", "operationId": "get_all_emails_sent", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] } }, "/requests/{id}/emails/{emailId}": { "get": { "tags": [ "Requests" ], "summary": "Obtém informações de um email enviado", "description": "Obtém informações de um email enviado", "operationId": "get_single_email_sent", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" }, { "name": "emailId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do emailId" } ] } }, "/requests/{id}/whatsapp": { "get": { "tags": [ "Requests" ], "summary": "Lista todas as mensagens WhatsApp enviadas", "description": "Lista todas as mensagens WhatsApp enviadas", "operationId": "get_all_whatsapp_messages_sent", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] } }, "/requests/{id}/whatsapp/{messageId}": { "get": { "tags": [ "Requests" ], "summary": "Obtém informações de uma mensagem WhatsApp", "description": "Obtém informações de uma mensagem WhatsApp", "operationId": "get_single_whatsapp_message_sent", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do messageId" } ] } }, "/files/{id}/history/legacy": { "get": { "tags": [ "History" ], "summary": "Obtém histórico legado de um arquivo", "description": "Obtém histórico legado de um arquivo", "operationId": "get_file_legacy_history", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/files/{id}/history": { "get": { "tags": [ "History" ], "summary": "Obtém histórico de um arquivo", "description": "Obtém histórico de um arquivo", "operationId": "get_file_history", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/reminders/whatsapp": { "post": { "tags": [ "Reminders" ], "summary": "Cria lembrete via WhatsApp", "description": "Cria lembrete via WhatsApp", "operationId": "post_create_reminder_with_whatsapp", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/reminders/email": { "post": { "tags": [ "Reminders" ], "summary": "Cria lembrete via email", "description": "Cria lembrete via email", "operationId": "post_create_reminder_with_e_mail", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/reminders/status": { "post": { "tags": [ "Reminders" ], "summary": "Obtém status dos lembretes", "description": "Obtém status dos lembretes", "operationId": "post_reminders_status", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/automated-reminders": { "get": { "tags": [ "Reminders" ], "summary": "Lista todos os lembretes automatizados", "description": "Lista todos os lembretes automatizados", "operationId": "get_all_automated_reminders", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Reminders" ], "summary": "Cria lembrete automatizado", "description": "Cria lembrete automatizado", "operationId": "post_create_automated_reminders", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/automated-reminders/{id}": { "put": { "tags": [ "Reminders" ], "summary": "Atualiza lembrete automatizado", "description": "Atualiza lembrete automatizado", "operationId": "put_update_automated_reminders", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "delete": { "tags": [ "Reminders" ], "summary": "Remove lembrete automatizado", "description": "Remove lembrete automatizado", "operationId": "delete_automated_reminders", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/companies": { "get": { "tags": [ "Companies" ], "summary": "Lista todas as empresas", "description": "Lista todas as empresas", "operationId": "get_all_companies", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Companies" ], "summary": "Cria uma nova empresa", "description": "Cria uma nova empresa", "operationId": "post_create_company", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/companies/{id}": { "get": { "tags": [ "Companies" ], "summary": "Obtém informações de uma empresa", "description": "Obtém informações de uma empresa", "operationId": "get_single_company", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "post": { "tags": [ "Companies" ], "summary": "Atualiza informações de uma empresa", "description": "Atualiza informações de uma empresa", "operationId": "post_update_company", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/companies/{id}/custom-limit": { "post": { "tags": [ "Companies" ], "summary": "Cria limite customizado para empresa", "description": "Cria limite customizado para empresa", "operationId": "post_create_company_custom_limit", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/companies/{id}/signed-files-amount": { "get": { "tags": [ "Companies" ], "summary": "Obtém quantidade de arquivos assinados", "description": "Obtém quantidade de arquivos assinados", "operationId": "get_company_signed_files_amount", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/companies/{id}/resellers-signed-files-amount": { "get": { "tags": [ "Companies" ], "summary": "Obtém quantidade de arquivos assinados por revendedores", "description": "Obtém quantidade de arquivos assinados por revendedores", "operationId": "get_company_resellers_signed_files_amount", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/companies/{id}/files-amount": { "get": { "tags": [ "Companies" ], "summary": "Obtém quantidade total de arquivos", "description": "Obtém quantidade total de arquivos", "operationId": "get_company_files_amount", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/companies/{id}/usage": { "get": { "tags": [ "Companies" ], "summary": "Obtém uso da empresa", "description": "Obtém uso da empresa", "operationId": "get_company_usage", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/companies/{id}/smtp": { "post": { "tags": [ "Companies" ], "summary": "Atualiza configurações SMTP da empresa", "description": "Atualiza configurações SMTP da empresa", "operationId": "post_update_company_smtp", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/companies/{id}/whatsapp": { "post": { "tags": [ "Companies" ], "summary": "Atualiza configurações WhatsApp da empresa", "description": "Atualiza configurações WhatsApp da empresa", "operationId": "post_update_company_whatsapp", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/companies/{id}/tokens": { "post": { "tags": [ "Companies" ], "summary": "Cria token para empresa", "description": "Cria token para empresa", "operationId": "post_criar_token_para_empresa", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/tokens/{id}": { "put": { "tags": [ "Companies" ], "summary": "Atualiza token", "description": "Atualiza token", "operationId": "put_update_token", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/customers": { "get": { "tags": [ "Customers" ], "summary": "Lista todos os clientes", "description": "Lista todos os clientes", "operationId": "get_all_customers", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Customers" ], "summary": "Cria um novo cliente", "description": "Cria um novo cliente", "operationId": "post_create_customer", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/customers/{id}": { "delete": { "tags": [ "Customers" ], "summary": "Remove um cliente", "description": "Remove um cliente", "operationId": "delete_customer", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "get": { "tags": [ "Customers" ], "summary": "Obtém informações de um cliente", "description": "Obtém informações de um cliente", "operationId": "get_single_customer", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "post": { "tags": [ "Customers" ], "summary": "Atualiza informações de um cliente", "description": "Atualiza informações de um cliente", "operationId": "post_update_customer", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/team": { "get": { "tags": [ "Team" ], "summary": "Lista todos os membros da equipe", "description": "Lista todos os membros da equipe", "operationId": "get_all_teams", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Team" ], "summary": "Adiciona usuário à equipe", "description": "Adiciona usuário à equipe", "operationId": "post_create_team_user", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/team/{id}": { "delete": { "tags": [ "Team" ], "summary": "Remove usuário da equipe", "description": "Remove usuário da equipe", "operationId": "delete_team_user", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "get": { "tags": [ "Team" ], "summary": "Obtém informações de um usuário da equipe", "description": "Obtém informações de um usuário da equipe", "operationId": "get_single_team_user", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "post": { "tags": [ "Team" ], "summary": "Atualiza informações de um usuário", "description": "Atualiza informações de um usuário", "operationId": "post_update_team_user", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/team/{id}/certificate": { "delete": { "tags": [ "Team" ], "summary": "Remove certificado de um usuário", "description": "Remove certificado de um usuário", "operationId": "delete_user_certificate", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/team/{id}/signature": { "post": { "tags": [ "Team" ], "summary": "Atualiza arquivo de assinatura do usuário", "description": "Atualiza arquivo de assinatura do usuário", "operationId": "post_update_user_signature_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/departments": { "get": { "tags": [ "Departments" ], "summary": "Lista todos os departamentos", "description": "Lista todos os departamentos", "operationId": "get_all_departments", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Departments" ], "summary": "Cria um novo departamento", "description": "Cria um novo departamento", "operationId": "post_create_department", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/departments/{id}/users": { "get": { "tags": [ "Departments" ], "summary": "Lista usuários de um departamento", "description": "Lista usuários de um departamento", "operationId": "get_all_users_from_department", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Departments" ], "summary": "Adiciona usuário a um departamento", "description": "Adiciona usuário a um departamento", "operationId": "post_insert_user_on_a_department", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/departments/{id}": { "delete": { "tags": [ "Departments" ], "summary": "Remove um departamento", "description": "Remove um departamento", "operationId": "delete_department", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/departments/{id}/users/{userId}": { "delete": { "tags": [ "Departments" ], "summary": "Remove usuário de um departamento", "description": "Remove usuário de um departamento", "operationId": "delete_users_from_department", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do userId" } ] } }, "/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Lista todos os webhooks", "description": "Lista todos os webhooks", "operationId": "get_all_webhooks", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Webhooks" ], "summary": "Cria um novo webhook", "description": "Cria um novo webhook", "operationId": "post_webhook", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/webhooks/{id}": { "put": { "tags": [ "Webhooks" ], "summary": "Atualiza um webhook", "description": "Atualiza um webhook", "operationId": "put_update_webhook", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Remove um webhook", "description": "Remove um webhook", "operationId": "delete_webhook", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/webhooks/{id}/notifications": { "get": { "tags": [ "Webhooks" ], "summary": "Lista notificações de um webhook", "description": "Lista notificações de um webhook", "operationId": "get_webhooks_notifications", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/webhooks/{id}/headers": { "put": { "tags": [ "Webhooks" ], "summary": "Atualiza headers de um webhook", "description": "Atualiza headers de um webhook", "operationId": "put_update_webhook_headers", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/tags/attach": { "post": { "tags": [ "Tags" ], "summary": "Anexa tag a um arquivo", "description": "Anexa tag a um arquivo", "operationId": "post_attach_tag_with_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/tags/{id}/detach": { "delete": { "tags": [ "Tags" ], "summary": "Remove tag de um arquivo", "description": "Remove tag de um arquivo", "operationId": "delete_remove_tag_from_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/files/{id}/tags": { "get": { "tags": [ "Tags" ], "summary": "Lista tags de um arquivo", "description": "Lista tags de um arquivo", "operationId": "get_file_tags", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/tags": { "get": { "tags": [ "Tags" ], "summary": "Lista todas as tags", "description": "Lista todas as tags", "operationId": "get_all_tags", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Tags" ], "summary": "Cria uma nova tag", "description": "Cria uma nova tag", "operationId": "post_create_tag", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/tags/{id}": { "get": { "tags": [ "Tags" ], "summary": "Obtém informações de uma tag", "description": "Obtém informações de uma tag", "operationId": "get_single_tag", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "put": { "tags": [ "Tags" ], "summary": "Atualiza uma tag", "description": "Atualiza uma tag", "operationId": "put_update_tag", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "delete": { "tags": [ "Tags" ], "summary": "Remove uma tag", "description": "Remove uma tag", "operationId": "delete_tag", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/tags/{id}/link": { "post": { "tags": [ "Tags" ], "summary": "Vincula tag a um arquivo", "description": "Vincula tag a um arquivo", "operationId": "post_link_tag_with_file", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/tags/{id}/files": { "get": { "tags": [ "Tags" ], "summary": "Lista arquivos vinculados a uma tag", "description": "Lista arquivos vinculados a uma tag", "operationId": "get_files_linked_with_tag", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/templates/tags": { "get": { "tags": [ "Templates" ], "summary": "Lista tags de template", "description": "Lista tags de template", "operationId": "get_template_tags", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/templates/send-request": { "post": { "tags": [ "Templates" ], "summary": "Envia solicitação com template de documento", "description": "Envia solicitação com template de documento", "operationId": "post_send_request_with_document_copy_1", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/logs": { "get": { "tags": [ "Logs" ], "summary": "Obtém logs do sistema", "description": "Obtém logs do sistema", "operationId": "get_logs", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/lotes": { "post": { "tags": [ "Lotes" ], "summary": "Cria um novo lote", "description": "Cria um novo lote", "operationId": "post_create_lote", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "get": { "tags": [ "Lotes" ], "summary": "Lista todos os lotes", "description": "Lista todos os lotes", "operationId": "get_all_lotes", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] } }, "/lotes/{id}": { "get": { "tags": [ "Lotes" ], "summary": "Obtém informações de um lote", "description": "Obtém informações de um lote", "operationId": "get_single_lote", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "put": { "tags": [ "Lotes" ], "summary": "Atualiza um lote", "description": "Atualiza um lote", "operationId": "put_update_lote", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } }, "delete": { "tags": [ "Lotes" ], "summary": "Remove um lote", "description": "Remove um lote", "operationId": "delete_lote", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/lotes/{id}/download": { "get": { "tags": [ "Lotes" ], "summary": "Baixa um lote", "description": "Baixa um lote", "operationId": "get_download_lote", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/lotes/{id}/send-requests": { "post": { "tags": [ "Lotes" ], "summary": "Envia solicitações de um lote", "description": "Envia solicitações de um lote", "operationId": "post_send_lote_requests", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/lotes/requests/{id}": { "get": { "tags": [ "Lotes" ], "summary": "Obtém informações de uma solicitação de lote", "description": "Obtém informações de uma solicitação de lote", "operationId": "get_single_lote_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "delete": { "tags": [ "Lotes" ], "summary": "Remove solicitação de lote", "description": "Remove solicitação de lote", "operationId": "delete_lote_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] } }, "/lotes/requests/{id}/cancel": { "post": { "tags": [ "Lotes" ], "summary": "Cancela solicitação de lote", "description": "Cancela solicitação de lote", "operationId": "post_cancel_lote_request", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/lotes/requests/{id}/reminder": { "post": { "tags": [ "Lotes" ], "summary": "Cria lembrete para solicitação de lote", "description": "Cria lembrete para solicitação de lote", "operationId": "post_create_lote_request_reminder_with_e_mail", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/lotes/requests/{id}/change-signer": { "put": { "tags": [ "Lotes" ], "summary": "Altera signatário de solicitação de lote", "description": "Altera signatário de solicitação de lote", "operationId": "put_change_lote_request_signer", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/signature-types": { "get": { "tags": [ "Signature Types" ], "summary": "Lista todos os tipos de assinatura", "description": "Lista todos os tipos de assinatura", "operationId": "get_all_signature_types", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1 }, "description": "Número da página" }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 }, "description": "Itens por página" } ] }, "post": { "tags": [ "Signature Types" ], "summary": "Cria um novo tipo de assinatura", "description": "Cria um novo tipo de assinatura", "operationId": "post_create_signature_type", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } }, "/signature-types/{id}": { "get": { "tags": [ "Signature Types" ], "summary": "Obtém informações de um tipo de assinatura", "description": "Obtém informações de um tipo de assinatura", "operationId": "get_single_signature_type", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ] }, "put": { "tags": [ "Signature Types" ], "summary": "Atualiza um tipo de assinatura", "description": "Atualiza um tipo de assinatura", "operationId": "put_update_signature_type", "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Não autorizado - Token inválido ou ausente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "400": { "description": "Requisição inválida", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Recurso não encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ID do id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "example": {} } } } } } } }