{ "openapi": "3.1.0", "info": { "title": "OminiHub 360 API", "version": "1.0.0", "description": "API REST do **OminiHub 360** — núcleo financeiro e operacional do ecossistema LuizRJesus.\n\n## Autenticação\nUse o header `X-API-Key: ohk_live_...` (ou `Authorization: Bearer ohk_live_...`).\nGere chaves em **Admin → Integrações → Chaves de API** e atribua escopos (princípio do menor privilégio).\n\n## Convenções\n- Sucesso: `{ \"ok\": true, \"data\": ..., \"meta\": ... }`\n- Erro: `{ \"ok\": false, \"erro\": \"msg\", \"campos\": {...} }`\n- Paginação: `?page=1&per_page=25`\n- Ordenação: `?sort=-created_at`\n- Filtros: `?filter[campo]=valor`\n- Valores monetários em **centavos** (`valor_cents`) — evita imprecisão de float.\n\n## Rate limiting\n120 req/min por chave (configurável em `AppServiceProvider::boot`).\n\n## Webhooks (outbound)\nCrie endpoints em **Admin → Integrações → Webhooks**. Cada entrega vai com:\n- `X-OminiHub-Event` — nome do evento\n- `X-OminiHub-Timestamp` — epoch\n- `X-OminiHub-Signature: sha256=` — assinatura HMAC do `timestamp.body` com o secret\n\n## Endpoints de sistema (fora da `/api/v1`)\nEstes endpoints públicos não exigem chave de API:\n\n| Método | Caminho | Descrição |\n|---|---|---|\n| POST | `/webhooks/ominiconnect/in` | Inbound do OminiConnect — entrega mensagens multi-canal (WhatsApp/Instagram/FB/LinkedIn/e-mail). Assinatura HMAC validada. |\n| GET | `/og/{slug}` | Open Graph image SVG 1200×630 gerada dinamicamente por produto. |\n| GET | `/sitemap.xml` | Sitemap dinâmico (rotas públicas + landings de produto). |\n| GET | `/robots.txt` | Diretivas para crawlers. |\n| GET | `/conformidade-bacen` | Página de posicionamento regulatório (SaaS, não-IF). |\n| GET | `/privacidade` | Política de Privacidade LGPD. |\n| GET | `/termos` | Termos de Uso formais. |\n| GET | `/openapi.{ext}` | Esta especificação (`json` ou `yaml`). |\n\nDetalhes do inbound `webhooks/ominiconnect/in`:\n- Header `X-OminiConnect-Signature: sha256=` com `timestamp.body`.\n- Payload: `{ channel, from, to, message_id, text, media, meta }`.\n- Idempotência por `message_id`; ecos do bot são descartados antes de chegar à IA.", "contact": { "name": "OminiHub", "url": "https://ominihub.app.br" } }, "servers": [ { "url": "http://localhost/api", "description": "Produção" }, { "url": "http://localhost:8000/api", "description": "Local" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key", "description": "Chave gerada em /admin/api-keys. Formato `ohk_live_.`." }, "BearerAuth": { "type": "http", "scheme": "bearer" } }, "schemas": { "Erro": { "type": "object", "properties": { "ok": { "type": "boolean", "example": false }, "erro": { "type": "string", "example": "Dados inválidos" }, "campos": { "type": "object", "additionalProperties": true } } }, "Meta": { "type": "object", "properties": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } } }, "Cliente": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "email": { "type": "string", "nullable": true }, "telefone": { "type": "string", "nullable": true }, "documento": { "type": "string", "nullable": true }, "tipo_pessoa": { "type": "string", "enum": [ "PF", "PJ" ] }, "ativo": { "type": "boolean" } } }, "Fatura": { "type": "object", "properties": { "id": { "type": "integer" }, "cliente_id": { "type": "integer" }, "descricao": { "type": "string" }, "valor_cents": { "type": "integer", "description": "Valor em centavos" }, "vencimento": { "type": "string", "format": "date" }, "status": { "type": "string", "enum": [ "pendente", "pago", "vencido", "cancelado" ] }, "billing_type": { "type": "string", "enum": [ "PIX", "BOLETO", "CREDIT_CARD", "DEBIT_CARD", "UNDEFINED" ] }, "invoice_url": { "type": "string", "nullable": true }, "pix_payload": { "type": "string", "nullable": true } } }, "Lead": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "empresa": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "fase": { "type": "string", "enum": [ "relacionar", "atrair", "converter", "encantar" ] }, "status": { "type": "string", "enum": [ "aberto", "ganho", "perdido" ] }, "score": { "type": "integer" } } }, "Webhook": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "eventos": { "type": "array", "items": { "type": "string" } }, "ativo": { "type": "boolean" } } } }, "responses": { "Erro": { "description": "Erro padrão", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Erro" } } } } } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ { "name": "Identidade", "description": "Consulta da chave atual" }, { "name": "Clientes", "description": "CRUD de clientes (PF/PJ) com de-duplicação" }, { "name": "Cobrancas", "description": "Faturas, pagamentos, assinaturas e emissão PSP (Asaas)" }, { "name": "Comercial", "description": "Orçamentos, contratos e serviços" }, { "name": "Agenda", "description": "OminiAgenda — disponibilidade e agendamentos" }, { "name": "CRM", "description": "OminiSales — leads, atividades, campanhas (RACE)" }, { "name": "Atendimento", "description": "Atendimentos e chamados (OminiHelp)" }, { "name": "Makers", "description": "OminiMakers — marketplace interno" }, { "name": "Notificacoes", "description": "OminiConnect — disparo multicanal" }, { "name": "Webhooks", "description": "Endpoints outbound — HMAC + retries" }, { "name": "Athos", "description": "Visão executiva read-only" } ], "paths": { "/v1/agenda/agendar": { "post": { "tags": [ "Agenda" ], "summary": "Criar / acionar em v1/agenda/agendar", "operationId": "post_v1_agenda_agendar", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/agenda/disponibilidade": { "get": { "tags": [ "Agenda" ], "summary": "Listar", "operationId": "get_v1_agenda_disponibilidade", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } } } }, "/v1/agenda/sinal": { "post": { "tags": [ "Agenda" ], "summary": "Criar / acionar em v1/agenda/sinal", "operationId": "post_v1_agenda_sinal", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/agendamentos": { "get": { "tags": [ "Agenda" ], "summary": "Listar", "operationId": "get_v1_agendamentos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "agenda" ] } ], "description": "Escopo requerido: `agenda`." } }, "/v1/agendamentos/{id}": { "get": { "tags": [ "Agenda" ], "summary": "Detalhe", "operationId": "get_v1_agendamentos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "agenda" ] } ], "description": "Escopo requerido: `agenda`." }, "patch": { "tags": [ "Agenda" ], "summary": "Atualizar", "operationId": "patch_v1_agendamentos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "agenda" ] } ], "description": "Escopo requerido: `agenda`." } }, "/v1/ai/uso": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_ai_uso", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "athos" ] } ], "description": "Escopo requerido: `athos`." } }, "/v1/allocations": { "post": { "tags": [ "Makers" ], "summary": "Criar / acionar em v1/allocations", "operationId": "post_v1_allocations", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "makers" ] } ], "description": "Escopo requerido: `makers`." } }, "/v1/assinaturas": { "get": { "tags": [ "Cobrancas" ], "summary": "Listar", "operationId": "get_v1_assinaturas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." }, "post": { "tags": [ "Cobrancas" ], "summary": "Criar / acionar em v1/assinaturas", "operationId": "post_v1_assinaturas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/assinaturas/{id}": { "get": { "tags": [ "Cobrancas" ], "summary": "Detalhe", "operationId": "get_v1_assinaturas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." }, "patch": { "tags": [ "Cobrancas" ], "summary": "Atualizar", "operationId": "patch_v1_assinaturas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." }, "delete": { "tags": [ "Cobrancas" ], "summary": "Remover / cancelar", "operationId": "delete_v1_assinaturas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/atendimentos": { "get": { "tags": [ "Atendimento" ], "summary": "Listar", "operationId": "get_v1_atendimentos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." } }, "/v1/atendimentos/cliente/{cliente}": { "get": { "tags": [ "Atendimento" ], "summary": "Detalhe", "operationId": "get_v1_atendimentos_cliente_cliente", "parameters": [ { "name": "cliente", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." }, "post": { "tags": [ "Atendimento" ], "summary": "Criar / acionar em v1/atendimentos/cliente", "operationId": "post_v1_atendimentos_cliente_cliente", "parameters": [ { "name": "cliente", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." } }, "/v1/athos/extrato": { "get": { "tags": [ "Athos" ], "summary": "Listar", "operationId": "get_v1_athos_extrato", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "athos" ] } ], "description": "Escopo requerido: `athos`." } }, "/v1/athos/faturas": { "get": { "tags": [ "Cobrancas" ], "summary": "Listar", "operationId": "get_v1_athos_faturas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "athos" ] } ], "description": "Escopo requerido: `athos`." } }, "/v1/athos/resumo": { "get": { "tags": [ "Athos" ], "summary": "Listar", "operationId": "get_v1_athos_resumo", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "athos" ] } ], "description": "Escopo requerido: `athos`." } }, "/v1/automacoes": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_automacoes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/automacoes", "operationId": "post_v1_automacoes", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." } }, "/v1/automacoes/eventos": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_automacoes_eventos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." } }, "/v1/automacoes/{id}": { "get": { "tags": [ "Identidade" ], "summary": "Detalhe", "operationId": "get_v1_automacoes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." }, "patch": { "tags": [ "Identidade" ], "summary": "Atualizar", "operationId": "patch_v1_automacoes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." }, "delete": { "tags": [ "Identidade" ], "summary": "Remover / cancelar", "operationId": "delete_v1_automacoes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." } }, "/v1/automacoes/{id}/execucoes": { "get": { "tags": [ "Identidade" ], "summary": "Detalhe", "operationId": "get_v1_automacoes_id_execucoes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." } }, "/v1/automacoes/{id}/executar": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/automacoes//executar", "operationId": "post_v1_automacoes_id_executar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "automacoes" ] } ], "description": "Escopo requerido: `automacoes`." } }, "/v1/brands": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_brands", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "brand" ] } ], "description": "Escopo requerido: `brand`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/brands", "operationId": "post_v1_brands", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "brand" ] } ], "description": "Escopo requerido: `brand`." } }, "/v1/brands/{id}": { "get": { "tags": [ "Identidade" ], "summary": "Detalhe", "operationId": "get_v1_brands_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "brand" ] } ], "description": "Escopo requerido: `brand`." }, "patch": { "tags": [ "Identidade" ], "summary": "Atualizar", "operationId": "patch_v1_brands_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "brand" ] } ], "description": "Escopo requerido: `brand`." }, "delete": { "tags": [ "Identidade" ], "summary": "Remover / cancelar", "operationId": "delete_v1_brands_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "brand" ] } ], "description": "Escopo requerido: `brand`." } }, "/v1/campanhas": { "get": { "tags": [ "CRM" ], "summary": "Listar", "operationId": "get_v1_campanhas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." }, "post": { "tags": [ "CRM" ], "summary": "Criar / acionar em v1/campanhas", "operationId": "post_v1_campanhas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." } }, "/v1/campanhas/{id}": { "get": { "tags": [ "CRM" ], "summary": "Detalhe", "operationId": "get_v1_campanhas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." } }, "/v1/campanhas/{id}/disparar": { "post": { "tags": [ "CRM" ], "summary": "Criar / acionar em v1/campanhas//disparar", "operationId": "post_v1_campanhas_id_disparar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." } }, "/v1/chamados": { "get": { "tags": [ "Atendimento" ], "summary": "Listar", "operationId": "get_v1_chamados", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." }, "post": { "tags": [ "Atendimento" ], "summary": "Criar / acionar em v1/chamados", "operationId": "post_v1_chamados", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." } }, "/v1/chamados/{id}": { "get": { "tags": [ "Atendimento" ], "summary": "Detalhe", "operationId": "get_v1_chamados_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." }, "patch": { "tags": [ "Atendimento" ], "summary": "Atualizar", "operationId": "patch_v1_chamados_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." } }, "/v1/chamados/{id}/mensagens": { "post": { "tags": [ "Atendimento" ], "summary": "Criar / acionar em v1/chamados//mensagens", "operationId": "post_v1_chamados_id_mensagens", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "atendimento" ] } ], "description": "Escopo requerido: `atendimento`." } }, "/v1/clientes": { "get": { "tags": [ "Clientes" ], "summary": "Listar", "operationId": "get_v1_clientes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "clientes" ] } ], "description": "Escopo requerido: `clientes`." }, "post": { "tags": [ "Clientes" ], "summary": "Criar / acionar em v1/clientes", "operationId": "post_v1_clientes", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "nome": "Luiz Roberto", "email": "luiz@exemplo.com", "documento": "12345678900", "telefone": "11988887777", "tipo_pessoa": "PF" } } } }, "security": [ { "ApiKeyAuth": [ "clientes" ] } ], "description": "Escopo requerido: `clientes`." } }, "/v1/clientes/ingestao": { "post": { "tags": [ "Clientes" ], "summary": "Criar / acionar em v1/clientes/ingestao", "operationId": "post_v1_clientes_ingestao", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "nome": "Luiz Roberto", "email": "luiz@exemplo.com", "documento": "12345678900", "telefone": "11988887777", "tipo_pessoa": "PF" } } } }, "security": [ { "ApiKeyAuth": [ "clientes" ] } ], "description": "Escopo requerido: `clientes`." } }, "/v1/clientes/{id}": { "get": { "tags": [ "Clientes" ], "summary": "Detalhe", "operationId": "get_v1_clientes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "clientes" ] } ], "description": "Escopo requerido: `clientes`." }, "patch": { "tags": [ "Clientes" ], "summary": "Atualizar", "operationId": "patch_v1_clientes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "clientes" ] } ], "description": "Escopo requerido: `clientes`." }, "delete": { "tags": [ "Clientes" ], "summary": "Remover / cancelar", "operationId": "delete_v1_clientes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "clientes" ] } ], "description": "Escopo requerido: `clientes`." } }, "/v1/cobrancas": { "post": { "tags": [ "Cobrancas" ], "summary": "Criar / acionar em v1/cobrancas", "operationId": "post_v1_cobrancas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/contratos": { "get": { "tags": [ "Comercial" ], "summary": "Listar", "operationId": "get_v1_contratos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." }, "post": { "tags": [ "Comercial" ], "summary": "Criar / acionar em v1/contratos", "operationId": "post_v1_contratos", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/contratos/{id}": { "get": { "tags": [ "Comercial" ], "summary": "Detalhe", "operationId": "get_v1_contratos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." }, "delete": { "tags": [ "Comercial" ], "summary": "Remover / cancelar", "operationId": "delete_v1_contratos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/ecossistema": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_ecossistema", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } } } }, "/v1/elysium/agentes": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_elysium_agentes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "elysium" ] } ], "description": "Escopo requerido: `elysium`." } }, "/v1/elysium/memorias": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_elysium_memorias", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "elysium" ] } ], "description": "Escopo requerido: `elysium`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/elysium/memorias", "operationId": "post_v1_elysium_memorias", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "elysium" ] } ], "description": "Escopo requerido: `elysium`." } }, "/v1/elysium/memorias/{id}": { "delete": { "tags": [ "Identidade" ], "summary": "Remover / cancelar", "operationId": "delete_v1_elysium_memorias_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "elysium" ] } ], "description": "Escopo requerido: `elysium`." } }, "/v1/elysium/orquestrar": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/elysium/orquestrar", "operationId": "post_v1_elysium_orquestrar", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "elysium" ] } ], "description": "Escopo requerido: `elysium`." } }, "/v1/elysium/perguntar": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/elysium/perguntar", "operationId": "post_v1_elysium_perguntar", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "elysium" ] } ], "description": "Escopo requerido: `elysium`." } }, "/v1/faturas": { "get": { "tags": [ "Cobrancas" ], "summary": "Listar", "operationId": "get_v1_faturas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." }, "post": { "tags": [ "Cobrancas" ], "summary": "Criar / acionar em v1/faturas", "operationId": "post_v1_faturas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "cliente_id": 1, "descricao": "Hospedagem mensal", "valor_cents": 9900, "vencimento": "2026-06-23", "billing_type": "PIX" } } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/faturas/{id}": { "get": { "tags": [ "Cobrancas" ], "summary": "Detalhe", "operationId": "get_v1_faturas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." }, "delete": { "tags": [ "Cobrancas" ], "summary": "Remover / cancelar", "operationId": "delete_v1_faturas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/faturas/{id}/emitir": { "post": { "tags": [ "Cobrancas" ], "summary": "Criar / acionar em v1/faturas//emitir", "operationId": "post_v1_faturas_id_emitir", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "cliente_id": 1, "descricao": "Hospedagem mensal", "valor_cents": 9900, "vencimento": "2026-06-23", "billing_type": "PIX" } } } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/health": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_health", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } } } }, "/v1/leads": { "get": { "tags": [ "CRM" ], "summary": "Listar", "operationId": "get_v1_leads", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." }, "post": { "tags": [ "CRM" ], "summary": "Criar / acionar em v1/leads", "operationId": "post_v1_leads", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "nome": "Maria Souza", "empresa": "Acme Ltda", "email": "maria@acme.com", "fase": "relacionar", "origem": "site" } } } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." } }, "/v1/leads/{id}": { "get": { "tags": [ "CRM" ], "summary": "Detalhe", "operationId": "get_v1_leads_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." }, "patch": { "tags": [ "CRM" ], "summary": "Atualizar", "operationId": "patch_v1_leads_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." } }, "/v1/leads/{id}/atividades": { "post": { "tags": [ "CRM" ], "summary": "Criar / acionar em v1/leads//atividades", "operationId": "post_v1_leads_id_atividades", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "nome": "Maria Souza", "empresa": "Acme Ltda", "email": "maria@acme.com", "fase": "relacionar", "origem": "site" } } } }, "security": [ { "ApiKeyAuth": [ "crm" ] } ], "description": "Escopo requerido: `crm`." } }, "/v1/makers": { "get": { "tags": [ "Makers" ], "summary": "Listar", "operationId": "get_v1_makers", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "makers" ] } ], "description": "Escopo requerido: `makers`." }, "post": { "tags": [ "Makers" ], "summary": "Criar / acionar em v1/makers", "operationId": "post_v1_makers", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "makers" ] } ], "description": "Escopo requerido: `makers`." } }, "/v1/makers/{id}": { "get": { "tags": [ "Makers" ], "summary": "Detalhe", "operationId": "get_v1_makers_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "makers" ] } ], "description": "Escopo requerido: `makers`." } }, "/v1/me": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_me", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } } } }, "/v1/notificacoes": { "get": { "tags": [ "Notificacoes" ], "summary": "Listar", "operationId": "get_v1_notificacoes", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "notificacoes" ] } ], "description": "Escopo requerido: `notificacoes`." }, "post": { "tags": [ "Notificacoes" ], "summary": "Criar / acionar em v1/notificacoes", "operationId": "post_v1_notificacoes", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "notificacoes" ] } ], "description": "Escopo requerido: `notificacoes`." } }, "/v1/notificacoes/{id}": { "get": { "tags": [ "Notificacoes" ], "summary": "Detalhe", "operationId": "get_v1_notificacoes_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "notificacoes" ] } ], "description": "Escopo requerido: `notificacoes`." } }, "/v1/omini-media/briefings": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_omini_media_briefings", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/omini-media/briefings", "operationId": "post_v1_omini_media_briefings", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." } }, "/v1/omini-media/briefings/{id}": { "get": { "tags": [ "Identidade" ], "summary": "Detalhe", "operationId": "get_v1_omini_media_briefings_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." }, "delete": { "tags": [ "Identidade" ], "summary": "Remover / cancelar", "operationId": "delete_v1_omini_media_briefings_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." } }, "/v1/omini-media/briefings/{id}/gerar": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/omini-media/briefings//gerar", "operationId": "post_v1_omini_media_briefings_id_gerar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." } }, "/v1/omini-media/imagem": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/omini-media/imagem", "operationId": "post_v1_omini_media_imagem", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." } }, "/v1/omini-media/video": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/omini-media/video", "operationId": "post_v1_omini_media_video", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." } }, "/v1/omini-media/voz": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/omini-media/voz", "operationId": "post_v1_omini_media_voz", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "omini_media" ] } ], "description": "Escopo requerido: `omini_media`." } }, "/v1/ominilife/metas": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_ominilife_metas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/ominilife/metas", "operationId": "post_v1_ominilife_metas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." } }, "/v1/ominilife/metas/{id}": { "patch": { "tags": [ "Identidade" ], "summary": "Atualizar", "operationId": "patch_v1_ominilife_metas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." } }, "/v1/ominilife/rotinas": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_ominilife_rotinas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/ominilife/rotinas", "operationId": "post_v1_ominilife_rotinas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." } }, "/v1/ominilife/rotinas/{id}/marcar": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/ominilife/rotinas//marcar", "operationId": "post_v1_ominilife_rotinas_id_marcar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." } }, "/v1/ominilife/tarefas": { "get": { "tags": [ "Identidade" ], "summary": "Listar", "operationId": "get_v1_ominilife_tarefas", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." }, "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/ominilife/tarefas", "operationId": "post_v1_ominilife_tarefas", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." } }, "/v1/ominilife/tarefas/{id}": { "patch": { "tags": [ "Identidade" ], "summary": "Atualizar", "operationId": "patch_v1_ominilife_tarefas_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "ominilife" ] } ], "description": "Escopo requerido: `ominilife`." } }, "/v1/orcamentos": { "get": { "tags": [ "Comercial" ], "summary": "Listar", "operationId": "get_v1_orcamentos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." }, "post": { "tags": [ "Comercial" ], "summary": "Criar / acionar em v1/orcamentos", "operationId": "post_v1_orcamentos", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/orcamentos/{id}": { "get": { "tags": [ "Comercial" ], "summary": "Detalhe", "operationId": "get_v1_orcamentos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." }, "delete": { "tags": [ "Comercial" ], "summary": "Remover / cancelar", "operationId": "delete_v1_orcamentos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/orcamentos/{id}/aceitar": { "post": { "tags": [ "Comercial" ], "summary": "Criar / acionar em v1/orcamentos//aceitar", "operationId": "post_v1_orcamentos_id_aceitar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/pagamentos": { "get": { "tags": [ "Cobrancas" ], "summary": "Listar", "operationId": "get_v1_pagamentos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/pagamentos/{id}": { "get": { "tags": [ "Cobrancas" ], "summary": "Detalhe", "operationId": "get_v1_pagamentos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "cobrancas" ] } ], "description": "Escopo requerido: `cobrancas`." } }, "/v1/projects": { "get": { "tags": [ "Makers" ], "summary": "Listar", "operationId": "get_v1_projects", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "makers" ] } ], "description": "Escopo requerido: `makers`." }, "post": { "tags": [ "Makers" ], "summary": "Criar / acionar em v1/projects", "operationId": "post_v1_projects", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "makers" ] } ], "description": "Escopo requerido: `makers`." } }, "/v1/servicos": { "get": { "tags": [ "Comercial" ], "summary": "Listar", "operationId": "get_v1_servicos", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." }, "post": { "tags": [ "Comercial" ], "summary": "Criar / acionar em v1/servicos", "operationId": "post_v1_servicos", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/servicos/{id}": { "get": { "tags": [ "Comercial" ], "summary": "Detalhe", "operationId": "get_v1_servicos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." }, "patch": { "tags": [ "Comercial" ], "summary": "Atualizar", "operationId": "patch_v1_servicos_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "comercial" ] } ], "description": "Escopo requerido: `comercial`." } }, "/v1/sso/validate": { "post": { "tags": [ "Identidade" ], "summary": "Criar / acionar em v1/sso/validate", "operationId": "post_v1_sso_validate", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } } } }, "/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Listar", "operationId": "get_v1_webhooks", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." }, "post": { "tags": [ "Webhooks" ], "summary": "Criar / acionar em v1/webhooks", "operationId": "post_v1_webhooks", "parameters": [], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "nome": "Zapier — pagamentos", "url": "https://hooks.zapier.com/...", "eventos": [ "fatura.paga", "pagamento.confirmado" ] } } } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." } }, "/v1/webhooks/deliveries/{id}/reenviar": { "post": { "tags": [ "Webhooks" ], "summary": "Criar / acionar em v1/webhooks/deliveries//reenviar", "operationId": "post_v1_webhooks_deliveries_id_reenviar", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" }, "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "nome": "Zapier — pagamentos", "url": "https://hooks.zapier.com/...", "eventos": [ "fatura.paga", "pagamento.confirmado" ] } } } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." } }, "/v1/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Detalhe", "operationId": "get_v1_webhooks_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." }, "patch": { "tags": [ "Webhooks" ], "summary": "Atualizar", "operationId": "patch_v1_webhooks_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." }, "delete": { "tags": [ "Webhooks" ], "summary": "Remover / cancelar", "operationId": "delete_v1_webhooks_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." } }, "/v1/webhooks/{id}/deliveries": { "get": { "tags": [ "Webhooks" ], "summary": "Detalhe", "operationId": "get_v1_webhooks_id_deliveries", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 } }, { "name": "sort", "in": "query", "schema": { "type": "string", "example": "-created_at" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "$ref": "#/components/schemas/Meta" } } } } } }, "401": { "$ref": "#/components/responses/Erro" }, "403": { "$ref": "#/components/responses/Erro" }, "422": { "$ref": "#/components/responses/Erro" } }, "security": [ { "ApiKeyAuth": [ "webhooks" ] } ], "description": "Escopo requerido: `webhooks`." } } } }