{ "openapi": "3.0.0", "info": { "title": "Domyna SaaS API", "description": "API Multi-Tenant Domyna", "version": "1.0.0" }, "servers": [ { "url": "https://domyna.com.br", "description": "Servidor Produção" }, { "url": "http://127.0.0.1:8000", "description": "Servidor Local" } ], "paths": { "/api/v1/account": { "get": { "tags": [ "Account" ], "summary": "Retorna a account do usuário autenticado", "operationId": "1d690ab1718fd920cea76ead06ad4b23", "responses": { "200": { "description": "Account retornada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Não autenticado" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Account" ], "summary": "Atualiza a account do usuário autenticado", "operationId": "f06fd841cdd7f81cfc29d5ef0f3c639e", "requestBody": { "required": true }, "responses": { "200": { "description": "Account atualizada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "422": { "description": "Erro de validação" }, "401": { "description": "Não autenticado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/audits": { "get": { "tags": [ "Audits" ], "summary": "Listar logs de auditoria", "operationId": "3aff79d590014a2ee3de5b2b80195651", "parameters": [ { "name": "start_date", "in": "query", "schema": { "type": "string", "format": "date", "example": "2026-01-01" } }, { "name": "end_date", "in": "query", "schema": { "type": "string", "format": "date", "example": "2026-01-31" } }, { "name": "search", "in": "query", "description": "Busca por usuário ou evento", "schema": { "type": "string", "example": "created" } } ], "responses": { "200": { "description": "Lista paginada de logs", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Audits" ], "summary": "Registrar log manual", "operationId": "0c638502fbfa31e4381379d84e215f29", "responses": { "201": { "description": "Log registrado com sucesso", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Log registrado com sucesso" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/audits/{id}": { "get": { "tags": [ "Audits" ], "summary": "Detalhar log de auditoria", "operationId": "a7a71b78fe0f414ea132222e1da10965", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do log", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audit" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/login": { "post": { "tags": [ "Auth" ], "summary": "Autenticar usuário", "operationId": "816cfee131a312945216854ddf45f975", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "type": "string", "example": "admin@email.com" }, "password": { "type": "string", "example": "123456" } }, "type": "object" } } } }, "responses": { "200": { "description": "Login realizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "401": { "description": "Credenciais inválidas" } } } }, "/api/v1/logout": { "post": { "tags": [ "Auth" ], "summary": "Logout do usuário", "operationId": "9df0c0aa12be084a5d478e548a5a508c", "responses": { "200": { "description": "Logout realizado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/birthday-message": { "get": { "tags": [ "BirthdayMessage" ], "summary": "Obter mensagem de aniversário", "operationId": "1bfad6eef3d92c528c2a0cb0e224fe76", "responses": { "200": { "description": "Mensagem retornada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BirthdayMessage" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "BirthdayMessage" ], "summary": "Atualizar mensagem de aniversário", "operationId": "b0180bf50cfd15e96e855b5814c7c64c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BirthdayMessage" } } } }, "responses": { "200": { "description": "Atualizado com sucesso", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Mensagem de aniversário atualizada com sucesso" }, "birthday_message": { "type": "string", "example": "Parabéns! Muitas felicidades!" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/clients": { "get": { "tags": [ "Clients" ], "summary": "Listar clientes", "operationId": "136d19f4fdca1f9e48fe1bd81f616aec", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "example": "João" } }, { "name": "trashed", "in": "query", "description": "only | with", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de clientes", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Clients" ], "summary": "Criar cliente", "operationId": "608db725709f8311275d9bf7ea3e9947", "responses": { "201": { "description": "Cliente criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/clients/{id}": { "get": { "tags": [ "Clients" ], "summary": "Detalhar cliente", "operationId": "c20d86111e38da0137085e954783c706", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do cliente", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Clients" ], "summary": "Atualizar cliente", "operationId": "a890b301efb9f59db9083012d8223413", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cliente atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Clients" ], "summary": "Enviar cliente para lixeira", "operationId": "3852fc92baacbead222c0fd0d3bf6cb7", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cliente enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/clients/{id}/restore": { "patch": { "tags": [ "Clients" ], "summary": "Restaurar cliente", "operationId": "a39be7602fb55e32354f9030a0cf744b", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cliente restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/clients/{id}/force": { "delete": { "tags": [ "Clients" ], "summary": "Remover cliente permanentemente", "operationId": "3ccb98261dd569e8c13d4968c3612f03", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cliente removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/client-groups": { "get": { "tags": [ "ClientGroups" ], "summary": "Listar grupos de clientes", "operationId": "eaf2ad12987d1ca20b773a1dad74702c", "parameters": [ { "name": "trashed", "in": "query", "description": "only (somente lixeira) | with (inclui deletados)", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de grupos", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientGroup" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "ClientGroups" ], "summary": "Criar grupo de cliente", "operationId": "cc8fd00993f04743f68ccf86d43812ca", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "status" ], "properties": { "name": { "type": "string", "example": "VIP" }, "description": { "type": "string", "example": "Clientes importantes" }, "status": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Grupo criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientGroup" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/client-groups/{id}": { "get": { "tags": [ "ClientGroups" ], "summary": "Detalhar grupo", "operationId": "1de863c64867d1737e62d2ed1654947d", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do grupo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientGroup" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "ClientGroups" ], "summary": "Atualizar grupo", "operationId": "fb68b4f0b12ccd5ca72b59991b09f07a", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "VIP Atualizado" }, "description": { "type": "string" }, "status": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Grupo atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientGroup" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "ClientGroups" ], "summary": "Enviar grupo para lixeira", "operationId": "c4c20cb7ab3fe0d78ddca4c65d753f6a", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Grupo enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/client-groups/{id}/restore": { "patch": { "tags": [ "ClientGroups" ], "summary": "Restaurar grupo", "operationId": "8baee10775cd5957b87cd70b74960d37", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Grupo restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/client-groups/{id}/force": { "delete": { "tags": [ "ClientGroups" ], "summary": "Remover grupo permanentemente", "operationId": "74f3eb5bbf5d3a4cf59865920e5bdacc", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Grupo removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-categories": { "get": { "tags": [ "DemandTypes" ], "summary": "Listar categorias de demanda", "operationId": "1846e15fbf34999336494444186bae0d", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "example": "Infra" } }, { "name": "trashed", "in": "query", "description": "with | only", "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de categorias", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DemandCategory" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "DemandTypes" ], "summary": "Criar categoria", "operationId": "991711e9616785602c1d284ae677bbf3", "responses": { "201": { "description": "Categoria criada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandCategory" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-categories/{id}": { "get": { "tags": [ "DemandTypes" ], "summary": "Detalhar categoria", "operationId": "1c650377fda50de9e1e01ec4076a6486", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes da categoria", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandCategory" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "DemandTypes" ], "summary": "Atualizar categoria", "operationId": "d35be92c69fc599e29beb2bf3fbbac5e", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Categoria atualizada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandCategory" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "DemandTypes" ], "summary": "Enviar categoria para lixeira", "operationId": "6e8ab48d62fd2fed783b13af1a8d3c3e", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Categoria removida com sucesso" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-categories/{id}/restore": { "patch": { "tags": [ "DemandTypes" ], "summary": "Restaurar categoria", "operationId": "aaa327c56495b82ec58b7c7e92de853c", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Categoria restaurada com sucesso" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-categories/{id}/force": { "delete": { "tags": [ "DemandTypes" ], "summary": "Excluir categoria permanentemente", "operationId": "2996cfc9f9bef51cb17d93898a84124b", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Categoria excluída permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-deadlines": { "get": { "tags": [ "DemandDeadlines" ], "summary": "Listar prazos de demanda", "operationId": "2d6dac0064137dbd1cd137fda06cc68b", "parameters": [ { "name": "trashed", "in": "query", "description": "only | with", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de prazos", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandDeadline" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "DemandDeadlines" ], "summary": "Criar prazo", "operationId": "5707e0cd32197fcb0307840b6ff90abe", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title", "status" ], "properties": { "title": { "type": "string", "example": "24 horas" }, "default": { "type": "boolean", "example": false }, "status": { "type": "string", "example": "active" } }, "type": "object" } } } }, "responses": { "201": { "description": "Prazo criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDeadline" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-deadlines/{id}": { "get": { "tags": [ "DemandDeadlines" ], "summary": "Detalhar prazo", "operationId": "0f9af8138e4183eff30cd0645d075c87", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do prazo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDeadline" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "DemandDeadlines" ], "summary": "Atualizar prazo", "operationId": "e0178a6ba9460e04ae00ae4cb84d8478", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "default": { "type": "boolean" }, "status": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Prazo atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDeadline" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "DemandDeadlines" ], "summary": "Enviar prazo para lixeira", "operationId": "475874ce486fc4c34d48eaf89b345e96", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Prazo enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-deadlines/{id}/restore": { "patch": { "tags": [ "DemandDeadlines" ], "summary": "Restaurar prazo", "operationId": "0fd3d1d23f584840d510fdc553b778bf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Prazo restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-deadlines/{id}/force": { "delete": { "tags": [ "DemandDeadlines" ], "summary": "Remover prazo permanentemente", "operationId": "536c2245673774decdec60a1137eed9e", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Prazo removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-departments": { "get": { "tags": [ "Departments" ], "summary": "Lista pastas/secretarias da account", "operationId": "34db541827e6a370e9d9bf955ba651de", "parameters": [ { "name": "trashed", "in": "query", "description": "only (somente lixeira) | with (inclui deletados)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista retornada com sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandDepartment" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Departments" ], "summary": "Cria nova pasta/secretaria", "operationId": "3dbbcea7f384b0214f70442fe50e4f41", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title", "status" ], "properties": { "title": { "type": "string", "example": "Secretaria de Educação" }, "description": { "type": "string", "example": "Demandas educacionais" }, "status": { "type": "string", "example": "active" } }, "type": "object" } } } }, "responses": { "201": { "description": "Criado com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDepartment" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-departments/{id}": { "put": { "tags": [ "Departments" ], "summary": "Atualiza pasta/secretaria", "operationId": "b6b9ab4daf333990831d9df52d9146b4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Atualizado com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDepartment" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Departments" ], "summary": "Envia para lixeira", "operationId": "aee16b70e3900be44397768b5cb04661", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-departments/{id}/restore": { "patch": { "tags": [ "Departments" ], "summary": "Restaura da lixeira", "operationId": "408d59aecb50eabc7139ec384ab2d2e1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Restaurado com sucesso" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-departments/{id}/force": { "delete": { "tags": [ "Departments" ], "summary": "Remove permanentemente", "operationId": "93ebd78db832944ddf41da0e41c1c302", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demands": { "get": { "tags": [ "Demands" ], "summary": "Listar demandas", "operationId": "cef6d5c26e60753b382c605f3cd7e6c9", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "trashed", "in": "query", "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de demandas", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Demand" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Demands" ], "summary": "Criar demanda", "operationId": "5a6b399d83563cb5ce3c679c28121aad", "responses": { "201": { "description": "Demanda criada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Demand" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demands/{id}": { "get": { "tags": [ "Demands" ], "summary": "Detalhar demanda", "operationId": "1778e5c334f077650bd7d17735306e09", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes da demanda", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Demand" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Demands" ], "summary": "Atualizar demanda", "operationId": "44c87ff1515665a309f6f65544c3a09c", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Demanda atualizada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Demand" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Demands" ], "summary": "Enviar demanda para lixeira", "operationId": "388ce54d7d1141cc3765b567ac4925e4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Demanda removida" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demands/{id}/restore": { "patch": { "tags": [ "Demands" ], "summary": "Restaurar demanda", "operationId": "8cd72df6163cd88f2d9639a9845ca166", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Demanda restaurada" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demands/{id}/force": { "delete": { "tags": [ "Demands" ], "summary": "Remover demanda permanentemente", "operationId": "c4a035432047df92386ca55dcd7e0adc", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Demanda removida permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-documents": { "get": { "tags": [ "Demands" ], "summary": "Listar documentos", "operationId": "02c21998f0edeef6e6c87eb3d0a25d7a", "parameters": [ { "name": "trashed", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Lista de documentos", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DemandDocument" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Demands" ], "summary": "Criar documento", "operationId": "a5882b71c10bffd37b3087ea321bdf0d", "responses": { "201": { "description": "Documento criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDocument" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-documents/{id}": { "get": { "tags": [ "Demands" ], "summary": "Detalhar documento", "operationId": "2c158ce8ba0ecaf2f3bba820aa5df552", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do documento", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDocument" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Demands" ], "summary": "Atualizar documento", "operationId": "2cfbcb310d349dc436eddb9e119e9274", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Documento atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandDocument" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Demands" ], "summary": "Enviar documento para lixeira", "operationId": "b50ff8e065da35115bad51205c1b5b6b", "responses": { "200": { "description": "Documento removido" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-documents/{id}/restore": { "patch": { "tags": [ "Demands" ], "summary": "Restaurar documento", "operationId": "bbe63e62ed54aa1a1f06bba199b6a0b9", "responses": { "200": { "description": "Documento restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-documents/{id}/force": { "delete": { "tags": [ "Demands" ], "summary": "Remover documento permanentemente", "operationId": "68e8d9202565e1ba89f2db0169390e8f", "responses": { "200": { "description": "Documento removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-matters": { "get": { "tags": [ "DemandMatters" ], "summary": "Listar assuntos de demandas", "operationId": "2b012294a8388d590df8b7c973e2f936", "parameters": [ { "name": "trashed", "in": "query", "description": "only | with", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de assuntos", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandMatter" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "DemandMatters" ], "summary": "Criar assunto", "operationId": "c6779a76a7aa3741ecac919bcb271641", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title", "status" ], "properties": { "title": { "type": "string", "example": "Saúde" }, "status": { "type": "string", "example": "active" } }, "type": "object" } } } }, "responses": { "201": { "description": "Assunto criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandMatter" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-matters/{id}": { "get": { "tags": [ "DemandMatters" ], "summary": "Detalhar assunto", "operationId": "38552aaafd1c058834fbc63e5b54d385", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do assunto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandMatter" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "DemandMatters" ], "summary": "Atualizar assunto", "operationId": "56d6bfbe0eee0e0e4fd1719d24bc5215", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Assunto atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandMatter" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "DemandMatters" ], "summary": "Enviar assunto para lixeira", "operationId": "6fe6a87c1859acfcddc845a8bfe7cba3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Assunto enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-matters/{id}/restore": { "patch": { "tags": [ "DemandMatters" ], "summary": "Restaurar assunto", "operationId": "ea7b6fe945ba7763237bce4131674445", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Assunto restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-matters/{id}/force": { "delete": { "tags": [ "DemandMatters" ], "summary": "Remover assunto permanentemente", "operationId": "43a3b6cf7578a080ac329cc7ce6f82cc", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Assunto removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demands/{demandId}/photos": { "get": { "tags": [ "Demands" ], "summary": "Listar fotos da demanda", "operationId": "36de352656bbc7aff971eb4cf7e6cd00", "parameters": [ { "name": "demandId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Lista de fotos", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandPhoto" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Demands" ], "summary": "Enviar foto para demanda", "operationId": "c9ed4cfd1b8241ec56a2bb77c4015e20", "parameters": [ { "name": "demandId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true }, "responses": { "201": { "description": "Foto criada com sucesso", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandPhoto" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demands/{demandId}/photos/{photoId}": { "get": { "tags": [ "Demands" ], "summary": "Detalhar foto", "operationId": "2aefcc877dcf736ccd08b92e71182f46", "parameters": [ { "name": "demandId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "photoId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes da foto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandPhoto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Demands" ], "summary": "Atualizar foto da demanda", "operationId": "da6492114cb4d6b61d406221ba431319", "parameters": [ { "name": "demandId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "photoId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true }, "responses": { "200": { "description": "Foto atualizada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandPhoto" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Demands" ], "summary": "Remover foto", "operationId": "3294e5405c1bd589b79435814b76a4cf", "parameters": [ { "name": "demandId", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "photoId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Foto removida com sucesso" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-responses": { "get": { "tags": [ "Demands" ], "summary": "Listar respostas de demandas", "operationId": "a6caf4b5746d023fd11919c768714127", "parameters": [ { "name": "trashed", "in": "query", "schema": { "type": "string", "example": "with" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "example": 10 } } ], "responses": { "200": { "description": "Lista de respostas", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DemandResponse" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Demands" ], "summary": "Criar resposta de demanda", "operationId": "8dc619efd11948942834fab295e2ba54", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "attached_response_file", "demand_id" ], "properties": { "demand_id": { "type": "integer", "example": 1 }, "document_id": { "type": "integer", "example": 2 }, "client_id": { "type": "integer", "example": 10 }, "attached_response_file": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "201": { "description": "Resposta criada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandResponse" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-responses/{id}": { "get": { "tags": [ "Demands" ], "summary": "Detalhar resposta", "operationId": "ceb49021386c6ec35f838cafdc3f01f9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes da resposta", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Demands" ], "summary": "Atualizar resposta", "operationId": "05916ea87600dccac9ed0bee65249a38", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "attached_response_file": { "type": "string", "format": "binary" }, "document_id": { "type": "integer", "example": 2 }, "client_id": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "responses": { "200": { "description": "Resposta atualizada", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandResponse" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Demands" ], "summary": "Enviar para lixeira", "operationId": "d71412bfcf59b2c8b0c58cc8a03a83c6", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Removido" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-responses/{id}/restore": { "patch": { "tags": [ "Demands" ], "summary": "Restaurar resposta", "operationId": "350f6b593632d807a14569969f6da5cd", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-responses/{id}/force": { "delete": { "tags": [ "Demands" ], "summary": "Remover permanentemente", "operationId": "298f21312b2d1c59c6ba4d8445a61b2f", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-status": { "get": { "tags": [ "DemandStatus" ], "summary": "Listar status de demandas", "operationId": "0157f349f13eaf46cd4e05faf64a10ad", "parameters": [ { "name": "trashed", "in": "query", "description": "only | with", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de status", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandStatus" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "DemandStatus" ], "summary": "Criar status", "operationId": "f88df0a5995d23ae46c6081cfffc5512", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title", "status" ], "properties": { "title": { "type": "string", "example": "Concluído" }, "description": { "type": "string", "example": "Finalizado com sucesso" }, "color": { "type": "string", "example": "#00FF00" }, "order": { "type": "integer", "example": 2 }, "type": { "type": "string", "example": "final" }, "send_message": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Sua demanda foi concluída" }, "status": { "type": "string", "example": "active" } }, "type": "object" } } } }, "responses": { "201": { "description": "Status criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandStatus" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-status/{id}": { "get": { "tags": [ "DemandStatus" ], "summary": "Detalhar status", "operationId": "20a0acde2e89f3ab2b6c8eb2ca3c7453", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandStatus" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "DemandStatus" ], "summary": "Atualizar status", "operationId": "7c2f9e285f8ebc33d64b332935177776", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "integer" }, "type": { "type": "string" }, "send_message": { "type": "boolean" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Status atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandStatus" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "DemandStatus" ], "summary": "Enviar status para lixeira", "operationId": "35db5ffe600a9731cc46a673d2b939bd", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Status enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-status/{id}/restore": { "patch": { "tags": [ "DemandStatus" ], "summary": "Restaurar status", "operationId": "4eba625ed8962447ce6a3aff62b22fd2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Status restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-status/{id}/force": { "delete": { "tags": [ "DemandStatus" ], "summary": "Remover status permanentemente", "operationId": "ae9c978735ea8404405ef407d60c4f56", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Status removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-types": { "get": { "tags": [ "DemandTypes" ], "summary": "Listar tipos de demanda", "operationId": "b2fd67d06388f439fdbacb66dc282953", "parameters": [ { "name": "trashed", "in": "query", "description": "only (somente lixeira) | with (inclui deletados)", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de tipos de demanda", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandType" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "DemandTypes" ], "summary": "Criar tipo de demanda", "operationId": "65df397c47df352c39020f909df2eac2", "requestBody": { "required": true }, "responses": { "201": { "description": "Tipo de demanda criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandType" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-types/{id}": { "get": { "tags": [ "DemandTypes" ], "summary": "Detalhar tipo de demanda", "operationId": "0c2abe3dda6785ea733c336513e1eb35", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do tipo de demanda", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandType" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "DemandTypes" ], "summary": "Atualizar tipo de demanda", "operationId": "de9d583767b024440227cccd00ff7aba", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true }, "responses": { "200": { "description": "Tipo de demanda atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DemandType" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "DemandTypes" ], "summary": "Enviar tipo de demanda para lixeira", "operationId": "8da2fd55c4dcc25eb80c8213dfec25a1", "responses": { "200": { "description": "Tipo de demanda enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-types/{id}/restore": { "patch": { "tags": [ "DemandTypes" ], "summary": "Restaurar tipo de demanda", "operationId": "2b26341dc0387b8b1a6ed71a7d149102", "responses": { "200": { "description": "Tipo de demanda restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/demand-types/{id}/force": { "delete": { "tags": [ "DemandTypes" ], "summary": "Remover tipo de demanda permanentemente", "operationId": "5b4bbeeab009883209158bdd7dd45ebc", "responses": { "200": { "description": "Tipo de demanda removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/genres": { "get": { "tags": [ "Generous" ], "summary": "Listar gêneros", "operationId": "5ea5015a09786c47bae736ab837010b3", "parameters": [ { "name": "trashed", "in": "query", "description": "only | with", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de gêneros", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Genre" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Generous" ], "summary": "Criar gênero", "operationId": "691f7c317f3adbdf3705897e80258881", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title", "status" ], "properties": { "title": { "type": "string", "example": "Feminino" }, "status": { "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "201": { "description": "Gênero criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Genre" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/genres/{id}": { "get": { "tags": [ "Generous" ], "summary": "Detalhar gênero", "operationId": "229f559cfbe9af9d93aba83faa3a271e", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Genre" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Generous" ], "summary": "Atualizar gênero", "operationId": "ae7ced989899eb0aeb051ab344f8f63f", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "title": { "type": "string" }, "status": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Genre" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Generous" ], "summary": "Enviar para lixeira", "operationId": "8cbb2a42f2654288e51d2f6588411676", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Removido" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/genres/{id}/restore": { "patch": { "tags": [ "Generous" ], "summary": "Restaurar", "operationId": "08ee29d7bd9f1019df99bf0277fc964c", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/genres/{id}/force": { "delete": { "tags": [ "Generous" ], "summary": "Remover permanentemente", "operationId": "87b41c7817763d6ffbc92c79424cef79", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deletado permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/positions": { "get": { "tags": [ "Positions" ], "summary": "Listar cargos", "operationId": "587eee86c16fc5c6f9a707d6b2ec8f80", "parameters": [ { "name": "trashed", "in": "query", "description": "only (somente lixeira) | with (inclui deletados)", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista de cargos", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Position" } } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Positions" ], "summary": "Criar cargo", "operationId": "f2a520ef5fd5727081473dd39158a1f9", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "position_name", "status" ], "properties": { "position_name": { "type": "string", "example": "Chefe de Gabinete" }, "status": { "type": "string", "example": "active" } }, "type": "object" } } } }, "responses": { "201": { "description": "Cargo criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Position" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/positions/{id}": { "get": { "tags": [ "Positions" ], "summary": "Detalhar cargo", "operationId": "f19d2646a92a11997cec6a888058e1e9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Detalhes do cargo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Position" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Positions" ], "summary": "Atualizar cargo", "operationId": "f209afb5726dbda0961c436c80615f9e", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "position_name": { "type": "string", "example": "Assessor Especial" }, "status": { "type": "string", "example": "inactive" } }, "type": "object" } } } }, "responses": { "200": { "description": "Cargo atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Position" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Positions" ], "summary": "Enviar cargo para lixeira", "operationId": "de36f13b7f4afb5452c8eaa95d02a025", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cargo enviado para lixeira" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/positions/{id}/restore": { "patch": { "tags": [ "Positions" ], "summary": "Restaurar cargo", "operationId": "ff07edcacf76f66f3e992e8704a8ab0a", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cargo restaurado" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/positions/{id}/force": { "delete": { "tags": [ "Positions" ], "summary": "Remover cargo permanentemente", "operationId": "dec09766052a12bb32f7d9c35a0d70ef", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cargo removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/users": { "get": { "tags": [ "Users" ], "summary": "Lista usuários da conta", "operationId": "55c2f3d3b0eca1ce543605cd1d249a5f", "parameters": [ { "name": "trashed", "in": "query", "required": false, "schema": { "type": "string", "example": "with" } } ], "responses": { "200": { "description": "Lista retornada com sucesso", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccount" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Users" ], "summary": "Cria novo usuário", "operationId": "2e1757226ee7eb295bbe3ff7746b863d", "requestBody": { "required": true }, "responses": { "201": { "description": "Usuário criado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccount" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Mostra usuário específico", "operationId": "c4b1ea07ee91a56db048b8f07745eb32", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Usuário encontrado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccount" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Users" ], "summary": "Atualiza usuário", "operationId": "56f466ff4ea718974fb1650c157fab4e", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true }, "responses": { "200": { "description": "Usuário atualizado", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccount" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Users" ], "summary": "Envia usuário para lixeira", "operationId": "b2fb55a5e11e78c0ae4dd6af75a2ab25", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Usuário removido" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/users/{id}/restore": { "patch": { "tags": [ "Users" ], "summary": "Restaura usuário deletado", "operationId": "286b00c2a623c222714f33dddf6ef605", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Usuário restaurado com sucesso" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/users/{id}/force": { "delete": { "tags": [ "Users" ], "summary": "Remove usuário permanentemente", "operationId": "fd3c151ac27240989e6dadfd78e6421c", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Usuário removido permanentemente" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "schemas": { "Account": { "title": "Account", "properties": { "id": { "type": "integer", "example": 1 }, "subscription_id": { "type": "integer", "example": 1 }, "cnpj": { "type": "string", "example": "12345678000100" }, "corporate_name": { "type": "string", "example": "Empresa LTDA" }, "fantasy_name": { "type": "string", "example": "Empresa" }, "political_office": { "type": "string", "example": "Vereador" }, "iss": { "type": "string", "example": "123456" }, "ie": { "type": "string", "example": "987654321" }, "responsible": { "type": "string", "example": "João da Silva" }, "responsible_email": { "type": "string", "format": "email", "example": "responsavel@teste.com" }, "zip_code": { "type": "string", "example": "18000000" }, "street": { "type": "string", "example": "Rua Exemplo" }, "number": { "type": "string", "example": "123" }, "complement": { "type": "string", "example": "Sala 01" }, "district": { "type": "string", "example": "Centro" }, "city": { "type": "string", "example": "Sorocaba" }, "state": { "type": "string", "example": "SP" }, "country": { "type": "string", "example": "Brasil" }, "phone": { "type": "string", "example": "11999999999" }, "whatsapp": { "type": "string", "example": "11999999999" }, "site": { "type": "string", "example": "https://empresa.com.br" }, "email": { "type": "string", "format": "email", "example": "empresa@teste.com" }, "facebook": { "type": "string", "example": "facebook.com/empresa" }, "instagram": { "type": "string", "example": "@empresa" }, "youtube": { "type": "string", "example": "youtube.com/empresa" }, "twitter": { "type": "string", "example": "@empresa" }, "tiktok": { "type": "string", "example": "@empresa" }, "logo": { "type": "string", "example": "logo.png" }, "birthday_message": { "type": "string", "example": "Parabéns pelo seu aniversário!" }, "status": { "type": "string", "enum": [ "active", "inactive" ], "example": "active" }, "registered_id": { "type": "integer", "example": 1 }, "updated_id": { "type": "integer", "example": 2 }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" } }, "type": "object" }, "Audit": { "title": "Audit", "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 10 }, "account_id": { "type": "integer", "example": 1 }, "event": { "type": "string", "example": "created" }, "auditable_type": { "type": "string", "example": "App\\\\Models\\\\Client" }, "auditable_id": { "type": "integer", "example": 5 }, "old_values": { "type": "object", "example": { "name": "Antigo" } }, "new_values": { "type": "object", "example": { "name": "Novo" } }, "url": { "type": "string", "example": "/api/v1/clients" }, "ip_address": { "type": "string", "example": "127.0.0.1" }, "user_agent": { "type": "string", "example": "Mozilla/5.0" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" } }, "type": "object" }, "LoginResponse": { "title": "Login Response", "properties": { "token": { "type": "string", "example": "1|asdasdASDASD123123" }, "user": { "$ref": "#/components/schemas/UserAccount" }, "account": { "type": "object", "example": { "id": 1, "name": "Minha Conta" } } }, "type": "object" }, "BirthdayMessage": { "title": "Birthday Message", "properties": { "birthday_message": { "type": "string", "example": "Feliz aniversário! 🎉" } }, "type": "object" }, "Client": { "title": "Client", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "João Silva" }, "cpf": { "type": "string", "example": "12345678900" }, "email": { "type": "string", "example": "joao@email.com" }, "phone": { "type": "string", "example": "11999999999" }, "city": { "type": "string", "example": "São Paulo" }, "state": { "type": "string", "example": "SP" }, "voter_detail": { "$ref": "#/components/schemas/VoterDetail" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "VoterDetail": { "title": "Voter Detail", "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "voter_card_number": { "type": "string", "example": "123456789012" }, "state": { "type": "string", "example": "SP" }, "city": { "type": "string", "example": "São Paulo" }, "electoral_zone": { "type": "string", "example": "123" }, "electoral_section": { "type": "string", "example": "456" } }, "type": "object" }, "ClientGroup": { "title": "ClientGroup", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "VIP" }, "description": { "type": "string", "example": "Clientes prioritários" }, "status": { "type": "boolean", "example": true }, "registered_id": { "type": "integer", "example": 1 }, "updated_id": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "DemandCategory": { "title": "Demand Category", "properties": { "id": { "type": "integer", "example": 1 }, "title": { "type": "string", "example": "Infraestrutura" }, "type": { "type": "string", "example": "interno" }, "status": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "DemandDeadline": { "title": "Demand Deadline", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "account_user_id": { "type": "integer", "example": 10 }, "title": { "type": "string", "example": "48 horas" }, "default": { "type": "boolean", "example": true }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "DemandDepartment": { "title": "Demand Department", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "title": { "type": "string", "example": "Secretaria de Educação" }, "description": { "type": "string", "example": "Demandas educacionais" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "Demand": { "title": "Demand", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 10 }, "demand_category_id": { "type": "integer", "example": 2 }, "demand_type_id": { "type": "integer", "example": 1 }, "department_id": { "type": "integer", "example": 3 }, "responsible_id": { "type": "integer", "example": 5 }, "demand_status_id": { "type": "integer", "example": 1 }, "observations": { "type": "string", "example": "Solicitação urgente" }, "demand_end_date": { "type": "string", "format": "date" }, "active_demand": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true }, "demandAddress": { "$ref": "#/components/schemas/DemandAddress" } }, "type": "object" }, "DemandAddress": { "title": "Demand Address", "properties": { "id": { "type": "integer", "example": 1 }, "zip_code": { "type": "string", "example": "18000-000" }, "street": { "type": "string", "example": "Rua Central" }, "number": { "type": "string", "example": "123" }, "complement": { "type": "string", "example": "Casa" }, "district": { "type": "string", "example": "Centro" }, "city": { "type": "string", "example": "Sorocaba" }, "state": { "type": "string", "example": "SP" }, "country": { "type": "string", "example": "Brasil" }, "latitude": { "type": "string", "example": "-23.501" }, "longitude": { "type": "string", "example": "-47.458" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "DemandDocument": { "title": "Demand Document", "properties": { "id": { "type": "integer", "example": 1 }, "demand_id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 10 }, "matter_id": { "type": "integer", "example": 2 }, "document_number": { "type": "string", "example": "12345" }, "document_year": { "type": "string", "example": "2025" }, "indexing_code": { "type": "string", "example": "ABC-123" }, "attached_file": { "type": "string", "example": "documents/file.pdf" }, "file_format": { "type": "string", "example": "pdf" }, "status": { "type": "string", "example": "active" }, "registered_id": { "type": "integer", "example": 1 }, "updated_id": { "type": "integer", "example": 2 }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "DemandMatter": { "title": "Demand Matter", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "account_user_id": { "type": "integer", "example": 10 }, "title": { "type": "string", "example": "Iluminação pública" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "DemandPhoto": { "title": "Demand Photo", "properties": { "id": { "type": "integer", "example": 1 }, "demand_id": { "type": "integer", "example": 10 }, "account_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 5 }, "photo": { "type": "string", "example": "photos/abc123.jpg" }, "caption": { "type": "string", "example": "Imagem do local" }, "registered_id": { "type": "integer", "example": 2 }, "updated_id": { "type": "integer", "example": 3 }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" } }, "type": "object" }, "DemandResponse": { "title": "DemandResponse", "properties": { "id": { "type": "integer", "example": 1 }, "demand_id": { "type": "integer", "example": 1 }, "document_id": { "type": "integer", "example": 2 }, "account_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 10 }, "attached_response_file": { "type": "string", "example": "documents/file.pdf" }, "file_format": { "type": "string", "example": "pdf" }, "registered_id": { "type": "integer", "example": 5 }, "updated_id": { "type": "integer", "example": 6 }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "DemandStatus": { "title": "Demand Status", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "account_user_id": { "type": "integer", "example": 10 }, "title": { "type": "string", "example": "Em andamento" }, "description": { "type": "string", "example": "Demanda em execução" }, "color": { "type": "string", "example": "#FF0000" }, "order": { "type": "integer", "example": 1 }, "type": { "type": "string", "example": "default" }, "send_message": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Sua demanda está em andamento" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "DemandType": { "title": "Demand Type", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "account_user_id": { "type": "integer", "example": 10 }, "demand_category_id": { "type": "integer", "example": 2 }, "demand_department_id": { "type": "integer", "example": 3 }, "title": { "type": "string", "example": "Iluminação pública" }, "description": { "type": "string", "example": "Troca de lâmpadas" }, "default": { "type": "boolean", "example": false }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "Genre": { "title": "Genre", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "title": { "type": "string", "example": "Masculino" }, "status": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "Position": { "title": "Position", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 1 }, "position_name": { "type": "string", "example": "Chefe de Gabinete" }, "status": { "type": "string", "example": "active" }, "created_at": { "type": "string", "format": "date-time", "example": "2026-01-01T10:00:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-01-02T10:00:00Z" }, "deleted_at": { "type": "string", "format": "date-time", "example": null, "nullable": true } }, "type": "object" }, "UserAccount": { "title": "User Account", "properties": { "id": { "type": "integer", "example": 1 }, "account_id": { "type": "integer", "example": 10 }, "name": { "type": "string", "example": "João da Silva" }, "email": { "type": "string", "format": "email", "example": "joao@email.com" }, "position_id": { "type": "integer", "example": 2 }, "status": { "type": "string", "example": "active" }, "last_login_at": { "type": "string", "format": "date-time", "example": "2025-01-01 10:00:00" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } }, "securitySchemes": { "bearerAuth": { "type": "http", "bearerFormat": "Token", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Auth", "description": "Autenticação de usuários no crm" }, { "name": "Account", "description": "Gestão da conta autenticada" }, { "name": "Users", "description": "Gestão de usuários da conta" }, { "name": "Positions", "description": "Gestão de cargos para usuários" }, { "name": "Departments", "description": "Gestão de pastas ou secretarias da conta" }, { "name": "DemandTypes", "description": "Gestão de tipos de demanda da conta" }, { "name": "DemandStatus", "description": "Gestão de status das demandas da conta" }, { "name": "DemandDeadlines", "description": "Gestão de prazos das demandas da conta" }, { "name": "DemandMatters", "description": "Gestão de matérias e documentos das demandas da conta" }, { "name": "ClientGroups", "description": "Gestão de grupos de munícipes da conta" }, { "name": "Generous", "description": "Gestão de gêneros de munícipes da conta" }, { "name": "BirthdayMessage", "description": "Gestão de mensagem de aniversário padrão da conta" }, { "name": "Audits", "description": "Logs de auditoria da conta" }, { "name": "Clients", "description": "Gestão de munícipes da conta" }, { "name": "Demands", "description": "Gestão de demandas da conta" } ] }