{ "components": { "schemas": { "AccountClosure": { "additionalProperties": false, "properties": { "case_id": { "format": "uuid", "type": "string" }, "completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "confirmed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "created_at": { "format": "date-time", "type": "string" }, "due_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "format": "uuid", "type": "string" }, "scope": { "enum": [ "account", "workspace" ], "type": "string" }, "status": { "type": "string" } }, "required": [], "type": "object" }, "AccountClosureInput": { "additionalProperties": false, "properties": { "confirm": { "const": true, "type": "boolean" }, "current_password": { "type": "string" }, "request_id": { "type": "string" }, "scope": { "enum": [ "account", "workspace" ], "type": "string" } }, "required": [ "scope", "current_password", "confirm", "request_id" ], "type": "object" }, "AccountClosureList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/AccountClosure" }, "type": "array" }, "now": { "format": "date-time", "type": "string" }, "total": { "type": "integer" } }, "required": [], "type": "object" }, "AccountClosureReview": { "additionalProperties": false, "properties": { "acknowledge_finance": { "type": "boolean" }, "approve": { "type": "boolean" }, "decision": { "type": "string" } }, "required": [ "approve", "decision" ], "type": "object" }, "AccountCorrection": { "additionalProperties": false, "properties": { "current_password": { "type": "string" }, "email": { "format": "email", "type": "string" }, "name": { "maxLength": 120, "type": "string" } }, "required": [ "name", "current_password" ], "type": "object" }, "Activation": { "additionalProperties": false, "example": { "created_at": "2026-10-18T00:00:00Z", "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "device_name": "Office PC", "generation": 1, "id": "44444444-4444-4444-8444-444444444444", "last_seen_at": "2026-10-18T00:00:00Z", "license_id": "33333333-3333-4333-8333-333333333333", "product_id": "11111111-1111-4111-8111-111111111111", "released_at": null, "status": "active", "virtual_machine": false }, "properties": { "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "device_id": { "description": "Impressão digital do dispositivo no escopo do produto, geralmente 64 caracteres hex minúsculos, derivada pelo SDK.", "type": "string" }, "device_name": { "description": "Rótulo de dispositivo legível por pessoas, não uma identidade de segurança.", "type": "string" }, "generation": { "description": "Geração de ativação usada para invalidar credenciais antigas do dispositivo.", "type": "integer" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "last_seen_at": { "description": "Data e hora da última atividade do dispositivo observada pelo servidor, UTC.", "format": "date-time", "type": "string" }, "lease_expires_at": { "anyOf": [ { "description": "Expiração da concessão do assento floating; assentos expirados podem ser recuperados.", "format": "date-time", "type": "string" }, { "description": "Expiração da concessão do assento floating; assentos expirados podem ser recuperados.", "type": "null" } ], "description": "Expiração da concessão do assento floating; assentos expirados podem ser recuperados." }, "license_id": { "description": "UUID da licença, diferente do segredo lv_lic_.", "format": "uuid", "type": "string" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "released_at": { "anyOf": [ { "description": "Data e hora da liberação; null até ser liberado.", "format": "date-time", "type": "string" }, { "description": "Data e hora da liberação; null até ser liberado.", "type": "null" } ], "description": "Data e hora da liberação; null até ser liberado." }, "session_id": { "description": "Identificador da sessão da instância floating; pode ser omitido para licenças node-locked.", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "released" ], "type": "string" }, "virtual_machine": { "description": "Se o SDK detectou uma máquina virtual.", "type": "boolean" } }, "required": [ "id", "product_id", "license_id", "device_id", "virtual_machine", "device_name", "status", "generation", "created_at", "last_seen_at", "released_at" ], "type": "object" }, "ActivationList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Activation" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "AdminPlanList": { "additionalProperties": false, "properties": { "currencies": { "items": { "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" }, "items": { "items": { "$ref": "#/components/schemas/Price" }, "type": "array" }, "settings": { "$ref": "#/components/schemas/DefaultPlan" } }, "required": [], "type": "object" }, "AttemptList": { "additionalProperties": false, "properties": { "items": { "anyOf": [ { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/WebhookAttempt" }, "type": "array" }, { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "type": "null" } ], "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo." } }, "required": [], "type": "object" }, "Audit": { "additionalProperties": false, "properties": { "action": { "description": "Identificador da ação de auditoria, como product.create ou license.renew.", "type": "string" }, "actor_id": { "description": "UUID da conta responsável pela ação.", "format": "uuid", "type": "string" }, "actor_kind": { "description": "Origem da ação: session, api_key ou system.", "enum": [ "session", "api_key", "system" ], "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "type": "string" }, "resource_id": { "description": "UUID do recurso afetado.", "maxLength": 36, "type": "string" } }, "required": [ "id", "action", "resource_id", "created_at" ], "type": "object" }, "AuditList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Audit" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" } }, "required": [ "items", "limit", "offset" ], "type": "object" }, "AutoRenewal": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Valor em centésimos; lançamentos contábeis podem ser créditos positivos ou débitos negativos.", "minimum": 0, "type": "integer" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "type": "string" }, "enabled": { "description": "Indica se o endpoint de webhook está ativado.", "type": "boolean" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "plan_name": { "description": "Nome de exibição do plano.", "type": "string" }, "policy_version": { "description": "Revisão da política de serviço aceita quando a renovação automática foi salva.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "disabled", "enabled", "insufficient_balance", "price_changed", "plan_changed", "plan_unavailable", "account_unavailable" ], "type": "string" }, "term_months": { "description": "Número de meses do prazo comprado.", "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" }, "version": { "description": "Revisão da configuração de renovação automática.", "type": "string" } }, "required": [ "mode", "enabled", "plan", "plan_name", "currency", "price_version", "term_months", "amount_cents", "status", "version", "updated_at" ], "type": "object" }, "AutoRenewalInput": { "additionalProperties": false, "properties": { "currency": { "type": "string" }, "enabled": { "type": "boolean" }, "expected_version": { "type": "string" }, "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "plan": { "type": "string" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "price_version": { "type": "string" }, "term_months": { "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" } }, "required": [ "enabled", "expected_version" ], "type": "object" }, "AutoRenewalResult": { "additionalProperties": false, "properties": { "next_renewal_at": { "anyOf": [ { "description": "Data e hora previstas da próxima renovação em UTC; pode ser null se estiver desativada ou for desnecessária.", "format": "date-time", "type": "string" }, { "description": "Data e hora previstas da próxima renovação em UTC; pode ser null se estiver desativada ou for desnecessária.", "type": "null" } ], "description": "Data e hora previstas da próxima renovação em UTC; pode ser null se estiver desativada ou for desnecessária." }, "setting": { "$ref": "#/components/schemas/AutoRenewal", "description": "Configuração atual de renovação automática." } }, "required": [ "setting", "next_renewal_at" ], "type": "object" }, "BatchInput": { "additionalProperties": false, "properties": { "days": { "description": "Obrigatório para renew: dias adicionais de validade, 1–36500; não é usado pelas outras operações.", "maximum": 36500, "minimum": 1, "type": "integer" }, "duration_days": { "description": "Duração comum para entradas create que omitem duration_days. Cada entrada pode substituí-la. Obrigatória para entradas timed/trial sem duração própria; omita na criação perpetual.", "maximum": 36500, "minimum": 1, "type": [ "integer", "null" ] }, "entries": { "description": "Obrigatório para create: 1–100 entradas de clientes; omita nas outras operações.", "items": { "additionalProperties": false, "properties": { "customer": { "description": "Rótulo de cliente definido pelo fornecedor, distinto do e-mail do portal do cliente.", "maxLength": 120, "type": "string" }, "customer_email": { "description": "E-mail vinculado ao portal do cliente; vazio quando não atribuído.", "maxLength": 254, "type": "string" }, "duration_days": { "description": "Duração de criação por licença; substitui BatchInput.duration_days. Omita para usar a duração comum de criação.", "maximum": 36500, "minimum": 1, "type": [ "integer", "null" ] } }, "required": [], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "ids": { "description": "Obrigatório para renew, revoke e apply_policy: 1–100 UUIDs de licença distintos; omita para create.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "operation": { "description": "Nome da operação; lotes suportam create/renew/revoke/apply_policy e solicitações offline activate/deactivate.", "enum": [ "create", "renew", "revoke", "apply_policy" ], "type": "string" }, "policy_id": { "description": "Obrigatório para create e apply_policy: UUID da política de licenciamento de destino.", "format": "uuid", "type": "string" }, "preview_token": { "description": "Token criptografado de confirmação da prévia obrigatório para apply_policy; válido por 600 segundos e invalidado por alterações nos recursos.", "type": "string", "writeOnly": true }, "product_id": { "description": "Obrigatório para create: UUID do produto das novas licenças.", "format": "uuid", "type": "string" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "request_id", "operation" ], "type": "object" }, "BatchItem": { "additionalProperties": false, "example": { "customer": "Order #1001", "customer_email": "buyer@example.com", "duration_days": 30, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, "properties": { "customer": { "description": "Rótulo de cliente definido pelo fornecedor, distinto do e-mail do portal do cliente.", "type": "string" }, "customer_email": { "description": "E-mail vinculado ao portal do cliente; vazio quando não atribuído.", "type": "string" }, "duration_days": { "description": "Dias por licença desde a primeira ativação. Exige 1–36500 para emissão timed/trial; ausente/null para perpetual. Nunca é armazenado na política.", "type": [ "integer", "null" ] }, "expires_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "type": "null" } ], "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial." }, "first_activated_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência.", "type": "null" } ], "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência." }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "license_key": { "description": "Chave completa de licença do cliente fornecida na ativação. Código de inicialização do produto e downloads de exemplo não contêm este segredo. Solicitações offline usam a credencial fornecida pelo SDK.", "type": "string" }, "operation": { "description": "Nome da operação; lotes suportam create/renew/revoke/apply_policy e solicitações offline activate/deactivate.", "enum": [ "create", "renew", "revoke", "apply_policy" ], "type": "string" } }, "required": [ "id" ], "type": "object" }, "BatchResult": { "additionalProperties": false, "properties": { "count": { "description": "Quantidade no grupo atual ou registros processados por um lote.", "type": "integer" }, "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/BatchItem" }, "type": "array" }, "operation": { "description": "Nome da operação; lotes suportam create/renew/revoke/apply_policy e solicitações offline activate/deactivate.", "enum": [ "create", "renew", "revoke", "apply_policy" ], "type": "string" }, "request_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, "required": [ "request_id", "operation", "items", "count" ], "type": "object" }, "BillingEmailPreview": { "additionalProperties": false, "properties": { "body": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "link": { "format": "uri", "type": "string" }, "reply_to": { "description": "E-mail público de suporte e Reply-To dos e-mails de faturamento. Vazio oculta o contato. Não altera o endereço SMTP From existente nem cria uma caixa de entrada.", "maxLength": 254, "type": "string" }, "subject": { "type": "string" }, "to": { "format": "email", "type": "string" } }, "required": [ "id", "to", "subject", "body", "link" ], "type": "object" }, "BillingEmailTestInput": { "additionalProperties": false, "properties": { "kind": { "enum": [ "purchase_success", "expiry_reminder", "auto_renewal_success", "auto_renewal_problem" ], "type": "string" }, "locale": { "default": "zh", "enum": [ "zh", "zh-hant", "en", "es", "hi", "ar", "fr", "bn", "pt", "id", "ur" ], "type": "string" }, "to": { "format": "email", "type": "string" } }, "required": [ "kind", "to" ], "type": "object" }, "BillingJob": { "additionalProperties": false, "properties": { "attempts": { "description": "Número cumulativo de tentativas da tarefa.", "type": "integer" }, "available_at": { "description": "Primeiro horário UTC em que a tarefa pode executar.", "format": "date-time", "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "last_error": { "description": "Categoria da falha mais recente; pode estar vazia.", "type": "string" }, "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "pending", "running", "done", "failed" ], "type": "string" } }, "required": [ "id", "month", "status" ], "type": "object" }, "BillingJobList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/BillingJob" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "BillingNotificationPreference": { "additionalProperties": false, "properties": { "auto_renewal_problem": { "default": true, "type": "boolean" }, "auto_renewal_success": { "default": true, "type": "boolean" }, "expiry_reminder": { "default": true, "type": "boolean" }, "locale": { "enum": [ "zh", "zh-hant", "en", "es", "hi", "ar", "fr", "bn", "pt", "id", "ur" ], "type": "string" }, "purchase_success": { "default": true, "type": "boolean" }, "updated_at": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "required": [ "purchase_success", "expiry_reminder", "auto_renewal_success", "auto_renewal_problem", "locale", "version", "updated_at" ], "type": "object" }, "BillingNotificationPreferenceInput": { "additionalProperties": false, "properties": { "auto_renewal_problem": { "default": true, "type": "boolean" }, "auto_renewal_success": { "default": true, "type": "boolean" }, "expected_version": { "description": "Versão de GET; vazia para uma preferência ainda não salva. Um valor desatualizado retorna BILLING_EMAIL_PREFERENCE_CONFLICT.", "type": "string" }, "expiry_reminder": { "default": true, "type": "boolean" }, "locale": { "enum": [ "zh", "zh-hant", "en", "es", "hi", "ar", "fr", "bn", "pt", "id", "ur" ], "type": "string" }, "purchase_success": { "default": true, "type": "boolean" } }, "required": [ "expected_version" ], "type": "object" }, "BillingNotificationPreferencesResult": { "additionalProperties": false, "properties": { "platform": { "$ref": "#/components/schemas/BillingNotificationSettings" }, "preferences": { "$ref": "#/components/schemas/BillingNotificationPreference" }, "recipient": { "format": "email", "type": "string" } }, "required": [ "preferences", "platform", "recipient" ], "type": "object" }, "BillingNotificationSettings": { "additionalProperties": false, "properties": { "auto_renewal_problem": { "default": true, "type": "boolean" }, "auto_renewal_success": { "default": true, "type": "boolean" }, "expiry_reminder": { "default": true, "type": "boolean" }, "purchase_success": { "default": true, "type": "boolean" }, "reminder_days": { "default": [ 7 ], "description": "Limiares antes do fim da cobertura contínua, em dias de 24 horas. Armazenados em ordem crescente. Um worker iniciado com atraso seleciona apenas o limiar restante mais próximo, não todos os lembretes perdidos.", "items": { "maximum": 90, "minimum": 1, "type": "integer" }, "maxItems": 10, "minItems": 1, "type": "array", "uniqueItems": true }, "support_email": { "description": "E-mail público de suporte e Reply-To dos e-mails de faturamento. Vazio oculta o contato. Não altera o endereço SMTP From existente nem cria uma caixa de entrada.", "maxLength": 254, "type": "string" }, "version": { "type": "string" } }, "required": [ "purchase_success", "expiry_reminder", "auto_renewal_success", "auto_renewal_problem", "reminder_days", "support_email", "version" ], "type": "object" }, "BillingNotificationSettingsInput": { "additionalProperties": false, "properties": { "auto_renewal_problem": { "default": true, "type": "boolean" }, "auto_renewal_success": { "default": true, "type": "boolean" }, "expected_version": { "description": "Versão de GET. Um valor desatualizado retorna BILLING_EMAIL_SETTINGS_CONFLICT.", "type": "string" }, "expiry_reminder": { "default": true, "type": "boolean" }, "purchase_success": { "default": true, "type": "boolean" }, "reminder_days": { "default": [ 7 ], "description": "Limiares antes do fim da cobertura contínua, em dias de 24 horas. Armazenados em ordem crescente. Um worker iniciado com atraso seleciona apenas o limiar restante mais próximo, não todos os lembretes perdidos.", "items": { "maximum": 90, "minimum": 1, "type": "integer" }, "maxItems": 10, "minItems": 1, "type": "array", "uniqueItems": true }, "support_email": { "description": "E-mail público de suporte e Reply-To dos e-mails de faturamento. Vazio oculta o contato. Não altera o endereço SMTP From existente nem cria uma caixa de entrada.", "maxLength": 254, "type": "string" } }, "required": [ "expected_version" ], "type": "object" }, "BundleInput": { "additionalProperties": false, "properties": { "language": { "description": "Identificador da linguagem SDK do pacote para download.", "enum": [ "go", "java", "c", "cpp", "csharp", "python", "javascript", "rust", "ruby" ], "type": "string" } }, "required": [ "language" ], "type": "object" }, "BuyPlan": { "additionalProperties": false, "properties": { "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "plan": { "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "price_version": { "type": "string" }, "renewal": { "default": false, "description": "Renovação antecipada explícita. O pagamento é cobrado agora e a cobertura pré-paga é estendida imediatamente. O próximo ciclo de cota segue a cobertura paga ou presenteada existente. O uso atual não é reiniciado. Renove o plano e a moeda pagos mais recentes; clientes expirados também podem comprar normalmente.", "type": "boolean" }, "request_id": { "maxLength": 80, "type": "string" }, "term_months": { "default": 1, "description": "Duração do contrato. Se omitida, o padrão é um mês. Alterar a duração em request_id reutilizado retorna 409.", "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" } }, "required": [ "plan", "currency", "price_version", "request_id" ], "type": "object" }, "CSRF": { "additionalProperties": false, "properties": { "csrf_token": { "type": "string" } }, "required": [ "csrf_token" ], "type": "object" }, "CancelCustomerRefund": { "additionalProperties": false, "properties": { "confirm_service_stays_cancelled": { "description": "Obrigatório quando o cancelamento do serviço já foi executado antes da revisão. Uma solicitação explícita pendente com escopo definido pode ser retirada sem interromper nem restaurar o serviço.", "type": "boolean" } }, "type": "object" }, "ChangePassword": { "additionalProperties": false, "properties": { "current_password": { "description": "12–128 bytes UTF-8, não caracteres", "type": "string", "writeOnly": true }, "password": { "description": "12–128 bytes UTF-8, não caracteres", "type": "string", "writeOnly": true }, "password_confirmation": { "description": "Obrigatório e deve corresponder exatamente à senha", "type": "string", "writeOnly": true } }, "required": [ "current_password", "password", "password_confirmation" ], "type": "object" }, "ClosureExportCredential": { "additionalProperties": false, "properties": { "download_url": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "export_deadline": { "format": "date-time", "type": "string" } }, "required": [], "type": "object" }, "ClosureExportLogin": { "additionalProperties": false, "properties": { "current_password": { "type": "string" }, "email": { "format": "email", "type": "string" } }, "required": [ "email", "current_password" ], "type": "object" }, "CommerceNotice": { "additionalProperties": false, "properties": { "body": { "description": "Corpo do aviso de serviço.", "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "effective_at": { "anyOf": [ { "description": "Horário de entrada em vigor da alteração notificada ou null.", "format": "date-time", "type": "string" }, { "description": "Horário de entrada em vigor da alteração notificada ou null.", "type": "null" } ], "description": "Horário de entrada em vigor da alteração notificada ou null." }, "emailed_at": { "anyOf": [ { "description": "Data e hora de entrega do e-mail do aviso ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora de entrega do e-mail do aviso ou null.", "type": "null" } ], "description": "Data e hora de entrega do e-mail do aviso ou null." }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "kind": { "description": "Identificador da categoria do lançamento contábil ou aviso.", "type": "string" }, "read_at": { "anyOf": [ { "description": "Data e hora de leitura do aviso ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora de leitura do aviso ou null.", "type": "null" } ], "description": "Data e hora de leitura do aviso ou null." }, "reference": { "description": "Referência comercial relacionada usada para rastreamento.", "type": "string" }, "title": { "description": "Título do aviso de serviço.", "type": "string" } }, "required": [], "type": "object" }, "CommerceNoticeList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/CommerceNotice" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "CommercePolicy": { "additionalProperties": false, "properties": { "documents": { "properties": { "privacy": { "type": "string" }, "refunds": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" }, "locale": { "type": "string" }, "pending": { "items": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "effective_at": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "required": [], "type": "object" }, "type": "array" }, "profile": { "$ref": "#/components/schemas/OperatorProfile" }, "published": { "type": "boolean" }, "ready": { "type": "boolean" }, "version": { "type": "string" } }, "required": [], "type": "object" }, "CommercePolicyInput": { "additionalProperties": false, "properties": { "expected_version": { "type": "string" }, "profile": { "$ref": "#/components/schemas/OperatorProfile" }, "published": { "type": "boolean" } }, "required": [ "profile", "published", "expected_version" ], "type": "object" }, "CommerceResult": { "additionalProperties": true, "type": "object" }, "Confirmation": { "additionalProperties": false, "properties": { "confirm": { "const": true, "type": "boolean" } }, "required": [ "confirm" ], "type": "object" }, "Consumption": { "additionalProperties": false, "properties": { "feature": { "description": "Identificador do recurso consumido.", "type": "string" }, "limit": { "description": "Limite de uso do recurso neste período.", "type": "integer" }, "overage": { "description": "Unidades acima de limit no período, não dinheiro. A política define o teto excedente.", "type": "integer" }, "period": { "description": "Período: YYYY-MM mensal, YYYY-MM-DD diário, lifetime total. Limites diários/mensais em UTC.", "type": "string" }, "quantity": { "description": "Unidades solicitadas para esta operação, inteiro 1–1000000000.", "type": "integer" }, "remaining": { "description": "remaining = max(0, limit - used - reserved), sem unidades excedentes.", "type": "integer" }, "reserved": { "description": "Unidades ainda reservadas neste período, não descontadas.", "type": "integer" }, "reset_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Próxima redefinição, UTC ISO 8601; null para lifetime." }, "used": { "description": "Unidades confirmadas neste período, sem as reservas.", "type": "integer" } }, "required": [], "type": "object" }, "ConsumptionResult": { "additionalProperties": false, "properties": { "activation_id": { "description": "UUID do vínculo ou sessão. Salve para próximas requisições; não é chave de licença.", "format": "uuid", "type": "string" }, "consumption": { "$ref": "#/components/schemas/Consumption" }, "heartbeat_seconds": { "anyOf": [ { "const": 0 }, { "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "Intervalo atual em segundos; a contagem não atualiza a assinatura nem o temporizador.", "type": "integer" } }, "required": [ "activation_id", "consumption" ], "type": "object" }, "CustomerAssignment": { "additionalProperties": false, "properties": { "email": { "description": "Vazio remove o vínculo com o portal", "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "type": "string" } }, "required": [ "email" ], "type": "object" }, "CustomerControlsInput": { "additionalProperties": false, "anyOf": [ { "required": [ "device_enabled" ] }, { "required": [ "api_enabled" ] } ], "properties": { "api_enabled": { "type": "boolean" }, "device_enabled": { "type": "boolean" } }, "required": [], "type": "object" }, "CustomerControlsResult": { "additionalProperties": false, "properties": { "api_enabled": { "type": "boolean" }, "device_enabled": { "type": "boolean" } }, "required": [ "device_enabled", "api_enabled" ], "type": "object" }, "CustomerDataExportInput": { "additionalProperties": false, "properties": { "current_password": { "type": "string" }, "reason": { "maxLength": 500, "type": "string" }, "scope": { "enum": [ "account", "workspace" ], "type": "string" } }, "required": [ "scope", "current_password", "reason" ], "type": "object" }, "CustomerLicenses": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" } }, "required": [ "email", "items" ], "type": "object" }, "CustomerOverageConsent": { "additionalProperties": false, "properties": { "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "price_version": { "type": "string" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" } }, "required": [ "price_version", "policy_version", "terms_accepted", "overage_accepted" ], "type": "object" }, "CustomerRefundInput": { "additionalProperties": false, "properties": { "amount": { "type": "string" }, "change_id": { "type": "string" }, "confirm_termination": { "type": "boolean" }, "incident_id": { "type": "string" }, "message": { "type": "string" }, "order_id": { "type": "string" }, "purchase_id": { "type": "string" }, "quote_hash": { "type": "string" }, "quoted_at": { "format": "date-time", "type": "string" }, "reason": { "enum": [ "customer_request", "future", "wallet", "usage_change", "platform_failure", "statutory", "billing_error", "failed_delivery" ], "type": "string" }, "request_id": { "type": "string" }, "scope": { "description": "O escopo explícito usa o cancelamento no momento da aprovação; omiti-lo permite o cancelamento imediato elegível após confirmação explícita.", "enum": [ "purchase", "service" ], "type": "string" } }, "required": [ "reason", "message", "request_id" ], "type": "object" }, "CustomerRefundQuote": { "anyOf": [ { "$ref": "#/components/schemas/RefundQuote" }, { "$ref": "#/components/schemas/ScopedRefundPreview" } ] }, "CustomerRefundQuoteInput": { "additionalProperties": false, "properties": { "amount": { "type": "string" }, "change_id": { "type": "string" }, "confirm_termination": { "type": "boolean" }, "incident_id": { "type": "string" }, "message": { "type": "string" }, "order_id": { "type": "string" }, "purchase_id": { "type": "string" }, "quote_hash": { "type": "string" }, "quoted_at": { "format": "date-time", "type": "string" }, "reason": { "enum": [ "customer_request", "future", "wallet", "usage_change", "platform_failure", "statutory", "billing_error", "failed_delivery" ], "type": "string" }, "request_id": { "type": "string" }, "scope": { "description": "O escopo explícito usa o cancelamento no momento da aprovação; omiti-lo permite o cancelamento imediato elegível após confirmação explícita.", "enum": [ "purchase", "service" ], "type": "string" } }, "required": [ "reason", "message" ], "type": "object" }, "CustomerReleaseInput": { "additionalProperties": false, "description": "Confirme a liberação antes de enviar. send_email opcionalmente enfileira o código temporário para o endereço verificado do cliente; generation protege contra visão desatualizada do dispositivo.", "properties": { "generation": { "minimum": 1, "type": "integer" }, "send_email": { "type": "boolean" } }, "required": [], "type": "object" }, "CustomerReleaseResult": { "additionalProperties": false, "properties": { "email_queued": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "status": { "const": "released", "type": "string" }, "transfer": { "anyOf": [ { "$ref": "#/components/schemas/TransferCode" }, { "type": "null" } ] } }, "required": [ "id", "status", "transfer", "email_queued" ], "type": "object" }, "CustomerSession": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" } }, "required": [], "type": "object" }, "DatabaseStatus": { "additionalProperties": false, "properties": { "connected": { "type": "boolean" }, "database": { "type": "string" }, "host": { "type": "string" }, "open_connections": { "type": "integer" }, "version": { "type": "string" } }, "required": [ "connected", "host", "database" ], "type": "object" }, "DefaultPlan": { "additionalProperties": false, "properties": { "allow_customer_api_overage": { "default": false, "description": "Permite apenas escolhas de excedente API do cliente. Independente da permissão de dispositivos. Quando false, uso API segue regras do administrador. API ilimitada permanece ilimitada.", "type": "boolean" }, "allow_customer_device_overage": { "default": false, "description": "Permite apenas escolhas de excedente de dispositivos do cliente. Quando false, o uso segue regras do administrador e escolhas salvas do cliente são ignoradas até reativação.", "type": "boolean" }, "default_currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "default_plan": { "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" } }, "required": [ "default_plan", "default_currency" ], "type": "object" }, "DeliveryList": { "additionalProperties": false, "properties": { "items": { "anyOf": [ { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/WebhookDelivery" }, "type": "array" }, { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "type": "null" } ], "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo." }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [], "type": "object" }, "DeviceProfile": { "additionalProperties": false, "properties": { "hardware_id": { "description": "SHA-256 do produto e hardware. Vazio se indisponível; políticas que exigem hardware o rejeitam.", "type": "string" }, "platform": { "description": "Sistema local: windows, linux ou darwin (macOS).", "enum": [ "windows", "linux", "darwin" ], "type": "string" }, "system_id": { "description": "SHA-256 do produto e identidade do sistema: 64 caracteres hexadecimais minúsculos.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "version": { "const": 3, "description": "Versão do protocolo de impressão do dispositivo, atualmente 3.", "type": "integer" }, "virtual_machine": { "description": "Booleano: se o SDK detecta máquina virtual.", "type": "boolean" } }, "required": [ "version", "system_id", "hardware_id", "virtual_machine", "platform" ], "type": "object" }, "DeviceReleaseOperation": { "additionalProperties": false, "properties": { "activation_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "attempts": { "description": "Número de tentativas de processamento com falha mantido pelo Licentivo.", "type": "integer" }, "available_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "completed_at": { "anyOf": [ { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, { "description": "Horário de conclusão da operação; omitido enquanto estiver pendente.", "type": "null" } ], "description": "Horário de conclusão da operação; omitido enquanto estiver pendente." }, "connection_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "created_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "error_code": { "description": "Motivo estável de processamento ou revisão; vazio após o sucesso.", "type": "string" }, "expected_generation": { "description": "Geração esperada do vínculo do dispositivo, comparada dentro da transação de revogação.", "minimum": 1, "type": "integer" }, "license_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "operation_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "source": { "description": "Origem desta operação de revogação.", "enum": [ "logout", "launch", "admin" ], "type": "string" }, "status": { "description": "Estado atual de ciclo de vida ou processamento controlado pelo servidor.", "enum": [ "pending", "succeeded", "stale", "manual_review" ], "type": "string" } }, "required": [ "operation_id", "license_id", "activation_id", "expected_generation", "source", "status" ], "type": "object" }, "EligibleReleases": { "additionalProperties": false, "properties": { "authorization": { "additionalProperties": true, "type": "object" }, "items": { "items": { "$ref": "#/components/schemas/Release" }, "type": "array" } }, "required": [], "type": "object" }, "Email": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "EmailChangeConfirmation": { "additionalProperties": false, "properties": { "token": { "maxLength": 2048, "minLength": 32, "type": "string" } }, "required": [ "token" ], "type": "object" }, "Empty": { "additionalProperties": false, "properties": {}, "required": [], "type": "object" }, "EmptyRefundPreviewInput": { "additionalProperties": false, "properties": {}, "required": [], "type": "object" }, "Error": { "additionalProperties": false, "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "properties": { "error": { "additionalProperties": false, "description": "Objeto de erro ou categoria de falha de entrega; consulte os campos filhos ou o tipo atual.", "properties": { "code": { "description": "Código de erro estável legível por máquina.", "type": "string" }, "message": { "description": "Mensagem de erro legível por pessoas; tome decisões pelo código.", "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "request_id": { "description": "UUID de requisição gerado pelo servidor para logs; não é ID de licença ou idempotência.", "format": "uuid", "type": "string" } }, "required": [ "error", "request_id" ], "type": "object" }, "FeatureReservation": { "additionalProperties": false, "properties": { "consumption": { "$ref": "#/components/schemas/Consumption", "description": "Recibo: unidades descontadas, uso acumulado, saldo e próxima redefinição." }, "expires_at": { "description": "Prazo da reserva em UTC; confirme antes desse horário.", "format": "date-time", "type": "string" }, "operation_id": { "description": "ID original da tarefa usado na reserva; mantenha nas novas tentativas.", "type": "string" }, "reservation_id": { "description": "ID da reserva; envie este valor para confirmar ou cancelar.", "format": "uuid", "type": "string" }, "status": { "description": "pending: executar; committed: descontado; canceled e expired: encerrado sem desconto.", "enum": [ "pending", "committed", "canceled", "expired" ], "type": "string" } }, "required": [ "reservation_id", "operation_id", "status", "expires_at", "consumption" ], "type": "object" }, "FeatureUsage": { "additionalProperties": false, "properties": { "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "type": "string" }, "license_id": { "description": "UUID da licença, diferente do segredo lv_lic_.", "format": "uuid", "type": "string" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "type": "string" }, "quantity": { "description": "Quantidade acumulada usada para este recurso e período.", "type": "integer" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" } }, "required": [ "license_id", "feature", "period", "quantity", "updated_at" ], "type": "object" }, "ForumAuthor": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ForumImage": { "additionalProperties": false, "properties": { "height": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "size": { "type": "integer" }, "url": { "type": "string" }, "width": { "type": "integer" } }, "required": [ "id", "url", "width", "height", "size" ], "type": "object" }, "ForumModerationInput": { "additionalProperties": false, "description": "Exige uma sessão de navegador de administrador da plataforma. Informe pelo menos um campo; os campos omitidos mantêm os valores atuais. A fixação se aplica a tópicos publicados ou ocultos e não restaura conteúdo excluído.", "minProperties": 1, "properties": { "hidden": { "type": "boolean" }, "locked": { "type": "boolean" }, "pinned": { "type": "boolean" } }, "required": [], "type": "object" }, "ForumReply": { "additionalProperties": false, "properties": { "author": { "$ref": "#/components/schemas/ForumAuthor" }, "body": { "type": "string" }, "can_delete": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "images": { "items": { "$ref": "#/components/schemas/ForumImage" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "body", "author", "images", "created_at", "updated_at", "can_edit", "can_delete" ], "type": "object" }, "ForumReplyInput": { "additionalProperties": false, "properties": { "body": { "maxLength": 12000, "minLength": 1, "type": "string" }, "image_ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 6, "type": "array", "uniqueItems": true } }, "required": [ "body" ], "type": "object" }, "ForumTopic": { "additionalProperties": false, "properties": { "author": { "$ref": "#/components/schemas/ForumAuthor" }, "body": { "type": "string" }, "can_delete": { "type": "boolean" }, "can_edit": { "type": "boolean" }, "can_moderate": { "type": "boolean" }, "category": { "enum": [ "integration", "help", "ideas", "showcase" ], "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "images": { "items": { "$ref": "#/components/schemas/ForumImage" }, "type": "array" }, "language": { "enum": [ "en", "zh", "zh-hant", "hi", "es", "ar", "fr", "bn", "pt", "id", "ur" ], "type": "string" }, "last_reply_at": { "format": "date-time", "type": "string" }, "locked": { "type": "boolean" }, "pinned": { "type": "boolean" }, "reply_count": { "type": "integer" }, "title": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "title", "body", "category", "language", "locked", "pinned", "author", "images", "reply_count", "created_at", "updated_at", "last_reply_at", "can_edit", "can_delete", "can_moderate" ], "type": "object" }, "ForumTopicDetail": { "additionalProperties": false, "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "replies": { "items": { "$ref": "#/components/schemas/ForumReply" }, "type": "array" }, "topic": { "$ref": "#/components/schemas/ForumTopic" }, "total": { "type": "integer" } }, "required": [ "topic", "replies", "total", "limit", "offset" ], "type": "object" }, "ForumTopicInput": { "additionalProperties": false, "properties": { "body": { "maxLength": 12000, "minLength": 1, "type": "string" }, "category": { "enum": [ "integration", "help", "ideas", "showcase" ], "type": "string" }, "image_ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 6, "type": "array", "uniqueItems": true }, "language": { "enum": [ "en", "zh", "zh-hant", "hi", "es", "ar", "fr", "bn", "pt", "id", "ur" ], "type": "string" }, "title": { "maxLength": 180, "minLength": 2, "type": "string" } }, "required": [ "title", "body", "category", "language" ], "type": "object" }, "ForumTopicList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ForumTopic" }, "type": "array" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "type": "object" }, "ForumTranslationInput": { "additionalProperties": false, "properties": { "reply_id": { "format": "uuid", "type": "string" }, "target_language": { "description": "Selecione um idioma retornado por GET /forum/translation.", "type": "string" } }, "required": [ "target_language" ], "type": "object" }, "ForumTranslationResult": { "additionalProperties": false, "properties": { "body": { "description": "Texto simples traduzido. Exiba com textContent, nunca como HTML.", "type": "string" }, "cached": { "type": "boolean" }, "provider": { "type": "string" }, "source_language": { "description": "Idioma de origem detectado informado pelo DeepL.", "type": "string" }, "target_language": { "description": "Idioma de destino escolhido do provedor.", "type": "string" }, "title": { "description": "Título traduzido do tópico; vazio para respostas.", "type": "string" } }, "required": [ "title", "body", "source_language", "target_language", "cached", "provider" ], "type": "object" }, "Health": { "additionalProperties": false, "properties": { "status": { "enum": [ "ok", "ready" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "ID": { "additionalProperties": false, "properties": { "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "Invite": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "role": { "enum": [ "owner", "read_only" ], "type": "string" } }, "required": [ "email", "name", "role" ], "type": "object" }, "Invited": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "message": { "type": "string" } }, "required": [ "id", "message" ], "type": "object" }, "Invoice": { "additionalProperties": false, "properties": { "active_devices": { "description": "Quantidade de dispositivos fixada para faturamento a partir do pico de ocupação do período padrão. Não é ocupação atual nem lista cumulativa de uso de dispositivos.", "type": "integer" }, "base_covered": { "description": "Se um pacote comprado já cobre a cobrança base.", "type": "boolean" }, "base_micros": { "description": "Cobrança base em milionésimos da unidade monetária.", "type": "integer" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "finalized_at": { "anyOf": [ { "description": "Data e hora de finalização da fatura, ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora de finalização da fatura, ou null.", "type": "null" } ], "description": "Data e hora de finalização da fatura, ou null." }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "included_devices": { "description": "Franquia de dispositivos ativos incluída.", "type": "integer" }, "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "type": "string" }, "overage_devices": { "description": "Dispositivos que excedem a franquia incluída.", "type": "integer" }, "paid_at": { "anyOf": [ { "description": "Data e hora do pagamento da fatura, ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora do pagamento da fatura, ou null.", "type": "null" } ], "description": "Data e hora do pagamento da fatura, ou null." }, "payment_mode": { "description": "Ambiente de pagamento, sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "plan_name": { "description": "Nome de exibição do plano.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" }, "refunded_at": { "anyOf": [ { "description": "Data e hora do reembolso da fatura, ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora do reembolso da fatura, ou null.", "type": "null" } ], "description": "Data e hora do reembolso da fatura, ou null." }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "draft", "finalized", "void" ], "type": "string" }, "total_cents": { "description": "Total da fatura em centésimos; consulte paid_at para o estado do pagamento.", "type": "integer" }, "total_micros": { "description": "Total da fatura em milionésimos da unidade monetária.", "type": "integer" }, "unit_micros": { "description": "Preço por dispositivo ativo excedente em milionésimos.", "type": "integer" }, "voided_at": { "anyOf": [ { "description": "Data e hora de anulação da fatura, ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora de anulação da fatura, ou null.", "type": "null" } ], "description": "Data e hora de anulação da fatura, ou null." } }, "required": [ "id", "month", "currency", "status", "total_cents" ], "type": "object" }, "InvoiceList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Invoice" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "Key": { "additionalProperties": false, "properties": { "allow_http": { "description": "Permite que esta chave registre ou atualize origens de sites Launch HTTP, incluindo domínios de servidores de teste, endereços IP privados e nomes de host internos. As solicitações à API Licentivo continuam usando HTTPS.", "type": "boolean" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "expires_at": { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "type": "string" }, "prefix": { "description": "Primeiros 14 caracteres da chave de gerenciamento; apenas identificação.", "type": "string" }, "revoked": { "description": "Se foi revogada; verifique também expires_at para expiração.", "type": "boolean" }, "scope": { "description": "read permite leituras; write permite leituras e gravações. Gravações também exigem um criador Owner ativo.", "enum": [ "read", "write" ], "type": "string" } }, "required": [ "id", "prefix", "scope", "revoked", "allow_http" ], "type": "object" }, "KeyBundle": { "additionalProperties": false, "properties": { "keys": { "items": { "$ref": "#/components/schemas/SigningKey" }, "type": "array" }, "product_id": { "format": "uuid", "type": "string" }, "protocol": { "type": "string" }, "runtime_policy_source": { "const": "current_license_policy", "type": "string" } }, "required": [ "product_id", "keys" ], "type": "object" }, "KeyCreate": { "additionalProperties": false, "properties": { "allow_http": { "default": false, "description": "Permite que esta chave registre ou atualize origens de sites Launch HTTP, incluindo domínios de servidores de teste, endereços IP privados e nomes de host internos. As solicitações à API Licentivo continuam usando HTTPS.", "type": "boolean" }, "expires_days": { "description": "Dias da criação até a expiração, 1–365.", "maximum": 365, "minimum": 1, "type": "integer" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "minLength": 1, "type": "string" }, "scope": { "description": "read permite leituras; write permite leituras e gravações. Gravações também exigem um criador Owner ativo.", "enum": [ "read", "write" ], "type": "string" } }, "required": [ "name", "scope", "expires_days" ], "type": "object" }, "KeyList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Key" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items" ], "type": "object" }, "KeyRotated": { "additionalProperties": false, "example": { "id": "33333333-3333-4333-8333-333333333333", "key": "lv_api_BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", "prefix": "lv_api_BBBBBBB" }, "properties": { "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "key": { "description": "Full secret returned on creation or rotation. Owners may also view saved license keys on demand in a browser session. Store privately; the prefix cannot authenticate.", "type": "string" }, "prefix": { "description": "Primeiros 14 caracteres da chave de gerenciamento; apenas identificação.", "type": "string" } }, "required": [ "id", "key", "prefix" ], "type": "object" }, "KeySecret": { "additionalProperties": false, "example": { "expires_at": "2027-01-16T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "key": "lv_api_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "prefix": "lv_api_AAAAAAA" }, "properties": { "allow_http": { "description": "Permite que esta chave registre ou atualize origens de sites Launch HTTP, incluindo domínios de servidores de teste, endereços IP privados e nomes de host internos. As solicitações à API Licentivo continuam usando HTTPS.", "type": "boolean" }, "expires_at": { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "key": { "description": "Exibido apenas na criação/rotação", "type": "string" }, "prefix": { "description": "Primeiros 14 caracteres da chave de gerenciamento; apenas identificação.", "type": "string" } }, "required": [ "id", "key", "prefix" ], "type": "object" }, "KeyUpdate": { "additionalProperties": false, "properties": { "allow_http": { "description": "Permite que esta chave registre ou atualize origens de sites Launch HTTP, incluindo domínios de servidores de teste, endereços IP privados e nomes de host internos. As solicitações à API Licentivo continuam usando HTTPS.", "type": "boolean" } }, "required": [ "allow_http" ], "type": "object" }, "KeyUpdated": { "additionalProperties": false, "properties": { "allow_http": { "description": "Permite que esta chave registre ou atualize origens de sites Launch HTTP, incluindo domínios de servidores de teste, endereços IP privados e nomes de host internos. As solicitações à API Licentivo continuam usando HTTPS.", "type": "boolean" }, "id": { "description": "Unique record identifier.", "format": "uuid", "type": "string" } }, "required": [ "id", "allow_http" ], "type": "object" }, "LaunchCommerceEvent": { "additionalProperties": false, "properties": { "account_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "entitlement_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "event_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "launch_product_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "legacy_license_id": { "description": "Somente para entitlement.migrated. A licença, o vencimento, as capacidades e os registros de dispositivos existentes são preservados; as chaves e credenciais antigas de dispositivos perdem o acesso em execução.", "format": "uuid", "type": "string" }, "plan_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "type": { "description": "Tipo de evento comercial com instantâneo completo e versão.", "enum": [ "entitlement.created", "entitlement.renewed", "entitlement.upgraded", "entitlement.downgraded", "entitlement.refunded", "entitlement.suspended", "entitlement.expired", "entitlement.resumed", "entitlement.migrated" ], "type": "string" }, "valid_from": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "valid_until": { "anyOf": [ { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, { "description": "Vencimento absoluto da compra, UTC; null somente para uma política perpetual.", "type": "null" } ], "description": "Vencimento absoluto da compra, UTC; null somente para uma política perpetual." }, "version": { "description": "Versão monotônica do instantâneo completo para esta referência de direito, não o número da tentativa de entrega.", "minimum": 1, "type": "integer" } }, "required": [ "event_id", "environment", "type", "entitlement_ref", "account_ref", "launch_product_id", "plan_ref", "version", "valid_from" ], "type": "object" }, "LaunchConnection": { "additionalProperties": false, "properties": { "audience": { "description": "Destinatário exato pretendido das asserções de login do Launch.", "type": "string" }, "created_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "enabled": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "heartbeat_seconds": { "description": "Intervalo de verificação online selecionado pelo servidor, em segundos.", "type": "integer" }, "id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "issuer": { "description": "Origem exata e confiável do Launch.", "type": "string" }, "offline_seconds": { "description": "Intervalo offline finito permitido, em segundos; zero exige verificação online.", "type": "integer" }, "session_seconds": { "description": "Duração máxima da sessão de autorização em segundos.", "type": "integer" }, "updated_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" } }, "required": [ "id", "issuer", "audience", "environment", "enabled" ], "type": "object" }, "LaunchConnectionInput": { "additionalProperties": false, "properties": { "audience": { "description": "Destinatário exato pretendido das asserções de login do Launch.", "maxLength": 255, "minLength": 1, "type": "string" }, "enabled": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "heartbeat_seconds": { "default": 600, "description": "Intervalo de verificação online selecionado pelo servidor, em segundos.", "maximum": 86400, "minimum": 600, "type": "integer" }, "issuer": { "description": "Origem exata e confiável do Launch, sem caminho ou barra final. HTTPS é o padrão. HTTP exige allow_http na chave de API que faz esta solicitação; IPs privados e nomes de host internos são compatíveis. Nenhuma solicitação de callback ou descoberta é feita a essa origem.", "format": "uri", "type": "string" }, "offline_seconds": { "default": 0, "description": "0 exige verificação online. Um prazo offline positivo deve ser de pelo menos 3 × heartbeat_seconds. As autorizações de conta offline permanentes estão desativadas.", "maximum": 86400, "minimum": 0, "type": "integer" }, "public_keys": { "additionalProperties": { "description": "Chave pública Ed25519 canônica Base64URL fixada, com 32 bytes.", "type": "string" }, "description": "Conjunto completo fixado de chaves públicas Ed25519 do Launch, indexadas pelo ID da chave.", "maxProperties": 16, "minProperties": 1, "type": "object" }, "session_seconds": { "default": 86400, "description": "Pelo menos 3 × heartbeat_seconds.", "maximum": 2592000, "minimum": 1800, "type": "integer" } }, "required": [ "issuer", "audience", "environment", "public_keys", "enabled" ], "type": "object" }, "LaunchDeviceReleaseInput": { "additionalProperties": false, "properties": { "account_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "entitlement_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "expected_generation": { "description": "Geração esperada do vínculo do dispositivo, comparada dentro da transação de revogação.", "minimum": 1, "type": "integer" }, "operation_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, "required": [ "operation_id", "account_ref", "entitlement_ref", "environment", "expected_generation" ], "type": "object" }, "LaunchEvent": { "additionalProperties": false, "properties": { "applied_at": { "anyOf": [ { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, { "description": "Horário em que o instantâneo foi aplicado ou classificado como stale.", "type": "null" } ], "description": "Horário em que o instantâneo foi aplicado ou classificado como stale." }, "attempts": { "description": "Número de tentativas de processamento com falha mantido pelo Licentivo.", "type": "integer" }, "available_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "connection_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "created_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "error_code": { "description": "Motivo estável de processamento ou revisão; vazio após o sucesso.", "type": "string" }, "event_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "status": { "description": "Estado atual de ciclo de vida ou processamento controlado pelo servidor.", "enum": [ "pending", "applied", "stale", "manual_review" ], "type": "string" } }, "required": [ "connection_id", "event_id", "status", "attempts", "available_at" ], "type": "object" }, "LaunchExchangeInput": { "additionalProperties": false, "properties": { "activation_id": { "description": "data.activation_id da última ativação. Obrigatório em validação, heartbeat, consume e desativação; omita só no primeiro activate.", "format": "uuid", "type": "string" }, "app_version": { "description": "Versão atual major.minor.patch, como 1.0.0. Obrigatória com manutenção ou faixa. Não declare versão antiga falsa.", "pattern": "^$|^(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})$", "type": "string" }, "device_id": { "description": "SHA-256 de 64 caracteres hexadecimais minúsculos calculado de produto, sistema e hardware. Não use valor fixo arbitrário.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "device_name": { "description": "Nome no painel, até 120 caracteres. Não determina identidade do dispositivo.", "maxLength": 120, "type": "string" }, "device_profile": { "$ref": "#/components/schemas/DeviceProfile", "description": "Perfil gerado pelo SDK. Forneça conforme regras de hardware, rejeição de VM ou migração por hardware." }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "feature": { "description": "Identificador do recurso consumido.", "maxLength": 64, "type": "string" }, "identity_token": { "description": "JWT de identidade Launch Ed25519 tipado e de uso único; nenhuma declaração de entitlement é confiável como direito de compra.", "maxLength": 12288, "type": "string", "writeOnly": true }, "launch_connection_id": { "description": "ID da conexão Launch desta operação de autorização do Launch.", "format": "uuid", "type": "string" }, "license_key": { "const": "", "description": "Omita ou deixe vazio. O intercâmbio de contas nunca usa uma chave de licença de longa duração.", "type": "string" }, "product_id": { "description": "UUID do produto; deve corresponder ao produto da licença.", "format": "uuid", "type": "string" }, "quantity": { "description": "Unidades solicitadas para esta operação, inteiro 1–1000000000.", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "request_logout_ticket": { "description": "Negociação de capacidades do SDK. Solicite um ticket de logout apenas para desvinculação quando não houver ticket guardado para a vinculação atual. Omita quando já houver ticket válido; heartbeats em estado estável evitam busca adicional.", "type": "boolean" }, "reservation_id": { "description": "ID da reserva; envie este valor para confirmar ou cancelar.", "format": "uuid", "type": "string" }, "reservation_seconds": { "default": 900, "description": "Duração opcional: 30–3600 segundos, padrão 900. O reinício do período pode encerrá-la antes.", "maximum": 3600, "minimum": 30, "type": "integer" }, "session_id": { "description": "Obrigatório em flutuante: novo UUID por instância, reutilizado nas requisições dela. Opcional no modo vinculado.", "format": "uuid", "type": "string" } }, "required": [ "product_id", "device_id", "identity_token", "launch_connection_id", "environment" ], "type": "object" }, "LaunchPlanMappingInput": { "additionalProperties": false, "properties": { "launch_product_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "policy_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "policy_version": { "description": "Versão atual esperada da política de autorização mapeada.", "minimum": 1, "type": "integer" }, "product_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, "required": [ "launch_product_id", "product_id", "policy_id", "policy_version" ], "type": "object" }, "LaunchSessionRevocation": { "additionalProperties": false, "properties": { "account_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "completed_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "connection_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "created_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "event_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "reason": { "description": "Motivo opcional de auditoria; vazio equivale à omissão. forced_logout exige o escopo session; password_changed e account_disabled exigem o escopo account.", "enum": [ "", "forced_logout", "password_changed", "account_disabled" ], "type": "string" }, "released_devices": { "description": "Gerações atuais de vínculos de dispositivos liberadas; os logins mais recentes são preservados.", "minimum": 0, "type": "integer" }, "revoked_before": { "description": "Presente no escopo account. A nova autenticação deve ter auth_time estritamente maior que este limite UTC, comparado com precisão de segundos Unix. Os valores sid conhecidos anteriormente permanecem revogados de forma permanente.", "format": "date-time", "type": "string" }, "revoked_credentials": { "description": "Credenciais de dispositivos recém-revogadas pelo evento original.", "minimum": 0, "type": "integer" }, "revoked_sessions": { "description": "Sessões de autorização recém-revogadas pelo evento original.", "minimum": 0, "type": "integer" }, "scope": { "description": "session revoga um sid do Launch em todos os produtos e dispositivos desta conexão; account revoga todas as sessões existentes da conta e rejeita asserções antigas de autenticação.", "enum": [ "session", "account" ], "type": "string" }, "sid": { "description": "Obrigatório e não vazio para o escopo session; omita ou deixe vazio para o escopo account. Este é o sid de login do Launch, não uma sessão de autorização do Licentivo nem um ID de dispositivo.", "pattern": "^[A-Za-z0-9_-]{0,128}$", "type": "string" }, "status": { "const": "succeeded", "description": "Estado atual de ciclo de vida ou processamento controlado pelo servidor.", "type": "string" } }, "required": [ "connection_id", "event_id", "environment", "account_ref", "scope", "status", "revoked_sessions", "revoked_credentials", "released_devices", "created_at", "completed_at" ], "type": "object" }, "LaunchSessionRevocationInput": { "additionalProperties": false, "oneOf": [ { "properties": { "reason": { "enum": [ "", "forced_logout" ] }, "scope": { "const": "session" }, "sid": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" } }, "required": [ "sid" ] }, { "properties": { "reason": { "enum": [ "", "password_changed", "account_disabled" ] }, "scope": { "const": "account" }, "sid": { "const": "" } } } ], "properties": { "account_ref": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "environment": { "description": "Verificação opcional de consistência. Omita ou deixe vazio para usar o ambiente da conexão; um valor não vazio deve corresponder. Este campo não altera o faturamento nem oferece testes gratuitos de autorização.", "enum": [ "", "live", "sandbox" ], "type": "string" }, "event_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "reason": { "description": "Motivo opcional de auditoria; vazio equivale à omissão. forced_logout exige o escopo session; password_changed e account_disabled exigem o escopo account.", "enum": [ "", "forced_logout", "password_changed", "account_disabled" ], "type": "string" }, "scope": { "description": "session revoga um sid do Launch em todos os produtos e dispositivos desta conexão; account revoga todas as sessões existentes da conta e rejeita asserções antigas de autenticação.", "enum": [ "session", "account" ], "type": "string" }, "sid": { "description": "Obrigatório e não vazio para o escopo session; omita ou deixe vazio para o escopo account. Este é o sid de login do Launch, não uma sessão de autorização do Licentivo nem um ID de dispositivo.", "pattern": "^[A-Za-z0-9_-]{0,128}$", "type": "string" } }, "required": [ "event_id", "account_ref", "scope" ], "type": "object" }, "Lease": { "additionalProperties": false, "properties": { "key_id": { "description": "UUID da chave pública; deve existir em trusted_keys do produto.", "format": "uuid", "type": "string" }, "payload": { "description": "Base64URL sem preenchimento dos bytes JSON originais. Decodificar é só para leitura; verifique a assinatura.", "type": "string" }, "signature": { "description": "Assinatura Ed25519 Base64URL. Verifique LicenovaLease/v1, uma quebra de linha e bytes JSON originais do payload decodificado. Não reserialize. Assinatura: 64 bytes.", "type": "string" }, "version": { "const": 1, "description": "Versão do protocolo do envelope, atualmente 1.", "type": "integer" } }, "required": [ "version", "key_id", "payload", "signature" ], "type": "object" }, "LeaseClaims": { "additionalProperties": false, "description": "Decodifique os bytes originais do payload assinado. Sem runtime_policy o TTL é limitado a 86400 segundos; caso contrário, aplique a política assinada. Nunca confie no payload sem verificar assinatura/contexto.", "properties": { "activation_id": { "format": "uuid", "type": "string" }, "capabilities": { "$ref": "#/components/schemas/SignedCapabilities" }, "device_id": { "pattern": "^[0-9a-f]{64}$", "type": "string" }, "expires_at": { "maximum": 253402300799, "type": "integer" }, "features": { "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "issued_at": { "type": "integer" }, "key_id": { "format": "uuid", "type": "string" }, "license_id": { "format": "uuid", "type": "string" }, "max_devices": { "maximum": 10000, "minimum": 1, "type": "integer" }, "mode": { "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "offline_request_id": { "format": "uuid", "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "runtime_policy": { "$ref": "#/components/schemas/RuntimePolicy" }, "tenant_id": { "format": "uuid", "type": "string" }, "version": { "const": 1, "type": "integer" } }, "required": [], "type": "object" }, "LegalAcceptance": { "additionalProperties": false, "properties": { "accepted_at": { "format": "date-time", "type": "string" }, "api_overage_accepted": { "type": "boolean" }, "device_overage_accepted": { "type": "boolean" }, "digest": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mode": { "type": "string" }, "overage_accepted": { "type": "boolean" }, "price_version": { "type": "string" }, "reference": { "type": "string" }, "scope": { "type": "string" }, "version": { "type": "string" } }, "required": [], "type": "object" }, "LegalAcceptanceList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/LegalAcceptance" }, "type": "array" }, "now": { "format": "date-time", "type": "string" }, "total": { "type": "integer" } }, "required": [], "type": "object" }, "LegalConsent": { "additionalProperties": false, "properties": { "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" } }, "required": [], "type": "object" }, "License": { "additionalProperties": false, "description": "A expiração é null até a primeira ativação bem-sucedida. A duração é fixada na emissão; a reativação nunca a reinicia.", "example": { "created_at": "2026-10-18T00:00:00Z", "customer": "Order #1001", "duration_days": 30, "expires_at": null, "features": [ "export" ], "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key_prefix": "lv_lic_AAAAAAA", "max_devices": 1, "mode": "timed", "policy_id": "22222222-2222-4222-8222-222222222222", "policy_version": 1, "product_id": "11111111-1111-4111-8111-111111111111", "status": "active", "updated_at": "2026-10-18T00:00:00Z" }, "properties": { "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "customer": { "description": "Rótulo de cliente definido pelo fornecedor, distinto do e-mail do portal do cliente.", "type": "string" }, "duration_days": { "description": "Dias por licença desde a primeira ativação. Exige 1–36500 para emissão timed/trial; ausente/null para perpetual. Nunca é armazenado na política.", "type": [ "integer", "null" ] }, "expires_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "type": "null" } ], "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial." }, "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "first_activated_at": { "anyOf": [ { "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência.", "format": "date-time", "type": "string" }, { "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência.", "type": "null" } ], "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência." }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "key_prefix": { "description": "Prefixo curto da chave de licença para identificação/pesquisa, não autenticação.", "type": "string" }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "type": "integer" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "policy_id": { "description": "UUID da política; deve pertencer ao produto na emissão.", "format": "uuid", "type": "string" }, "policy_version": { "description": "Revisão da política; envie o valor atual ao editar todas as capacidades para evitar gravações desatualizadas.", "type": "integer" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "expired", "suspended", "revoked" ], "type": "string" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" } }, "required": [ "id", "product_id", "key_prefix", "mode", "status" ], "type": "object" }, "LicenseCapabilities": { "additionalProperties": false, "example": { "license_id": "33333333-3333-4333-8333-333333333333", "license_model": "node_locked", "maintenance_days": 0, "maintenance_until": null, "max_version": "", "min_version": "", "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z" }, "properties": { "license_id": { "description": "UUID da licença, diferente do segredo lv_lic_.", "format": "uuid", "type": "string" }, "license_model": { "description": "Vinculação de dispositivo node_locked ou assentos floating.", "enum": [ "node_locked", "floating" ], "type": "string" }, "maintenance_days": { "description": "Dias de manutenção desde a primeira ativação; 0 significa sem limite de manutenção.", "type": "integer" }, "maintenance_until": { "anyOf": [ { "description": "Limite de manutenção para novas versões; pode ser null antes da ativação ou quando ilimitado.", "format": "date-time", "type": "string" }, { "description": "Limite de manutenção para novas versões; pode ser null antes da ativação ou quando ilimitado.", "type": "null" } ], "description": "Limite de manutenção para novas versões; pode ser null antes da ativação ou quando ilimitado." }, "max_version": { "description": "Versão máxima permitida do aplicativo; vazio significa sem limite superior.", "type": "string" }, "min_version": { "description": "Versão mínima permitida do aplicativo; vazio significa sem limite inferior.", "type": "string" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" } }, "required": [ "license_id", "product_id", "license_model", "maintenance_days", "maintenance_until", "min_version", "max_version", "updated_at" ], "type": "object" }, "LicenseCapabilityResult": { "additionalProperties": false, "example": { "customer_email": "buyer@example.com", "license": { "license_id": "33333333-3333-4333-8333-333333333333", "license_model": "node_locked", "maintenance_days": 0, "maintenance_until": null, "max_version": "", "min_version": "", "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z" }, "meter_rules": [], "usage": null }, "properties": { "customer_email": { "description": "E-mail vinculado ao portal do cliente; vazio quando não atribuído.", "type": "string" }, "license": { "$ref": "#/components/schemas/LicenseCapabilities", "description": "Snapshot das capacidades da licença." }, "meter_rules": { "description": "Regras de medição de recursos; vazio significa nenhuma configurada.", "items": { "additionalProperties": false, "properties": { "allow_overage": { "description": "Se o uso excedente do recurso é permitido.", "type": "boolean" }, "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "limit": { "description": "Usos do recurso incluídos por período de medição (não é limite de paginação).", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "max_overage": { "description": "Uso excedente máximo permitido; desativado quando allow_overage é false.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "enum": [ "month", "day", "lifetime" ], "type": "string" } }, "required": [ "feature", "limit", "period" ], "type": "object" }, "type": "array" }, "usage": { "anyOf": [ { "description": "Registros reais de uso de recursos; podem ser null quando vazios.", "items": { "$ref": "#/components/schemas/FeatureUsage" }, "type": "array" }, { "description": "Registros reais de uso de recursos; podem ser null quando vazios.", "type": "null" } ], "description": "Registros reais de uso de recursos; podem ser null quando vazios." } }, "required": [], "type": "object" }, "LicenseCreate": { "additionalProperties": false, "description": "Emita uma licença com seu próprio duration_days. Licenças timed/trial exigem 1–36500 dias; perpetual exige ausência/null. A contagem começa na primeira ativação bem-sucedida.", "properties": { "customer": { "description": "Nome do cliente ou referência do pedido para busca, até 254 caracteres.", "maxLength": 254, "type": "string" }, "customer_email": { "description": "E-mail vinculado ao portal do cliente; vazio quando não atribuído.", "format": "email", "maxLength": 254, "type": "string" }, "duration_days": { "description": "Duração da licença em dias, a partir da primeira ativação bem-sucedida. Obrigatória para emissão timed/trial; omita ou use null para licenças perpetual. Nunca é herdada da política.", "maximum": 36500, "minimum": 1, "type": [ "integer", "null" ] }, "policy_id": { "description": "UUID de uma política de licença deste produto.", "format": "uuid", "type": "string" }, "product_id": { "description": "ID do produto (UUID).", "format": "uuid", "type": "string" } }, "required": [ "product_id", "policy_id" ], "type": "object" }, "LicenseKeyReveal": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "key": { "description": "Original full license key, revealed only to a current Owner session.", "type": "string" }, "key_prefix": { "type": "string" } }, "required": [ "id", "key", "key_prefix" ], "type": "object" }, "LicenseList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/License" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "type": "object" }, "LicenseSecret": { "additionalProperties": false, "example": { "duration_days": 30, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "key_prefix": "lv_lic_AAAAAAA" }, "properties": { "duration_days": { "description": "Dias válidos desde a primeira ativação; null para perpétuas.", "type": [ "integer", "null" ] }, "expires_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "type": "null" } ], "description": "Expiração final UTC ISO 8601; null antes da ativação e para licenças perpétuas." }, "first_activated_at": { "anyOf": [ { "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência.", "format": "date-time", "type": "string" }, { "description": "Data e hora da primeira ativação bem-sucedida; null antes da ativação e inalterada por renovação ou transferência.", "type": "null" } ], "description": "Primeira ativação bem-sucedida, UTC ISO 8601; null antes. Troca de dispositivo não reinicia." }, "id": { "description": "UUID da licença para consultar, renovar ou revogar. Não é código de ativação.", "format": "uuid", "type": "string" }, "key": { "description": "Chave completa lv_lic_, exibida só na emissão. O fornecedor deve guardar em privado e entregar ao cliente.", "type": "string" }, "key_prefix": { "description": "Prefixo da chave para identificação; não permite ativação.", "type": "string" } }, "required": [ "id", "key", "key_prefix" ], "type": "object" }, "LicenseUpdate": { "additionalProperties": false, "properties": { "customer": { "description": "Rótulo de cliente definido pelo fornecedor, distinto do e-mail do portal do cliente.", "maxLength": 254, "type": "string" }, "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "maximum": 10000, "minimum": 1, "type": "integer" }, "policy_id": { "description": "Muda esta licença para uma política do mesmo produto. A alteração exige um preview_token atual; preserva a chave da licença, o prazo original e a utilização.", "format": "uuid", "type": "string" }, "preview_token": { "description": "Token devolvido por POST /licenses/policy-preview para esta licença e a política de destino.", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "suspended", "revoked" ], "type": "string" } }, "required": [], "type": "object" }, "LicensingWebhook": { "additionalProperties": false, "properties": { "created_at": { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, "enabled": { "description": "Indica se HTTP é permitido, somente para desenvolvimento local.", "type": "boolean" }, "events": { "description": "Tipos de evento inscritos distintos e não vazios.", "items": { "enum": [ "license.created", "license.updated", "license.renewed", "license.revoked", "license.activate", "license.deactivate", "license.consume", "license.expiring", "license.expired", "license.maintenance_expiring", "license.maintenance_expired" ], "type": "string" }, "type": "array" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "type": "string" }, "updated_at": { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, "url": { "description": "URL do receptor de eventos; use HTTPS público em produção.", "type": "string" } }, "required": [ "id", "name", "url", "events", "enabled", "created_at", "updated_at" ], "type": "object" }, "LicensingWebhookInput": { "additionalProperties": false, "properties": { "enabled": { "description": "Indica se o endpoint de webhook está ativado.", "type": "boolean" }, "events": { "description": "Tipos de evento inscritos distintos e não vazios.", "items": { "enum": [ "license.created", "license.updated", "license.renewed", "license.revoked", "license.activate", "license.deactivate", "license.consume", "license.expiring", "license.expired", "license.maintenance_expiring", "license.maintenance_expired" ], "type": "string" }, "type": "array" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "type": "string" }, "secret": { "description": "Segredo de verificação do webhook, com 32–200 caracteres quando informado; omiti-lo na atualização o preserva. Uma saída vazia indica que não foi reemitido.", "maxLength": 200, "minLength": 32, "type": "string", "writeOnly": true }, "url": { "description": "URL do receptor de eventos; use HTTPS público em produção.", "format": "uri", "maxLength": 2000, "type": "string" } }, "required": [ "name", "url", "events", "enabled" ], "type": "object" }, "LicensingWebhookList": { "additionalProperties": false, "properties": { "event_types": { "description": "Todos os tipos de evento de licenciamento compatíveis.", "items": { "enum": [ "license.created", "license.updated", "license.renewed", "license.revoked", "license.activate", "license.deactivate", "license.consume", "license.expiring", "license.expired", "license.maintenance_expiring", "license.maintenance_expired" ], "type": "string" }, "type": "array" }, "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/LicensingWebhook" }, "type": "array" } }, "required": [], "type": "object" }, "LicensingWebhookSecret": { "additionalProperties": false, "properties": { "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "secret": { "description": "Retornado uma vez para novos endpoints; vazio quando preservado", "type": "string" } }, "required": [], "type": "object" }, "LoggedOut": { "additionalProperties": false, "properties": { "logged_out": { "type": "boolean" } }, "required": [ "logged_out" ], "type": "object" }, "Login": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "password": { "description": "12–128 bytes UTF-8, não caracteres", "type": "string", "writeOnly": true } }, "required": [ "email", "password" ], "type": "object" }, "LogoutTicket": { "additionalProperties": false, "properties": { "activation_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "expected_generation": { "description": "Geração esperada do vínculo do dispositivo, comparada dentro da transação de revogação.", "minimum": 1, "type": "integer" }, "operation_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "product_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "release_token": { "description": "Capacidade exclusiva de desvinculação. Não pode ativar, validar, atualizar nem consumir recursos. Mantenha-a apenas no diário de logout do SDK enquanto a revogação estiver pendente.", "pattern": "^lv_out_[A-Za-z0-9_-]{43}$", "type": "string" } }, "required": [ "operation_id", "product_id", "activation_id", "expected_generation", "release_token" ], "type": "object" }, "MailConnection": { "additionalProperties": false, "properties": { "check_status": { "enum": [ "verified", "limited" ], "type": "string" }, "delivery_mode": { "enum": [ "file", "smtp", "resend", "brevo", "postmark", "mailgun" ], "type": "string" }, "message": { "type": "string" }, "mode": { "enum": [ "file", "smtp", "resend", "brevo", "postmark", "mailgun" ], "type": "string" }, "ok": { "description": "False para uma verificação limitada: credenciais e entrega não foram confirmadas.", "type": "boolean" }, "status": { "enum": [ "connected" ], "type": "string" } }, "required": [ "status", "mode", "delivery_mode", "ok", "check_status" ], "type": "object" }, "MailInput": { "additionalProperties": false, "description": "Atualização parcial das configurações de e-mail da plataforma criptografadas. Campos omitidos e configurações de outros provedores são preservados; chaves API e senhas SMTP vazias mantêm os segredos existentes. O serviço ativo selecionado deve estar totalmente configurado. O modo de arquivo não está disponível em produção. Exige sessão de administrador da plataforma e token CSRF; chaves API de gerenciamento do fornecedor não podem alterar as configurações de e-mail da plataforma.", "properties": { "from": { "type": "string" }, "host": { "maxLength": 253, "type": "string" }, "mode": { "enum": [ "file", "smtp", "resend", "brevo", "postmark", "mailgun" ], "type": "string" }, "password": { "description": "Omita ou deixe vazio para preservar a senha SMTP existente.", "maxLength": 1000, "type": "string", "writeOnly": true }, "port": { "maximum": 65535, "minimum": 1, "type": "integer" }, "providers": { "additionalProperties": false, "properties": { "brevo": { "$ref": "#/components/schemas/MailProviderInput" }, "mailgun": { "$ref": "#/components/schemas/MailgunInput" }, "postmark": { "$ref": "#/components/schemas/MailProviderInput" }, "resend": { "$ref": "#/components/schemas/MailProviderInput" } }, "required": [], "type": "object" }, "tls_mode": { "enum": [ "starttls", "implicit" ], "type": "string" }, "username": { "maxLength": 254, "type": "string" } }, "required": [], "type": "object" }, "MailJob": { "additionalProperties": false, "properties": { "attempts": { "type": "integer" }, "cancel_reason": { "enum": [ "", "platform_disabled", "customer_disabled", "coverage_changed", "reminder_window_changed", "renewal_state_changed", "purchase_unavailable", "workspace_unavailable", "recipient_unavailable", "unknown_notification" ], "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "delivered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "", "purchase_success", "expiry_reminder", "auto_renewal_success", "auto_renewal_problem", "billing_test" ], "type": "string" }, "mode": { "enum": [ "", "sandbox", "live" ], "type": "string" }, "recipient": { "type": "string" }, "status": { "enum": [ "pending", "running", "delivered", "failed", "cancelled" ], "type": "string" } }, "required": [ "id", "status", "attempts" ], "type": "object" }, "MailJobList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/MailJob" }, "maxItems": 50, "type": "array" } }, "required": [ "items" ], "type": "object" }, "MailProviderInput": { "additionalProperties": false, "properties": { "api_key": { "description": "Chave API do provedor; Postmark usa Server API Token. Omita ou deixe vazio para preservar o segredo salvo.", "maxLength": 4096, "type": "string", "writeOnly": true }, "from": { "description": "E-mail verificado do remetente; obrigatório ao selecionar este provedor como ativo.", "type": "string" } }, "required": [], "type": "object" }, "MailProviderSettings": { "additionalProperties": false, "properties": { "api_key_configured": { "type": "boolean" }, "domain": { "description": "Domínio de envio Mailgun; vazio para outros provedores.", "type": "string" }, "from": { "type": "string" }, "region": { "description": "Região Mailgun; vazia para outros provedores.", "enum": [ "", "us", "eu" ], "type": "string" } }, "required": [ "from", "domain", "region", "api_key_configured" ], "type": "object" }, "MailQueued": { "additionalProperties": false, "properties": { "job_id": { "format": "uuid", "type": "string" }, "status": { "enum": [ "pending" ], "type": "string" } }, "required": [ "job_id", "status" ], "type": "object" }, "MailSettings": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "host": { "type": "string" }, "mode": { "enum": [ "file", "smtp", "resend", "brevo", "postmark", "mailgun" ], "type": "string" }, "password_configured": { "type": "boolean" }, "port": { "type": "integer" }, "providers": { "additionalProperties": false, "properties": { "brevo": { "$ref": "#/components/schemas/MailProviderSettings" }, "mailgun": { "$ref": "#/components/schemas/MailProviderSettings" }, "postmark": { "$ref": "#/components/schemas/MailProviderSettings" }, "resend": { "$ref": "#/components/schemas/MailProviderSettings" } }, "required": [ "resend", "brevo", "postmark", "mailgun" ], "type": "object" }, "tls_mode": { "enum": [ "starttls", "implicit" ], "type": "string" }, "username": { "type": "string" } }, "required": [ "mode", "port", "password_configured", "providers" ], "type": "object" }, "MailgunInput": { "additionalProperties": false, "properties": { "api_key": { "description": "Chave API da conta Mailgun ou chave de envio do domínio. Omita ou deixe vazio para preservar o segredo salvo.", "maxLength": 4096, "type": "string", "writeOnly": true }, "domain": { "description": "Domínio de envio, obrigatório quando Mailgun está ativo; sem esquema, caminho ou porta.", "maxLength": 253, "type": "string" }, "from": { "description": "E-mail verificado do remetente; obrigatório quando Mailgun está ativo.", "type": "string" }, "region": { "default": "us", "description": "Região que hospeda o domínio de envio; US e EU usam endpoints API fixos separados.", "enum": [ "us", "eu" ], "type": "string" } }, "required": [], "type": "object" }, "ManagementKeyBundle": { "additionalProperties": false, "properties": { "keys": { "description": "Chaves públicas de assinatura atuais e históricas do produto.", "items": { "$ref": "#/components/schemas/SigningKey" }, "type": "array" }, "product_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, "required": [ "product_id", "keys" ], "type": "object" }, "ManualRefundInput": { "additionalProperties": false, "properties": { "customer_agreement": { "maxLength": 3000, "type": "string" }, "evidence": { "maxLength": 3000, "type": "string" } }, "required": [ "customer_agreement", "evidence" ], "type": "object" }, "Me": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "is_platform_admin": { "type": "boolean" }, "name": { "type": "string" }, "role": { "enum": [ "owner", "read_only" ], "type": "string" }, "tenant_id": { "format": "uuid", "type": "string" }, "tenant_name": { "type": "string" } }, "required": [ "tenant_id", "id", "role", "is_platform_admin" ], "type": "object" }, "Member": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "is_platform_admin": { "type": "boolean" }, "name": { "type": "string" }, "role": { "enum": [ "owner", "read_only" ], "type": "string" }, "status": { "enum": [ "active", "disabled" ], "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "role", "status", "verified" ], "type": "object" }, "MemberList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/Member" }, "type": "array" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "items" ], "type": "object" }, "MemberUpdate": { "additionalProperties": false, "properties": { "role": { "enum": [ "owner", "read_only" ], "type": "string" }, "status": { "enum": [ "active", "disabled" ], "type": "string" } }, "required": [], "type": "object" }, "MonthInput": { "additionalProperties": false, "properties": { "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "pattern": "^[0-9]{4}-[0-9]{2}$", "type": "string" } }, "required": [ "month" ], "type": "object" }, "Notice": { "additionalProperties": false, "properties": { "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "OfflineReleaseResult": { "additionalProperties": false, "example": { "activation_id": "44444444-4444-4444-8444-444444444444", "deactivated": true }, "properties": { "activation_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "deactivated": { "description": "Indica se HTTP é permitido, somente para desenvolvimento local.", "type": "boolean" } }, "required": [ "activation_id", "deactivated" ], "type": "object" }, "OfflineRequest": { "additionalProperties": false, "properties": { "activation_id": { "description": "UUID do registro de ativação do dispositivo ou da sessão flutuante.", "format": "uuid", "type": "string" }, "app_version": { "description": "Vazio para uma ativação normal. Informe a versão real publicada da aplicação somente ao usar restrições de versão ou manutenção.", "pattern": "^$|^(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})$", "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "type": "integer" }, "device_id": { "description": "O SDK deriva a identidade do sistema operacional e do hardware no escopo do produto usando LicenovaDevice/v3. A configuração não pode substituir a máquina atual.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "device_name": { "description": "Rótulo de dispositivo legível por pessoas, não uma identidade de segurança.", "maxLength": 120, "type": "string" }, "device_profile": { "$ref": "#/components/schemas/DeviceProfile", "description": "Identidade do dispositivo gerada pelo SDK; quando presente, informe todos os campos filhos obrigatórios." }, "license_key": { "description": "Chave original de licença; código lv_tmp_ de uso único apenas para activate; depois uma credencial lv_dev_ vinculada à máquina para operações de execução. O SDK persiste credenciais separadamente das concessões.", "pattern": "^lv_(lic|tmp|dev)_[A-Za-z0-9_-]{43}$", "type": "string", "writeOnly": true }, "operation": { "description": "Nome da operação; lotes suportam create/renew/revoke/apply_policy e solicitações offline activate/deactivate.", "enum": [ "activate", "deactivate" ], "type": "string" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" }, "session_id": { "description": "Identificador da sessão da instância floating; pode ser omitido para licenças node-locked.", "format": "uuid", "type": "string" }, "version": { "const": 1, "description": "Revisão da política, versão major.minor.patch do produto ou versão 1 do protocolo offline, conforme o objeto.", "type": "integer" } }, "required": [ "version", "request_id", "created_at", "operation", "product_id", "license_key", "device_id" ], "type": "object" }, "OfflineResponse": { "additionalProperties": false, "example": { "operation": "deactivate", "request_id": "55555555-5555-4555-8555-555555555555", "result": { "activation_id": "44444444-4444-4444-8444-444444444444", "deactivated": true }, "version": 1 }, "properties": { "operation": { "description": "Nome da operação; lotes suportam create/renew/revoke/apply_policy e solicitações offline activate/deactivate.", "enum": [ "activate", "deactivate" ], "type": "string" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" }, "result": { "anyOf": [ { "$ref": "#/components/schemas/RuntimeResult", "description": "Resultado da operação offline: a ativação retorna uma concessão assinada; a liberação retorna deactivated." }, { "$ref": "#/components/schemas/OfflineReleaseResult", "description": "Resultado da operação offline: a ativação retorna uma concessão assinada; a liberação retorna deactivated." } ], "description": "Resultado da operação offline: a ativação retorna uma concessão assinada; a liberação retorna deactivated." }, "version": { "const": 1, "description": "Revisão da política, versão major.minor.patch do produto ou versão 1 do protocolo offline, conforme o objeto.", "type": "integer" } }, "required": [ "version", "request_id", "operation", "result" ], "type": "object" }, "OnboardingInput": { "additionalProperties": false, "properties": { "description": { "description": "Descrição do produto; pode estar vazia.", "maxLength": 1000, "type": "string" }, "duration_days": { "description": "Duração apenas da licença de teste gerada; padrão 7 para timed/trial. Não é salva na política gerada.", "maximum": 36500, "minimum": 1, "type": [ "integer", "null" ] }, "features": { "default": [ "export" ], "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "heartbeat_seconds": { "anyOf": [ { "const": 0, "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline." }, { "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline.", "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "0 desativa explicitamente heartbeats periódicos; caso contrário, 600–86400 segundos (mínimo 10 minutos). Independente da permissão offline.", "type": "integer" }, "license_model": { "default": "node_locked", "description": "Vinculação de dispositivo node_locked ou assentos floating.", "enum": [ "node_locked", "floating" ], "type": "string" }, "max_devices": { "default": 1, "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "maximum": 10000, "minimum": 1, "type": "integer" }, "mode": { "default": "trial", "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "minLength": 1, "type": "string" }, "offline_mode": { "description": "Permissão offline limited, none ou permanent; a expiração da licença ainda se aplica.", "enum": [ "limited", "none", "permanent" ], "type": "string" }, "offline_seconds": { "description": "Limited: 1–31536000 segundos e pelo menos 3 × heartbeat_seconds com os heartbeats ativados; none/permanent: 0", "maximum": 31536000, "minimum": 0, "type": "integer" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "request_id", "name" ], "type": "object" }, "OnboardingResult": { "additionalProperties": false, "example": { "config": { "allow_http": false, "app_version": "1.0.0", "base_url": "https://license.example.com", "cache_path": "", "device_name": "My application", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "product_id": "11111111-1111-4111-8111-111111111111", "trusted_keys": { "66666666-6666-4666-8666-666666666666": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "license_id": "33333333-3333-4333-8333-333333333333", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "next": "Choose a language and download the configured SDK bundle.", "policy_id": "22222222-2222-4222-8222-222222222222", "product_id": "11111111-1111-4111-8111-111111111111" }, "properties": { "config": { "$ref": "#/components/schemas/SDKConfig", "description": "Configuração privada de teste SDK contendo segredo de licença." }, "license_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "license_key": { "description": "Chave completa de licença do cliente fornecida na ativação. Código de inicialização do produto e downloads de exemplo não contêm este segredo. Solicitações offline usam a credencial fornecida pelo SDK.", "type": "string" }, "next": { "description": "Plano padrão agendado para o próximo mês, ou null.", "type": "string" }, "policy_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "product_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, "required": [ "product_id", "policy_id", "license_id", "license_key", "config", "next" ], "type": "object" }, "OperatorProfile": { "additionalProperties": false, "properties": { "backup_region": { "maxLength": 500, "type": "string" }, "contact": { "maxLength": 500, "type": "string" }, "country": { "maxLength": 500, "type": "string" }, "financial_retention_years": { "description": "Zero ou omitido significa não confirmado e não é incluído em documentos públicos.", "maximum": 30, "minimum": 0, "type": "integer" }, "hosting_provider": { "maxLength": 500, "type": "string" }, "mail_provider": { "maxLength": 500, "type": "string" }, "markets": { "maxLength": 500, "type": "string" }, "operator": { "maxLength": 500, "type": "string" }, "processing_grounds": { "maxLength": 500, "type": "string" }, "server_region": { "maxLength": 500, "type": "string" }, "transfer_safeguards": { "maxLength": 500, "type": "string" } }, "required": [], "type": "object" }, "OriginalRefundInput": { "additionalProperties": false, "properties": { "amount": { "pattern": "^[0-9]+(?:\\.[0-9]{1,2})?$", "type": "string" }, "reason": { "maxLength": 255, "minLength": 1, "type": "string" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "amount", "reason", "request_id" ], "type": "object" }, "OriginalRefundResult": { "additionalProperties": false, "properties": { "case_id": { "format": "uuid", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/ProviderRefund" }, "type": "array" } }, "type": "object" }, "OveragePlan": { "additionalProperties": false, "properties": { "api_hard_limit": { "description": "Se chamadas de execução param no limite da franquia API.", "type": "boolean" }, "api_unit_micros": { "description": "Preço por chamada de execução excedente em milionésimos.", "minimum": 0, "type": "integer" }, "base_micros": { "description": "Cobrança base em milionésimos da unidade monetária.", "type": "integer" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "type": "string" }, "description": { "description": "Descrição da oferta de faturamento.", "type": "string" }, "enabled": { "description": "Se a oferta de faturamento está habilitada para compra.", "type": "boolean" }, "hard_limit": { "description": "Se novos dispositivos faturáveis são rejeitados no limite da franquia.", "type": "boolean" }, "included_api_calls": { "description": "null = ilimitado; 0 = nenhuma chamada bem-sucedida incluída", "maximum": 1000000000000, "minimum": 0, "type": [ "integer", "null" ] }, "included_devices": { "description": "Franquia de dispositivos ativos incluída.", "type": "integer" }, "name": { "description": "Nome de exibição da oferta de faturamento.", "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" }, "public": { "description": "Se a oferta de faturamento está listada publicamente.", "type": "boolean" }, "renewal_only": { "description": "Clientes existentes com pagamento ou presente podem renovar antecipadamente ou após a expiração no mesmo ambiente e moeda. Oculto para novas compras públicas.", "type": "boolean" }, "sort_order": { "description": "Ordem de exibição da oferta de faturamento.", "type": "integer" }, "terms": { "anyOf": [ { "description": "Prazos de compra disponíveis e seus preços.", "items": { "$ref": "#/components/schemas/PlanTermPrice" }, "type": "array" }, { "description": "Prazos de compra disponíveis e seus preços.", "type": "null" } ], "description": "Prazos de compra disponíveis e seus preços." }, "unit_micros": { "description": "Preço por dispositivo ativo excedente em milionésimos.", "type": "integer" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" } }, "required": [], "type": "object" }, "OveragePreference": { "additionalProperties": false, "properties": { "block_api_overage": { "description": "Indica se chamadas de API em execução além da cota incluída são bloqueadas.", "type": "boolean" }, "block_device_overage": { "description": "Indica se novos dispositivos faturáveis além da cota incluída são bloqueados.", "type": "boolean" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" }, "version": { "description": "Revisão da configuração de preferências de excedentes.", "type": "string" } }, "required": [ "mode", "block_device_overage", "block_api_overage", "version", "updated_at" ], "type": "object" }, "OverageSettings": { "additionalProperties": false, "properties": { "customer_api_settings_enabled": { "description": "Indica se os clientes podem configurar o bloqueio de excedentes de API.", "type": "boolean" }, "customer_device_settings_enabled": { "description": "Indica se os clientes podem configurar o bloqueio de excedentes de dispositivos.", "type": "boolean" }, "plan": { "anyOf": [ { "$ref": "#/components/schemas/OveragePlan", "description": "Identificador estável do plano de faturamento do catálogo publicado." }, { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "null" } ], "description": "Regras atuais da cota comprada/padrão usadas para determinar excedentes ou null quando indisponíveis." }, "preference": { "$ref": "#/components/schemas/OveragePreference", "description": "Preferências de excedentes salvas do cliente." } }, "required": [ "preference", "plan", "customer_device_settings_enabled", "customer_api_settings_enabled" ], "type": "object" }, "OverageSettingsInput": { "additionalProperties": false, "properties": { "block_api_overage": { "type": "boolean" }, "block_device_overage": { "type": "boolean" }, "expected_version": { "description": "Use preference.version de GET. Vazio no primeiro salvamento. Alterações de outra aba retornam 409; pelo menos uma opção de excedente é obrigatória.", "type": "string" } }, "required": [ "expected_version" ], "type": "object" }, "PaddleCheck": { "additionalProperties": false, "properties": { "connected": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [ "connected", "mode" ], "type": "object" }, "PaddleOrder": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" }, "applied_at": { "anyOf": [ { "description": "Horário UTC em que a intenção local de checkout foi salva.", "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Horário UTC em que o pagamento verificado ativou o serviço ou creditou uma recarga da carteira. purchase_id e upgrade_id null identificam uma recarga." }, "created_at": { "description": "Horário UTC em que a intenção local de checkout foi salva.", "format": "date-time", "type": "string" }, "currency": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "paid_at": { "anyOf": [ { "description": "Horário UTC em que a intenção local de checkout foi salva.", "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Horário UTC em que o backend verificou uma transação Paddle concluída." }, "purchase_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Compra ou renovação de serviço existente e pendente; mutuamente exclusiva com upgrade_id." }, "refunded_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" }, "request_id": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "status": { "description": "Ciclo de vida do pagamento, incluindo paid_unapplied quando os fundos cobrados exigem revisão e reembolso pelo operador.", "enum": [ "creating", "created", "completed", "paid_unapplied", "partially_refunded", "refunded" ], "type": "string" }, "transaction_id": { "anyOf": [ { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, { "type": "null" } ], "description": "Identificador da transação Paddle Billing vinculada ou null enquanto o resultado da criação original estiver pendente." }, "upgrade_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Cotação de upgrade existente e pendente; mutuamente exclusiva com purchase_id." } }, "required": [ "id", "request_id", "mode", "transaction_id", "purchase_id", "upgrade_id", "currency", "amount_cents", "refunded_cents", "status", "paid_at", "applied_at", "created_at" ], "type": "object" }, "PaddleOrderInput": { "additionalProperties": false, "description": "Paga uma compra/upgrade congelado ou cria uma recarga da carteira com amount e currency e sem IDs de serviço. Um request_id estável retorna o pagamento original; alterar sua intenção, valor ou moeda é rejeitado. Somente pagamentos concluídos verificados de forma independente creditam uma carteira ou ativam o serviço. Os retornos de recarga levam à carteira. Um resultado incerto de criação é recuperado pelo webhook original e nunca é recriado às cegas.", "oneOf": [ { "not": { "anyOf": [ { "required": [ "amount" ] }, { "required": [ "currency" ] } ] }, "properties": { "purchase_id": { "format": "uuid", "type": "string" }, "upgrade_id": { "type": "null" } }, "required": [ "purchase_id" ] }, { "not": { "anyOf": [ { "required": [ "amount" ] }, { "required": [ "currency" ] } ] }, "properties": { "purchase_id": { "type": "null" }, "upgrade_id": { "format": "uuid", "type": "string" } }, "required": [ "upgrade_id" ] }, { "properties": { "purchase_id": { "type": "null" }, "upgrade_id": { "type": "null" } }, "required": [ "amount", "currency" ] } ], "properties": { "amount": { "description": "Obrigatório somente para uma recarga da carteira. Valor decimal de exibição dentro dos limites configurados. Pedidos de serviço rejeitam valores informados pelo cliente.", "pattern": "^\\d+(?:\\.\\d{1,2})?$", "type": "string" }, "currency": { "description": "Obrigatório somente para uma recarga da carteira e deve estar ativado para este provedor.", "type": "string" }, "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "purchase_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Compra ou renovação de serviço existente e pendente; mutuamente exclusiva com upgrade_id." }, "request_id": { "description": "Chave de solicitação estável gerada pelo chamador. As repetições retornam o checkout original.", "maxLength": 80, "type": "string" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" }, "upgrade_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Cotação de upgrade existente e pendente; mutuamente exclusiva com purchase_id." } }, "required": [ "request_id" ], "type": "object" }, "PaddleOrderList": { "additionalProperties": false, "properties": { "items": { "description": "Registros visíveis para este administrador ou espaço de trabalho.", "items": { "$ref": "#/components/schemas/PaddleOrder" }, "type": "array" }, "total": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "PaddleOrderResult": { "additionalProperties": false, "properties": { "approval_url": { "description": "Página local de checkout que abre a transação Paddle vinculada.", "format": "uri", "type": "string" }, "client_token": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "order": { "$ref": "#/components/schemas/PaddleOrder", "description": "Registro de pagamento de serviço Paddle no escopo do espaço de trabalho." }, "return_url": { "description": "URL do painel da carteira para uma recarga; URL de conciliação de preços para um pagamento de serviço. Uma URL de retorno, por si só, nunca comprova o pagamento.", "format": "uri", "type": "string" } }, "required": [ "order", "client_token", "approval_url", "return_url" ], "type": "object" }, "PaddleReconcileInput": { "additionalProperties": false, "properties": { "transaction_id": { "description": "ID txn_ original opcional, usado para recuperar uma resposta de criação perdida. O backend verifica de forma independente seu pedido local, tenant, produto, moeda e valor. Não pode substituir uma transação já vinculada.", "type": "string" } }, "required": [], "type": "object" }, "PaddleSettings": { "additionalProperties": false, "properties": { "api_key_configured": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "checkout_url": { "description": "Use esta página de domínio aprovado como link de pagamento padrão do Paddle.", "format": "uri", "type": "string" }, "client_token": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "currencies": { "description": "Moedas distintas aceitas por este canal; os valores usam duas casas decimais.", "items": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "type": "array" }, "enabled": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "maximum_cents": { "description": "Recarga máxima da carteira em unidades monetárias menores; o padrão é 100000 e não pode ser inferior a minimum_cents.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "minimum_cents": { "description": "Recarga mínima da carteira em unidades monetárias menores; o padrão é 100.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "product_id": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "version": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "webhook_secret_configured": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "webhook_url": { "description": "Registre esta URL absoluta como destino das notificações do Paddle.", "format": "uri", "type": "string" } }, "required": [ "enabled", "mode", "client_token", "product_id", "currencies", "api_key_configured", "webhook_secret_configured", "version", "webhook_url", "checkout_url" ], "type": "object" }, "PaddleSettingsInput": { "additionalProperties": false, "properties": { "api_key": { "description": "Criptografada em repouso. Vazio preserva o valor existente, a menos que clear_api_key seja true.", "maxLength": 1000, "type": "string", "writeOnly": true }, "clear_api_key": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "clear_webhook_secret": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "client_token": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "currencies": { "description": "Moedas distintas aceitas por este canal; os valores usam duas casas decimais.", "items": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "type": "array" }, "enabled": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "expected_version": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "maximum_cents": { "description": "Recarga máxima da carteira em unidades monetárias menores; o padrão é 100000 e não pode ser inferior a minimum_cents.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "minimum_cents": { "description": "Recarga mínima da carteira em unidades monetárias menores; o padrão é 100.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "product_id": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "webhook_secret": { "description": "Segredo privado do endpoint usado para autenticar o corpo bruto exato do webhook.", "maxLength": 1000, "type": "string", "writeOnly": true } }, "required": [ "enabled", "mode", "client_token", "product_id", "currencies", "expected_version" ], "type": "object" }, "PaddleWebhookEvent": { "description": "Evento Paddle Billing sem alterações, autenticado com Paddle-Signature e conciliado de forma independente pela API do Paddle.", "type": "object" }, "PasswordSet": { "additionalProperties": false, "properties": { "password_set": { "type": "boolean" } }, "required": [ "password_set" ], "type": "object" }, "PayPalCheck": { "additionalProperties": false, "properties": { "connected": { "type": "boolean" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [], "type": "object" }, "PayPalInput": { "additionalProperties": false, "properties": { "clear_secret": { "type": "boolean" }, "client_id": { "maxLength": 1000, "type": "string" }, "client_secret": { "description": "Vazio preserva o Secret salvo, salvo se clear_secret=true", "maxLength": 1000, "type": "string", "writeOnly": true }, "currencies": { "items": { "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" }, "enabled": { "type": "boolean" }, "expected_version": { "type": "string" }, "maximum_cents": { "maximum": 100000000, "type": "integer" }, "merchant_id": { "maxLength": 64, "type": "string" }, "minimum_cents": { "minimum": 1, "type": "integer" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "webhook_id": { "maxLength": 1000, "type": "string" } }, "required": [ "enabled", "mode", "client_id", "merchant_id", "webhook_id", "currencies", "minimum_cents", "maximum_cents", "expected_version" ], "type": "object" }, "PayPalOrder": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Valor em centésimos; lançamentos contábeis podem ser créditos positivos ou débitos negativos.", "type": "integer" }, "approval_url": { "description": "URL de aprovação do pagador PayPal; não comprova pagamento.", "format": "uri", "type": "string" }, "capture_id": { "description": "Identificador da captura PayPal.", "type": [ "string", "null" ] }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "credited_at": { "anyOf": [ { "description": "Hora em que a recarga foi creditada, ou null.", "format": "date-time", "type": "string" }, { "description": "Hora em que a recarga foi creditada, ou null.", "type": "null" } ], "description": "Hora em que a recarga foi creditada, ou null." }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "paypal_order_id": { "description": "Identificador do pedido PayPal, distinto do UUID do registro local.", "type": [ "string", "null" ] }, "purchase_id": { "description": "UUID da compra de pacote relacionada.", "type": [ "string", "null" ] }, "refunded_cents": { "description": "Valor cumulativo reembolsado em centésimos.", "type": "integer" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "creating", "created", "credited", "refunded" ], "type": "string" }, "upgrade_id": { "anyOf": [ { "description": "UUID do upgrade relacionado, ou vazio.", "format": "uuid", "type": "string" }, { "description": "UUID do upgrade relacionado, ou vazio.", "type": "null" } ], "description": "UUID do upgrade relacionado, ou vazio." } }, "required": [], "type": "object" }, "PayPalOrderList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/PayPalOrder" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [], "type": "object" }, "PayPalRefund": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Reembolso em dinheiro solicitado pela forma original, em centavos.", "type": "integer" }, "attempts": { "type": "integer" }, "case_id": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "order_id": { "format": "uuid", "type": "string" }, "paypal_refund_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "type": "string" }, "request_id": { "type": "string" }, "reserved": { "description": "true enquanto o valor da carteira está reservado. Um timeout de transporte mantém a reserva até que a mesma solicitação seja conciliada.", "type": "boolean" }, "status": { "enum": [ "pending", "completed", "failed" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "order_id", "request_id", "mode", "currency", "amount_cents", "reason", "status", "reserved", "attempts", "paypal_refund_id", "created_at", "updated_at" ], "type": "object" }, "PayPalSettings": { "additionalProperties": false, "properties": { "client_id": { "maxLength": 1000, "type": "string" }, "currencies": { "items": { "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" }, "enabled": { "type": "boolean" }, "maximum_cents": { "maximum": 100000000, "type": "integer" }, "merchant_id": { "maxLength": 64, "type": "string" }, "minimum_cents": { "minimum": 1, "type": "integer" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "secret_configured": { "type": "boolean" }, "version": { "type": "string" }, "webhook_id": { "maxLength": 1000, "type": "string" }, "webhook_url": { "format": "uri", "type": "string" } }, "required": [], "type": "object" }, "PaymentChannel": { "additionalProperties": false, "properties": { "currencies": { "description": "Moedas distintas aceitas por este canal; os valores usam duas casas decimais.", "items": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "type": "array" }, "enabled": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "name": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "provider": { "description": "Provedor de pagamento: PayPal, Paddle ou Waffo Pancake.", "enum": [ "paypal", "paddle", "waffo" ], "type": "string" }, "version": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "wallet_topup": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" } }, "required": [ "provider", "name", "enabled", "mode", "currencies", "wallet_topup" ], "type": "object" }, "PaymentChannelInput": { "additionalProperties": false, "properties": { "paddle_enabled": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "paddle_version": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "paypal_enabled": { "description": "Indica se este canal aceita novos checkouts. A conciliação histórica continua disponível com as credenciais preservadas.", "type": "boolean" }, "paypal_version": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "waffo_enabled": { "description": "Opção de ativação opcional do Waffo; os campos omitidos preservam seu estado atual.", "type": "boolean" }, "waffo_version": { "description": "Versão da configuração obrigatória ao alterar a opção de ativação do Waffo.", "type": "string" } }, "required": [ "paypal_enabled", "paddle_enabled", "paypal_version", "paddle_version" ], "type": "object" }, "PaymentChannels": { "additionalProperties": false, "properties": { "items": { "description": "Registros visíveis para este administrador ou espaço de trabalho.", "items": { "$ref": "#/components/schemas/PaymentChannel" }, "type": "array" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [ "items", "mode" ], "type": "object" }, "PendingPlan": { "additionalProperties": false, "properties": { "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "type": "string" }, "effective_month": { "description": "Mês UTC YYYY-MM em que o agendamento entra em vigor.", "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" } }, "required": [], "type": "object" }, "Period": { "additionalProperties": false, "properties": { "base_covered": { "description": "Se um pacote comprado já cobre a cobrança base.", "type": "boolean" }, "base_micros": { "description": "Cobrança base em milionésimos da unidade monetária.", "type": "integer" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "hard_limit": { "description": "Se novos dispositivos faturáveis são rejeitados no limite da franquia.", "type": "boolean" }, "included_devices": { "description": "Franquia de dispositivos ativos incluída.", "type": "integer" }, "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "type": "string" }, "payment_mode": { "description": "Ambiente de pagamento, sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "plan_name": { "description": "Nome de exibição do plano.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" }, "unit_micros": { "description": "Preço por dispositivo ativo excedente em milionésimos.", "type": "integer" } }, "required": [ "month", "plan", "currency", "price_version" ], "type": "object" }, "PlanChange": { "additionalProperties": false, "properties": { "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" } }, "required": [ "plan", "currency" ], "type": "object" }, "PlanGift": { "additionalProperties": false, "properties": { "batch_id": { "format": "uuid", "type": "string" }, "cancel_reason": { "type": "string" }, "cancelled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "cancelled_by": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "ends_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "purchase_id": { "format": "uuid", "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "granted", "cancelled" ], "type": "string" }, "tenant_id": { "format": "uuid", "type": "string" }, "user_id": { "format": "uuid", "type": "string" }, "value_cents": { "type": "integer" } }, "required": [ "id", "batch_id", "tenant_id", "user_id", "purchase_id", "value_cents", "status", "starts_at", "ends_at", "created_at", "cancelled_at" ], "type": "object" }, "PlanGiftBatch": { "additionalProperties": false, "properties": { "actor_id": { "format": "uuid", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "type": "string" }, "plan_name": { "type": "string" }, "price_version": { "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "request_id": { "type": "string" }, "start_mode": { "type": "string" }, "tenant_count": { "type": "integer" }, "term_months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "user_count": { "type": "integer" } }, "required": [ "id", "actor_id", "request_id", "plan", "plan_name", "currency", "price_version", "term_months", "mode", "start_mode", "reason", "user_count", "tenant_count", "created_at" ], "type": "object" }, "PlanGiftCancellation": { "additionalProperties": false, "properties": { "cancelled": { "type": "boolean" } }, "required": [ "cancelled" ], "type": "object" }, "PlanGiftInput": { "additionalProperties": false, "properties": { "currency": { "maxLength": 3, "minLength": 3, "type": "string" }, "fingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "type": "string" }, "price_version": { "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "request_id": { "maxLength": 80, "minLength": 1, "type": "string" }, "start_mode": { "default": "after_current", "enum": [ "after_current", "immediate" ], "type": "string" }, "term_months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "user_ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "user_ids", "term_months", "mode", "start_mode", "reason", "request_id", "fingerprint" ], "type": "object" }, "PlanGiftList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/PlanGiftRow" }, "type": "array" }, "total": { "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "PlanGiftPreview": { "additionalProperties": false, "properties": { "fingerprint": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/PlanGiftTarget" }, "type": "array" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "plan_name": { "type": "string" }, "start_mode": { "default": "after_current", "enum": [ "after_current", "immediate" ], "type": "string" }, "tenant_count": { "type": "integer" }, "term_months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "user_count": { "type": "integer" }, "value_cents": { "type": "integer" } }, "required": [ "fingerprint", "plan_name", "value_cents", "user_count", "tenant_count", "mode", "term_months", "start_mode", "items" ], "type": "object" }, "PlanGiftPreviewInput": { "additionalProperties": false, "properties": { "currency": { "maxLength": 3, "minLength": 3, "type": "string" }, "fingerprint": { "maxLength": 64, "minLength": 64, "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "type": "string" }, "price_version": { "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "request_id": { "maxLength": 80, "minLength": 1, "type": "string" }, "start_mode": { "default": "after_current", "enum": [ "after_current", "immediate" ], "type": "string" }, "term_months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "user_ids": { "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "user_ids", "mode", "reason" ], "type": "object" }, "PlanGiftResult": { "additionalProperties": false, "properties": { "batch": { "$ref": "#/components/schemas/PlanGiftBatch" }, "items": { "items": { "$ref": "#/components/schemas/PlanGift" }, "type": "array" } }, "required": [ "batch", "items" ], "type": "object" }, "PlanGiftRow": { "additionalProperties": false, "properties": { "actor_email": { "type": "string" }, "batch_id": { "format": "uuid", "type": "string" }, "cancel_reason": { "type": "string" }, "cancelled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "cancelled_by": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "email": { "type": "string" }, "ends_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "plan": { "type": "string" }, "plan_name": { "type": "string" }, "purchase_id": { "format": "uuid", "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "granted", "cancelled" ], "type": "string" }, "tenant_id": { "format": "uuid", "type": "string" }, "tenant_name": { "type": "string" }, "term_months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "user_id": { "format": "uuid", "type": "string" }, "value_cents": { "type": "integer" } }, "required": [ "id", "batch_id", "tenant_id", "user_id", "purchase_id", "value_cents", "status", "starts_at", "ends_at", "created_at", "cancelled_at" ], "type": "object" }, "PlanGiftTarget": { "additionalProperties": false, "properties": { "currency": { "type": "string" }, "email": { "type": "string" }, "ends_at": { "format": "date-time", "type": "string" }, "plan": { "type": "string" }, "plan_name": { "type": "string" }, "previous_end": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "price_version": { "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "tenant_id": { "format": "uuid", "type": "string" }, "tenant_name": { "type": "string" }, "user_id": { "format": "uuid", "type": "string" }, "value_cents": { "type": "integer" } }, "required": [ "user_id", "email", "tenant_id", "tenant_name", "starts_at", "ends_at", "previous_end", "plan", "plan_name", "currency", "price_version", "value_cents" ], "type": "object" }, "PlanInput": { "additionalProperties": false, "properties": { "api_hard_limit": { "type": "boolean" }, "api_unit_amount": { "description": "Decimal não negativo por chamada API bem-sucedida, no máximo seis casas", "type": "string" }, "base_amount": { "description": "Decimal não negativo; no máximo duas casas", "type": "string" }, "currency": { "description": "Deve ser configurado; ofertas do catálogo EUR estão desativadas", "pattern": "^[A-Z]{3}$", "type": "string" }, "description": { "maxLength": 1000, "type": "string" }, "enabled": { "type": "boolean" }, "expected_version": { "description": "Versão atual; vazia na criação", "type": "string" }, "hard_limit": { "type": "boolean" }, "included_api_calls": { "description": "null = ilimitado; 0 = nenhuma chamada bem-sucedida incluída", "maximum": 1000000000000, "minimum": 0, "type": [ "integer", "null" ] }, "included_devices": { "maximum": 1000000000, "minimum": 0, "type": "integer" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "plan": { "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "public": { "type": "boolean" }, "renewal_only": { "description": "Clientes existentes com pagamento ou presente podem renovar antecipadamente ou após a expiração no mesmo ambiente e moeda. Oculto para novas compras públicas.", "type": "boolean" }, "sort_order": { "maximum": 10000, "minimum": 0, "type": "integer" }, "terms": { "description": "Exatamente uma entrada para 1, 3, 6 e 12 meses, cada uma com disponibilidade e preço total próprios.", "items": { "$ref": "#/components/schemas/PlanTermInput" }, "maxItems": 4, "minItems": 4, "type": "array" }, "unit_amount": { "description": "Decimal não negativo; no máximo seis casas", "type": "string" } }, "required": [ "plan", "currency", "name", "base_amount", "unit_amount" ], "type": "object" }, "PlanList": { "additionalProperties": false, "properties": { "billing_unit": { "type": "string" }, "currencies": { "items": { "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" }, "default_plan": { "anyOf": [ { "$ref": "#/components/schemas/Price" }, { "type": "null" } ] }, "items": { "items": { "$ref": "#/components/schemas/Price" }, "type": "array" }, "maximum_cents": { "type": "integer" }, "minimum_cents": { "type": "integer" }, "payment_channels": { "description": "Configuração disponível de canais de pagamento. Mostre apenas canais habilitados compatíveis com o ambiente de faturamento ativo e a moeda da compra.", "items": { "$ref": "#/components/schemas/PaymentChannel" }, "type": "array" }, "paypal_enabled": { "type": "boolean" }, "sandbox": { "type": "boolean" }, "timezone": { "type": "string" } }, "required": [], "type": "object" }, "PlanPurchase": { "additionalProperties": false, "properties": { "api_calls": { "description": "Para PurchaseList.active: chamadas bem-sucedidas no mês de cota atual. Itens históricos contêm totais de toda a vigência.", "type": "integer" }, "api_hard_limit": { "description": "Se chamadas de execução param no limite da franquia API.", "type": "boolean" }, "api_overage_cents": { "description": "Mês de cota atual na visão ativa; cobranças de excedente API de toda a vigência nos itens históricos.", "type": "integer" }, "api_unit_micros": { "description": "Preço por chamada de execução excedente em milionésimos.", "minimum": 0, "type": "integer" }, "base_cents": { "description": "Cobrança inicial real do contrato inteiro; zero para presente. A visão ativa do upgrade efetivo contém o preço integral do alvo para duração correspondente.", "type": "integer" }, "cancelled_at": { "anyOf": [ { "description": "Data e hora de cancelamento do contrato, ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora de cancelamento do contrato, ou null.", "type": "null" } ], "description": "Data e hora de cancelamento do contrato, ou null." }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "current_cycle_index": { "description": "Índice do ciclo de franquia atual.", "maximum": 11, "minimum": 0, "type": "integer" }, "current_upgrade_id": { "description": "Vazio antes de um upgrade. Caso contrário, aponta para o PlanUpgrade aplicado mais recente. A resposta ativa inclui seu snapshot de plano efetivo, enquanto compras históricas mantêm o preço original de venda.", "type": "string" }, "cycle_ends_at": { "description": "Fim do ciclo de franquia atual, UTC.", "format": "date-time", "type": "string" }, "cycle_starts_at": { "description": "Início do ciclo de franquia atual, UTC.", "format": "date-time", "type": "string" }, "effective_included_devices": { "description": "Franquia de dispositivos após o upgrade aplicado. Snapshots originais de compra permanecem inalterados.", "minimum": 0, "type": "integer" }, "effective_plan": { "description": "Entitlement atual após uma sobreposição explícita de upgrade. A lista de compras mantém plan/base_cents originais para histórico de caixa; use este campo para mostrar o nível efetivo atual.", "type": "string" }, "effective_plan_name": { "description": "Entitlement atual após uma sobreposição explícita de upgrade. A lista de compras mantém plan/base_cents originais para histórico de caixa; use este campo para mostrar o nível efetivo atual.", "type": "string" }, "ends_at": { "anyOf": [ { "description": "Data e hora de término do pacote ou ciclo, UTC; pode ser null antes da ativação.", "format": "date-time", "type": "string" }, { "description": "Data e hora de término do pacote ou ciclo, UTC; pode ser null antes da ativação.", "type": "null" } ], "description": "Data e hora de término do pacote ou ciclo, UTC; pode ser null antes da ativação." }, "entitlement_cents": { "description": "Valor de benefício do pacote efetivo atual para crédito de upgrade, em centavos da moeda. Um plano 99 USD dado de presente tem 9900 centavos de benefício, embora seu pagamento base_cents original seja zero. Este valor não é dinheiro reembolsável. Preenchido nas visões de pacote ativo.", "minimum": 0, "type": "integer" }, "gift_batch_id": { "description": "Identificador do lote de presente; vazio para compras comuns.", "type": "string" }, "gift_follows_current": { "default": false, "description": "Indica um presente emitido a partir do nível atual do cliente. O presente mantém seu valor de entitlement original e pagamento em dinheiro zero. Upgrades explícitos de toda a cobertura aplicam sobreposições de entitlement separadas a cada presente não expirado e mantêm o registro original de presente com pagamento zero.", "type": "boolean" }, "hard_limit": { "description": "Se novos dispositivos faturáveis são rejeitados no limite da franquia.", "type": "boolean" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "included_api_calls": { "description": "null = ilimitado; 0 = nenhuma chamada bem-sucedida incluída", "maximum": 1000000000000, "minimum": 0, "type": [ "integer", "null" ] }, "included_devices": { "description": "Franquia de dispositivos ativos incluída.", "type": "integer" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "overage_cents": { "description": "Mês de cota atual na visão ativa; cobranças de excedente de dispositivos de toda a vigência nos itens históricos.", "type": "integer" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "plan_name": { "description": "Nome de exibição do plano.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" }, "refunded_cents": { "description": "Valor cumulativo reembolsado em centésimos.", "type": "integer" }, "renewal": { "description": "Se este é um contrato de renovação.", "type": "boolean" }, "renewal_of": { "description": "ID do pacote pago ou presente anterior. Mantém a cadeia de renovação e o histórico original de compra.", "type": "string" }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "type": "string" }, "service_credit_basis_cents": { "description": "Base de valor em centésimos para cálculos de crédito de serviço.", "type": "integer" }, "service_credit_basis_seconds": { "description": "Base de tempo em segundos para cálculos de crédito de serviço.", "type": "integer" }, "source": { "description": "Origem do entitlement, como purchase ou gift.", "enum": [ "purchase", "gift", "auto_renewal" ], "type": "string" }, "starts_at": { "anyOf": [ { "description": "Data e hora de início do pacote ou ciclo, UTC.", "format": "date-time", "type": "string" }, { "description": "Data e hora de início do pacote ou ciclo, UTC.", "type": "null" } ], "description": "Data e hora de início do pacote ou ciclo, UTC." }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "pending", "active", "cancelled", "expired" ], "type": "string" }, "term_months": { "default": 1, "description": "Número de meses do prazo comprado.", "enum": [ 1, 3, 6, 12 ], "type": "integer" }, "total_api_calls": { "description": "Chamadas de execução cumulativas no contrato.", "type": "integer" }, "total_api_overage_cents": { "description": "Excedentes API cumulativos do contrato em centésimos.", "type": "integer" }, "total_device_overage_cents": { "description": "Excedentes cumulativos de dispositivos do contrato em centésimos.", "type": "integer" }, "unit_micros": { "description": "Preço por dispositivo ativo excedente em milionésimos.", "type": "integer" } }, "required": [], "type": "object" }, "PlanTermInput": { "additionalProperties": false, "properties": { "amount": { "description": "Total não negativo da duração; no máximo duas casas decimais. O valor de um mês deve ser igual a base_amount.", "type": "string" }, "enabled": { "type": "boolean" }, "months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" } }, "required": [ "months", "enabled", "amount" ], "type": "object" }, "PlanTermPrice": { "additionalProperties": false, "properties": { "base_cents": { "description": "Cobrança total da duração selecionada em centavos da moeda. As cotas mensais não são multiplicadas por essa duração.", "minimum": 0, "type": "integer" }, "enabled": { "description": "Indica se o endpoint de webhook está ativado.", "type": "boolean" }, "months": { "default": 1, "description": "Número de meses do prazo de compra.", "enum": [ 1, 3, 6, 12 ], "type": "integer" } }, "required": [ "months", "enabled", "base_cents" ], "type": "object" }, "PlanUpgrade": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Pagamento combinado de todos os itens em parts. Cobrado de forma atômica uma única vez. Os outros campos de cálculo proporcional do registro pai descrevem apenas o período atual; consulte parts para obter o valor original, o valor de destino, os segundos restantes e a diferença individual de cada período.", "type": "integer" }, "api_hard_limit": { "description": "Se chamadas de execução param no limite da franquia API.", "type": "boolean" }, "api_unit_micros": { "description": "Nova tarifa de excedente de API em milionésimos da moeda.", "type": "integer" }, "applied_at": { "anyOf": [ { "description": "Horário em que o upgrade entrou em vigor ou null.", "format": "date-time", "type": "string" }, { "description": "Horário em que o upgrade entrou em vigor ou null.", "type": "null" } ], "description": "Horário em que o upgrade entrou em vigor ou null." }, "base_cents": { "description": "Preço mensal de destino em centavos, não o valor devido agora.", "type": "integer" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "A mesma moeda do pacote atual.", "type": "string" }, "cycle_seconds": { "description": "Duração do ciclo comprado original em segundos.", "type": "integer" }, "ends_at": { "description": "Data e hora de término do pacote ou ciclo, UTC; pode ser null antes da ativação.", "format": "date-time", "type": "string" }, "expires_at": { "description": "15 minutos após a criação ou no vencimento do plano original, o que ocorrer primeiro.", "format": "date-time", "type": "string" }, "hard_limit": { "description": "Se novos dispositivos faturáveis são rejeitados no limite da franquia.", "type": "boolean" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "included_api_calls": { "anyOf": [ { "description": "Cota total de API do ciclo existente. null significa ilimitada. As chamadas anteriores continuam contando.", "type": "integer" }, { "description": "Chamadas de execução bem-sucedidas incluídas; null significa ilimitadas e 0 significa nenhuma incluída.", "type": "null" } ], "description": "Chamadas de execução bem-sucedidas incluídas; null significa ilimitadas e 0 significa nenhuma incluída." }, "included_devices": { "description": "Cota total do ciclo existente; o uso anterior de dispositivos continua contando.", "type": "integer" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "parent_id": { "description": "As sobreposições internas de direitos aplicadas apontam para a única cobrança pai. Esses registros filhos são excluídos do histórico de upgrades do cliente e das contagens de vendas.", "format": "uuid", "type": "string" }, "parts": { "description": "Todos os períodos atuais e futuros pagos/presenteados não vencidos, em ordem de data. Upgrade obrigatório de toda a cobertura; não é possível selecionar um subconjunto de períodos.", "items": { "$ref": "#/components/schemas/UpgradePart" }, "type": "array" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "plan_name": { "description": "Nome de exibição do plano.", "type": "string" }, "previous_base_cents": { "description": "Preço mensal efetivo atual em centavos.", "type": "integer" }, "previous_plan_name": { "description": "Nome de exibição do plano antes do upgrade.", "type": "string" }, "previous_upgrade_id": { "description": "ID do upgrade anterior ou vazio para o primeiro upgrade. Usado para rejeitar cotações desatualizadas.", "type": "string" }, "price_version": { "description": "Versão congelada do preço de destino.", "type": "string" }, "purchase_id": { "description": "UUID da compra de pacote relacionada.", "format": "uuid", "type": "string" }, "remaining_seconds": { "description": "Segundos restantes na criação da cotação, arredondados para cima.", "type": "integer" }, "request_id": { "description": "Chave estável gerada pelo cliente. Reutilizá-la com parâmetros de cotação diferentes retorna 409.", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "pending", "applied", "expired" ], "type": "string" }, "unit_micros": { "description": "Nova tarifa de excedente por dispositivo em milionésimos da moeda.", "type": "integer" } }, "required": [ "id", "request_id", "mode", "purchase_id", "previous_upgrade_id", "plan", "plan_name", "previous_plan_name", "currency", "price_version", "previous_base_cents", "base_cents", "amount_cents", "included_devices", "unit_micros", "hard_limit", "included_api_calls", "api_unit_micros", "api_hard_limit", "remaining_seconds", "cycle_seconds", "ends_at", "expires_at", "status", "created_at", "applied_at" ], "type": "object" }, "PlatformOperation": { "additionalProperties": false, "properties": { "action": { "type": "string" }, "actor_email": { "type": "string" }, "actor_id": { "format": "uuid", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "details": { "description": "String JSON que contém apenas alterações administrativas explícitas; nunca senhas, tokens ou credenciais de pagamento.", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "request_id": { "type": "string" }, "resource_id": { "type": "string" }, "tenant_id": { "type": "string" }, "user_email": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "id", "actor_id", "action", "user_id", "tenant_id", "resource_id", "reason", "details", "request_id", "created_at", "actor_email", "user_email" ], "type": "object" }, "PlatformOperationList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/PlatformOperation" }, "type": "array" }, "total": { "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "PlatformOverview": { "additionalProperties": false, "properties": { "at": { "format": "date-time", "type": "string" }, "counts": { "additionalProperties": false, "properties": { "active_packages": { "type": "integer" }, "active_workspaces": { "type": "integer" }, "disabled_users": { "type": "integer" }, "enabled_plans": { "type": "integer" }, "expiring_packages": { "type": "integer" }, "failed_mail": { "type": "integer" }, "gift_packages": { "type": "integer" }, "new_users": { "type": "integer" }, "suspended_workspaces": { "type": "integer" }, "users": { "type": "integer" }, "verified_users": { "type": "integer" } }, "required": [ "users", "verified_users", "disabled_users", "new_users", "active_workspaces", "suspended_workspaces", "active_packages", "expiring_packages", "gift_packages", "failed_mail", "enabled_plans" ], "type": "object" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "paypal_enabled": { "type": "boolean" } }, "required": [ "counts", "mode", "paypal_enabled", "at" ], "type": "object" }, "PlatformReason": { "additionalProperties": false, "properties": { "reason": { "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "reason" ], "type": "object" }, "PlatformRevocation": { "additionalProperties": false, "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "type": "object" }, "PlatformUser": { "additionalProperties": false, "properties": { "admin_note": { "description": "Nota privada da plataforma. Os campos do perfil do cliente permanecem inalterados.", "maxLength": 2000, "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "email_verified_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "format": "uuid", "type": "string" }, "is_platform_admin": { "type": "boolean" }, "last_login_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "note_version": { "type": "string" }, "role": { "enum": [ "owner", "read_only" ], "type": "string" }, "status": { "enum": [ "active", "disabled" ], "type": "string" }, "tenant_id": { "format": "uuid", "type": "string" }, "tenant_name": { "type": "string" }, "tenant_status": { "enum": [ "active", "suspended" ], "type": "string" }, "tenant_updated_at": { "format": "date-time", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "tenant_id", "tenant_name", "tenant_status", "tenant_updated_at", "email", "name", "role", "status", "is_platform_admin", "email_verified_at", "created_at", "updated_at", "last_login_at", "admin_note", "note_version" ], "type": "object" }, "PlatformUserDetail": { "additionalProperties": false, "properties": { "counts": { "additionalProperties": false, "properties": { "licenses": { "type": "integer" }, "products": { "type": "integer" }, "users": { "type": "integer" } }, "required": [ "users", "products", "licenses" ], "type": "object" }, "payments": { "items": { "additionalProperties": false, "properties": { "currency": { "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "paid_cents": { "type": "integer" }, "refunded_cents": { "type": "integer" } }, "required": [ "mode", "currency", "paid_cents", "refunded_cents" ], "type": "object" }, "type": "array" }, "purchases": { "items": { "$ref": "#/components/schemas/PlanPurchase" }, "type": "array" }, "user": { "$ref": "#/components/schemas/PlatformUser" }, "wallets": { "items": { "$ref": "#/components/schemas/Wallet" }, "type": "array" } }, "required": [ "user", "counts", "wallets", "purchases", "payments" ], "type": "object" }, "PlatformUserList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/PlatformUser" }, "type": "array" }, "total": { "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "PlatformUserUpdate": { "additionalProperties": false, "anyOf": [ { "required": [ "status", "expected_updated_at" ] }, { "required": [ "admin_note", "expected_note_version" ] } ], "properties": { "admin_note": { "maxLength": 2000, "type": "string" }, "expected_note_version": { "type": "string" }, "expected_updated_at": { "format": "date-time", "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "status": { "enum": [ "active", "disabled" ], "type": "string" } }, "required": [ "reason" ], "type": "object" }, "PlatformWorkspaceStatus": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" }, "status": { "enum": [ "active", "suspended" ], "type": "string" } }, "required": [ "id", "status" ], "type": "object" }, "PlatformWorkspaceUpdate": { "additionalProperties": false, "properties": { "expected_updated_at": { "format": "date-time", "type": "string" }, "reason": { "maxLength": 500, "minLength": 1, "type": "string" }, "status": { "enum": [ "active", "suspended" ], "type": "string" } }, "required": [ "status", "reason", "expected_updated_at" ], "type": "object" }, "Policy": { "additionalProperties": false, "example": { "created_at": "2026-10-18T00:00:00Z", "features": [ "export" ], "heartbeat_seconds": 600, "id": "22222222-2222-4222-8222-222222222222", "max_devices": 1, "mode": "timed", "name": "One device", "offline_mode": "limited", "offline_seconds": 86400, "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z", "version": 1 }, "properties": { "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "heartbeat_seconds": { "anyOf": [ { "const": 0, "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline." }, { "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline.", "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "Intervalo de heartbeat online, em segundos. 0 desativa os periódicos. A permissão offline é separada.", "type": "integer" }, "id": { "description": "UUID da política, usado como policy_id ao emitir.", "format": "uuid", "type": "string" }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "type": "integer" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "minLength": 1, "type": "string" }, "offline_mode": { "description": "limited: offline limitado; none: proibido; permanent: sem limite adicional offline, mas sujeito à validade da licença.", "enum": [ "limited", "none", "permanent" ], "type": "string" }, "offline_seconds": { "description": "Segundos offline permitidos: 1–31536000 para limited, 0 para none/permanent. Este não é o intervalo de heartbeat. Com os heartbeats ativados, as novas políticas offline limitadas devem cumprir offline_seconds \u003e= 3 × heartbeat_seconds; as concessões de assentos flutuantes também devem abranger pelo menos três intervalos de heartbeat.", "maximum": 31536000, "minimum": 0, "type": "integer" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" }, "version": { "description": "A versão aumenta a cada edição e verifica se a prévia continua válida ao aplicar a licenças existentes.", "type": "integer" } }, "required": [ "id", "product_id", "mode", "version" ], "type": "object" }, "PolicyCapabilities": { "additionalProperties": false, "properties": { "allow_vm": { "description": "Se máquinas virtuais são permitidas.", "type": "boolean" }, "device_match": { "description": "Correspondência de identidade system ou de hardware.", "enum": [ "system", "hardware" ], "type": "string" }, "license_model": { "description": "Vinculação de dispositivo node_locked ou assentos floating.", "enum": [ "node_locked", "floating" ], "type": "string" }, "maintenance_days": { "description": "Dias de manutenção desde a primeira ativação; 0 significa sem limite de manutenção.", "maximum": 36500, "minimum": 0, "type": "integer" }, "max_version": { "description": "Versão máxima permitida do aplicativo; vazio significa sem limite superior.", "type": "string" }, "meter_rules": { "description": "Regras de medição de recursos; vazio significa nenhuma configurada.", "items": { "additionalProperties": false, "properties": { "allow_overage": { "description": "Se o uso excedente do recurso é permitido.", "type": "boolean" }, "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "limit": { "description": "Usos do recurso incluídos por período de medição (não é limite de paginação).", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "max_overage": { "description": "Uso excedente máximo permitido; desativado quando allow_overage é false.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "enum": [ "month", "day", "lifetime" ], "type": "string" } }, "required": [ "feature", "limit", "period" ], "type": "object" }, "maxItems": 32, "type": "array" }, "min_version": { "description": "Versão mínima permitida do aplicativo; vazio significa sem limite inferior.", "type": "string" }, "policy_id": { "description": "UUID da política; deve pertencer ao produto na emissão.", "format": "uuid", "type": "string" }, "policy_version": { "description": "Revisão da política; envie o valor atual ao editar todas as capacidades para evitar gravações desatualizadas.", "type": "integer" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "require_hardware": { "description": "Se é necessária uma identidade de hardware utilizável.", "type": "boolean" }, "self_release_limit": { "description": "Liberações de autoatendimento permitidas por período móvel de 30 dias, 0–100; 0 as desativa.", "maximum": 100, "minimum": 0, "type": "integer" }, "session_seconds": { "description": "Segundos da concessão de assento floating sem heartbeat, 20–86400; deve atender às restrições de execução da política.", "maximum": 86400, "minimum": 20, "type": "integer" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" } }, "required": [], "type": "object" }, "PolicyCapabilitiesInput": { "additionalProperties": false, "description": "Define modo de emissão, limites de dispositivos/assentos, recursos e regras de execução. Nenhuma duração de validade é armazenada na política. policy_version é obrigatório para evitar edições desatualizadas.", "properties": { "allow_vm": { "description": "Se máquinas virtuais são permitidas.", "type": "boolean" }, "device_match": { "description": "Correspondência de identidade system ou de hardware.", "enum": [ "system", "hardware" ], "type": "string" }, "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "heartbeat_seconds": { "anyOf": [ { "const": 0, "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline." }, { "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline.", "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "0 desativa explicitamente heartbeats periódicos; caso contrário, 600–86400 segundos (mínimo 10 minutos). Independente da permissão offline.", "type": "integer" }, "license_model": { "description": "Vinculação de dispositivo node_locked ou assentos floating.", "enum": [ "node_locked", "floating" ], "type": "string" }, "maintenance_days": { "description": "Dias de manutenção desde a primeira ativação; 0 significa sem limite de manutenção.", "maximum": 36500, "minimum": 0, "type": "integer" }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "maximum": 10000, "minimum": 1, "type": "integer" }, "max_version": { "description": "Versão máxima permitida do aplicativo; vazio significa sem limite superior.", "type": "string" }, "meter_rules": { "description": "Regras de medição de recursos; vazio significa nenhuma configurada.", "items": { "additionalProperties": false, "properties": { "allow_overage": { "description": "Se o uso excedente do recurso é permitido.", "type": "boolean" }, "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "limit": { "description": "Usos do recurso incluídos por período de medição (não é limite de paginação).", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "max_overage": { "description": "Uso excedente máximo permitido; desativado quando allow_overage é false.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "enum": [ "month", "day", "lifetime" ], "type": "string" } }, "required": [ "feature", "limit", "period" ], "type": "object" }, "maxItems": 32, "type": "array" }, "min_version": { "description": "Versão mínima permitida do aplicativo; vazio significa sem limite inferior.", "type": "string" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "minLength": 1, "type": "string" }, "offline_mode": { "description": "Permissão offline limited, none ou permanent; a expiração da licença ainda se aplica.", "enum": [ "limited", "none", "permanent" ], "type": "string" }, "offline_seconds": { "description": "Limited: 1–31536000 segundos e pelo menos 3 × heartbeat_seconds com os heartbeats ativados; none/permanent: 0", "maximum": 31536000, "minimum": 0, "type": "integer" }, "policy_version": { "description": "Revisão da política; envie o valor atual ao editar todas as capacidades para evitar gravações desatualizadas.", "minimum": 1, "type": "integer" }, "require_hardware": { "description": "Se é necessária uma identidade de hardware utilizável.", "type": "boolean" }, "self_release_limit": { "description": "Liberações de autoatendimento permitidas por período móvel de 30 dias, 0–100; 0 as desativa.", "maximum": 100, "minimum": 0, "type": "integer" }, "session_seconds": { "description": "Segundos da concessão de assento floating sem heartbeat, 20–86400; deve atender às restrições de execução da política.", "maximum": 86400, "minimum": 20, "type": "integer" } }, "required": [ "policy_version" ], "type": "object" }, "PolicyCreate": { "additionalProperties": false, "description": "Define modo de emissão, limites de dispositivos/assentos, recursos e regras de execução. Nenhuma duração de validade é armazenada na política.", "properties": { "allow_vm": { "description": "Se máquinas virtuais são permitidas.", "type": "boolean" }, "device_match": { "description": "Correspondência de identidade system ou de hardware.", "enum": [ "system", "hardware" ], "type": "string" }, "features": { "description": "Identificadores permitidos, como [\"export\"]. Devem corresponder aos argumentos de CheckFeature.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "heartbeat_seconds": { "anyOf": [ { "const": 0, "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline." }, { "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline.", "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "Intervalo de heartbeat online, em segundos. 0 desativa os periódicos. A permissão offline é separada.", "type": "integer" }, "license_model": { "description": "Vinculação de dispositivo node_locked ou assentos floating.", "enum": [ "node_locked", "floating" ], "type": "string" }, "maintenance_days": { "description": "Dias de manutenção desde a primeira ativação; 0 significa sem limite de manutenção.", "maximum": 36500, "minimum": 0, "type": "integer" }, "max_devices": { "description": "Dispositivos por licença, 1–10000; no modo flutuante, limite de assentos simultâneos.", "maximum": 10000, "minimum": 1, "type": "integer" }, "max_version": { "description": "Versão máxima permitida do aplicativo; vazio significa sem limite superior.", "type": "string" }, "meter_rules": { "description": "Regras de medição de recursos; vazio significa nenhuma configurada.", "items": { "additionalProperties": false, "properties": { "allow_overage": { "description": "Se o uso excedente do recurso é permitido.", "type": "boolean" }, "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "limit": { "description": "Usos do recurso incluídos por período de medição (não é limite de paginação).", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "max_overage": { "description": "Uso excedente máximo permitido; desativado quando allow_overage é false.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "enum": [ "month", "day", "lifetime" ], "type": "string" } }, "required": [ "feature", "limit", "period" ], "type": "object" }, "maxItems": 32, "type": "array" }, "min_version": { "description": "Versão mínima permitida do aplicativo; vazio significa sem limite inferior.", "type": "string" }, "mode": { "description": "Tipo de licença: perpetual, timed ou trial. Não é o tipo de assinatura de cobrança.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "name": { "description": "Nome da política, por exemplo Pro 30 dias.", "maxLength": 120, "minLength": 1, "type": "string" }, "offline_mode": { "description": "limited: offline limitado; none: proibido; permanent: sem limite adicional offline, mas sujeito à validade da licença.", "enum": [ "limited", "none", "permanent" ], "type": "string" }, "offline_seconds": { "description": "Segundos offline permitidos: 1–31536000 para limited, 0 para none/permanent. Este não é o intervalo de heartbeat. Com os heartbeats ativados, as novas políticas offline limitadas devem cumprir offline_seconds \u003e= 3 × heartbeat_seconds; as concessões de assentos flutuantes também devem abranger pelo menos três intervalos de heartbeat.", "maximum": 31536000, "minimum": 0, "type": "integer" }, "product_id": { "description": "ID do produto (UUID).", "format": "uuid", "type": "string" }, "require_hardware": { "description": "Se é necessária uma identidade de hardware utilizável.", "type": "boolean" }, "self_release_limit": { "description": "Liberações de autoatendimento permitidas por período móvel de 30 dias, 0–100; 0 as desativa.", "maximum": 100, "minimum": 0, "type": "integer" }, "session_seconds": { "description": "Segundos da concessão de assento floating sem heartbeat, 20–86400; deve atender às restrições de execução da política.", "maximum": 86400, "minimum": 20, "type": "integer" } }, "required": [ "product_id", "name", "mode", "max_devices" ], "type": "object" }, "PolicyList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Policy" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "type": "object" }, "PolicyPreview": { "additionalProperties": false, "properties": { "changes": { "description": "Comparação antes/depois e motivo de bloqueio por licença.", "items": { "additionalProperties": false, "properties": { "active": { "description": "Indicador da chave de assinatura atual; em uma prévia de política, quantidade de dispositivos/sessões ativos.", "type": "integer" }, "after": { "additionalProperties": false, "description": "Direitos após aplicar a política de destino; a duração permanece inalterada.", "properties": { "duration_days": { "description": "Dias por licença desde a primeira ativação. Exige 1–36500 para emissão timed/trial; ausente/null para perpetual. Nunca é armazenado na política.", "type": [ "integer", "null" ] }, "expires_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "type": "null" } ], "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial." }, "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "type": "string" }, "type": "array" }, "license_model": { "description": "Vinculação de dispositivo node_locked ou assentos floating.", "enum": [ "node_locked", "floating" ], "type": "string" }, "maintenance_until": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Limite de manutenção para novas versões; pode ser null antes da ativação ou quando ilimitado.", "type": "null" } ], "description": "Limite de manutenção para novas versões; pode ser null antes da ativação ou quando ilimitado." }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "type": "integer" }, "max_version": { "description": "Versão máxima permitida do aplicativo; vazio significa sem limite superior.", "type": "string" }, "meter_rules": { "description": "Regras de medição de recursos; vazio significa nenhuma configurada.", "items": { "additionalProperties": false, "properties": { "allow_overage": { "description": "Se o uso excedente do recurso é permitido.", "type": "boolean" }, "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "max_overage": { "description": "Uso excedente máximo permitido; desativado quando allow_overage é false.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "enum": [ "month", "day", "lifetime" ], "type": "string" } }, "required": [ "feature", "limit", "period" ], "type": "object" }, "maxItems": 32, "type": "array" }, "min_version": { "description": "Versão mínima permitida do aplicativo; vazio significa sem limite inferior.", "type": "string" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" } }, "required": [ "mode", "max_devices", "features", "expires_at", "duration_days", "license_model", "meter_rules", "maintenance_until", "min_version", "max_version" ], "type": "object" }, "before": { "additionalProperties": false, "description": "Direitos emitidos atuais e duração da licença.", "properties": { "capabilities": { "$ref": "#/components/schemas/LicenseCapabilities", "description": "Snapshot das capacidades da licença." }, "duration_days": { "description": "Dias por licença desde a primeira ativação. Exige 1–36500 para emissão timed/trial; ausente/null para perpetual. Nunca é armazenado na política.", "type": [ "integer", "null" ] }, "expires_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "type": "null" } ], "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial." }, "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "type": "string" }, "type": "array" }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "type": "integer" }, "meter_rules": { "description": "Regras de medição de recursos; vazio significa nenhuma configurada.", "items": { "additionalProperties": false, "properties": { "allow_overage": { "description": "Se o uso excedente do recurso é permitido.", "type": "boolean" }, "feature": { "description": "Identificador de recurso medido, que deve existir nos recursos da política.", "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "max_overage": { "description": "Uso excedente máximo permitido; desativado quando allow_overage é false.", "maximum": 1000000000000, "minimum": 0, "type": "integer" }, "period": { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "enum": [ "month", "day", "lifetime" ], "type": "string" } }, "required": [ "feature", "limit", "period" ], "type": "object" }, "maxItems": 32, "type": "array" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" } }, "required": [ "mode", "max_devices", "features", "expires_at", "duration_days", "capabilities", "meter_rules" ], "type": "object" }, "blocked_reason": { "description": "Motivo que bloqueia a alteração; vazio indica que não há impedimento atual.", "type": "string" }, "customer": { "description": "Rótulo de cliente definido pelo fornecedor, distinto do e-mail do portal do cliente.", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, "required": [ "id", "customer", "before", "after", "blocked_reason", "active" ], "type": "object" }, "type": "array" }, "expires_in": { "const": 600, "description": "Duração do token da prévia em segundos, atualmente 600.", "type": "integer" }, "note": { "description": "Orientações adicionais para o desenvolvedor.", "type": "string" }, "policy_version": { "description": "Revisão da política; envie o valor atual ao editar todas as capacidades para evitar gravações desatualizadas.", "type": "integer" }, "preview_token": { "description": "Token criptografado de confirmação da prévia obrigatório para apply_policy; válido por 600 segundos e invalidado por alterações nos recursos.", "type": "string" } }, "required": [ "changes", "policy_version", "preview_token", "expires_in", "note" ], "type": "object" }, "PolicySyncResult": { "additionalProperties": false, "properties": { "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "synced_licenses": { "description": "Número de licenças vinculadas e não revogadas sincronizadas na mesma transação.", "minimum": 0, "type": "integer" } }, "required": [ "id", "synced_licenses" ], "type": "object" }, "PolicyUpdate": { "additionalProperties": false, "description": "Define modo de emissão, limites de dispositivos/assentos, recursos e regras de execução. Nenhuma duração de validade é armazenada na política.", "properties": { "features": { "description": "Até 32 identificadores distintos de recursos, cada um com 1–64 letras ASCII, dígitos, pontos, hífens ou sublinhados.", "items": { "pattern": "^[A-Za-z0-9_.-]{1,64}$", "type": "string" }, "maxItems": 32, "type": "array", "uniqueItems": true }, "heartbeat_seconds": { "anyOf": [ { "const": 0, "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline." }, { "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline.", "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "0 desativa explicitamente heartbeats periódicos; caso contrário, 600–86400 segundos (mínimo 10 minutos). Independente da permissão offline.", "type": "integer" }, "max_devices": { "description": "Máximo de dispositivos simultâneos ou assentos floating por licença.", "maximum": 10000, "minimum": 1, "type": "integer" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "perpetual", "timed", "trial" ], "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "minLength": 1, "type": "string" }, "offline_mode": { "description": "Permissão offline limited, none ou permanent; a expiração da licença ainda se aplica.", "enum": [ "limited", "none", "permanent" ], "type": "string" }, "offline_seconds": { "description": "Limited: 1–31536000 segundos e pelo menos 3 × heartbeat_seconds com os heartbeats ativados; none/permanent: 0", "maximum": 31536000, "minimum": 0, "type": "integer" } }, "required": [], "type": "object" }, "PreviewInput": { "additionalProperties": false, "properties": { "ids": { "description": "UUIDs de licença distintos a processar, 1–100.", "items": { "format": "uuid", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "policy_id": { "description": "UUID da política; deve pertencer ao produto na emissão.", "format": "uuid", "type": "string" } }, "required": [ "policy_id", "ids" ], "type": "object" }, "Price": { "additionalProperties": false, "properties": { "api_hard_limit": { "description": "Se chamadas de execução param no limite da franquia API.", "type": "boolean" }, "api_unit_micros": { "description": "Preço por chamada de execução excedente em milionésimos.", "minimum": 0, "type": "integer" }, "base_micros": { "description": "Cobrança base em milionésimos da unidade monetária.", "type": "integer" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "type": "string" }, "description": { "description": "Descrição da oferta de faturamento.", "type": "string" }, "enabled": { "description": "Se a oferta de faturamento está habilitada para compra.", "type": "boolean" }, "hard_limit": { "description": "Se novos dispositivos faturáveis são rejeitados no limite da franquia.", "type": "boolean" }, "included_api_calls": { "description": "null = ilimitado; 0 = nenhuma chamada bem-sucedida incluída", "maximum": 1000000000000, "minimum": 0, "type": [ "integer", "null" ] }, "included_devices": { "description": "Franquia de dispositivos ativos incluída.", "type": "integer" }, "name": { "description": "Nome de exibição da oferta de faturamento.", "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" }, "public": { "description": "Se a oferta de faturamento está listada publicamente.", "type": "boolean" }, "renewal_only": { "description": "Clientes existentes com pagamento ou presente podem renovar antecipadamente ou após a expiração no mesmo ambiente e moeda. Oculto para novas compras públicas.", "type": "boolean" }, "sort_order": { "description": "Ordem de exibição da oferta de faturamento.", "type": "integer" }, "terms": { "description": "Prazos de compra disponíveis e seus preços.", "items": { "$ref": "#/components/schemas/PlanTermPrice" }, "type": "array" }, "unit_micros": { "description": "Preço por dispositivo ativo excedente em milionésimos.", "type": "integer" }, "updated_at": { "description": "Data e hora da última atualização em UTC.", "format": "date-time", "type": "string" } }, "required": [], "type": "object" }, "Product": { "additionalProperties": false, "example": { "created_at": "2026-10-18T00:00:00Z", "description": "Desktop reporting software", "id": "11111111-1111-4111-8111-111111111111", "name": "Report app", "status": "active", "updated_at": "2026-10-18T00:00:00Z" }, "properties": { "created_at": { "description": "Data de criação, UTC ISO 8601.", "format": "date-time", "type": "string" }, "description": { "description": "Descrição do produto.", "type": "string" }, "id": { "description": "UUID do produto usado no SDK e ao criar políticas.", "format": "uuid", "type": "string" }, "name": { "description": "Nome do produto.", "maxLength": 120, "minLength": 1, "type": "string" }, "status": { "description": "active permite ativação; disabled rejeita requisições de licença em execução.", "enum": [ "active", "disabled" ], "type": "string" }, "updated_at": { "description": "Última atualização, UTC ISO 8601.", "format": "date-time", "type": "string" } }, "required": [ "id", "name", "status" ], "type": "object" }, "ProductCreate": { "additionalProperties": false, "properties": { "description": { "description": "Descrição opcional, até 1000 caracteres.", "maxLength": 1000, "type": "string" }, "name": { "description": "Nome do software, 1–120 caracteres.", "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "ProductList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Product" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "type": "object" }, "ProductUpdate": { "additionalProperties": false, "properties": { "description": { "description": "Descrição do produto; pode estar vazia.", "maxLength": 1000, "type": "string" }, "name": { "description": "Nome legível por pessoas; consulte os limites de comprimento.", "maxLength": 120, "minLength": 1, "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "disabled" ], "type": "string" } }, "required": [], "type": "object" }, "ProviderRefund": { "additionalProperties": false, "properties": { "amount_cents": { "minimum": 0, "type": "integer" }, "attempted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "attempts": { "minimum": 0, "type": "integer" }, "case_id": { "format": "uuid", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "last_error": { "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "order_id": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "waffo", "paddle" ], "type": "string" }, "provider_refund_id": { "type": [ "string", "null" ] }, "reason": { "type": "string" }, "reserved": { "type": "boolean" }, "settled_cents": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "created", "submitting", "pending", "unknown", "completed", "failed" ], "type": "string" }, "submitted_cents": { "minimum": 0, "type": "integer" }, "unapplied": { "type": "boolean" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "PurchaseList": { "additionalProperties": false, "properties": { "active": { "anyOf": [ { "$ref": "#/components/schemas/PlanPurchase", "description": "Indicador da chave de assinatura atual; em uma prévia de política, quantidade de dispositivos/sessões ativos." }, { "description": "Indicador da chave de assinatura atual; em uma prévia de política, quantidade de dispositivos/sessões ativos.", "type": "null" } ], "description": "Contrato de pacote comprado efetivo atual, ou null." }, "active_devices": { "description": "Ocupação atual de produto/dispositivo registrado, independente do histórico mensal de uso. Registros comuns continuam contados offline até serem liberados. Sessões floating contam apenas com concessões válidas e são deduplicadas por hardware, usando identidade do dispositivo na falta deste. A liberação ou expiração da última sessão floating devolve capacidade; registros válidos continuam entre meses de cota. Registros isolados de teste SDK são excluídos.", "type": "integer" }, "coverage_ends_at": { "anyOf": [ { "description": "Fim da cobertura contínua de pacote pago, ou null.", "format": "date-time", "type": "string" }, { "description": "Fim da cobertura contínua de pacote pago, ou null.", "type": "null" } ], "description": "Fim da cobertura pré-paga total, incluindo renovações antecipadas pagas e presentes agendados. O pacote ativo ainda informa seu próprio período de cota atual." }, "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/PlanPurchase" }, "type": "array" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "renewal_package": { "anyOf": [ { "$ref": "#/components/schemas/PlanPurchase", "description": "Contrato pago mais recente elegível para renovação, ou null." }, { "description": "Contrato pago mais recente elegível para renovação, ou null.", "type": "null" } ], "description": "Cobertura paga ou presenteada mais recente, incluindo seu upgrade aplicado. Use este plano e moeda efetivos para selecionar renovação manual ou automática. Null até um pacote ser aberto." }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [], "type": "object" }, "RechargeInput": { "additionalProperties": false, "description": "Vincule purchase_id OR upgrade_id, nunca ambos. Pagamento confirmado credita a carteira e quita a compra/upgrade se a cotação ainda for válida. Pagamentos tardios de upgrade permanecem na carteira.", "properties": { "amount": { "description": "Valor decimal de recarga, no máximo duas casas", "type": "string" }, "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "purchase_id": { "format": "uuid", "type": [ "string", "null" ] }, "request_id": { "maxLength": 80, "type": "string" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" }, "upgrade_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] } }, "required": [ "currency", "amount", "request_id" ], "type": "object" }, "RecoverOriginalRefund": { "additionalProperties": false, "properties": { "confirm_unpaid_manual": { "const": true, "type": "boolean" }, "expected_updated_at": { "format": "date-time", "type": "string" } }, "required": [ "confirm_unpaid_manual" ], "type": "object" }, "RefundHistory": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/RefundHistoryItem" }, "type": "array" }, "limit": { "minimum": 0, "type": "integer" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "offset": { "minimum": 0, "type": "integer" }, "total": { "minimum": 0, "type": "integer" } }, "type": "object" }, "RefundHistoryItem": { "additionalProperties": false, "properties": { "amount_cents": { "minimum": 0, "type": "integer" }, "case_id": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "id": { "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "order_id": { "type": "string" }, "provider": { "enum": [ "paypal", "waffo", "paddle" ], "type": "string" }, "provider_refund_id": { "type": "string" }, "reason": { "type": "string" }, "settled_cents": { "minimum": 0, "type": "integer" }, "status": { "type": "string" } }, "type": "object" }, "RefundInboxItem": { "additionalProperties": false, "properties": { "amount_cents": { "minimum": 0, "type": "integer" }, "cancellation_scope": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "customer_email": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "manual_refund_pending": { "type": "boolean" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "order_id": { "type": "string" }, "pending_review": { "type": "boolean" }, "purchase_id": { "type": "string" }, "reason": { "type": "string" }, "refund_totals": { "description": "Valores por moeda codificados em JSON para cancelamentos com escopo definido.", "type": "string" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "scope": { "enum": [ "wallet", "service" ], "type": "string" }, "source": { "enum": [ "wallet_request", "support_case" ], "type": "string" }, "status": { "type": "string" }, "tenant_name": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "RefundInboxList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/RefundInboxItem" }, "type": "array" }, "limit": { "minimum": 0, "type": "integer" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "offset": { "minimum": 0, "type": "integer" }, "summary": { "additionalProperties": false, "properties": { "pending_review": { "minimum": 0, "type": "integer" }, "service_pending_review": { "minimum": 0, "type": "integer" }, "wallet_pending_review": { "minimum": 0, "type": "integer" } }, "type": "object" }, "total": { "minimum": 0, "type": "integer" } }, "type": "object" }, "RefundInput": { "additionalProperties": false, "properties": { "amount": { "description": "Valor positivo de reembolso na moeda da captura; não pode exceder os fundos capturados restantes nem o crédito disponível não gasto da carteira.", "pattern": "^[0-9]+(?:\\.[0-9]{1,2})?$", "type": "string" }, "reason": { "maxLength": 255, "minLength": 1, "type": "string" }, "request_id": { "maxLength": 80, "minLength": 1, "type": "string" } }, "required": [ "amount", "reason", "request_id" ], "type": "object" }, "RefundList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/PayPalRefund" }, "type": "array" }, "total": { "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "RefundQuote": { "additionalProperties": false, "properties": { "amount_cents": { "type": "integer" }, "automatic_entitlement_cancellation": { "type": "boolean" }, "currency": { "type": "string" }, "purchase_id": { "format": "uuid", "type": "string" }, "quoted_at": { "format": "date-time", "type": "string" }, "requires_confirmation": { "type": "boolean" } }, "required": [], "type": "object" }, "RefundReview": { "additionalProperties": false, "properties": { "amount": { "type": "string" }, "amounts": { "items": { "additionalProperties": false, "properties": { "amount": { "type": "string" }, "purchase_id": { "format": "uuid", "type": "string" } }, "required": [ "purchase_id", "amount" ], "type": "object" }, "type": "array" }, "approve": { "type": "boolean" }, "decision": { "maxLength": 3000, "type": "string" }, "expected_updated_at": { "format": "date-time", "type": "string" }, "quote_hash": { "type": "string" }, "quoted_at": { "format": "date-time", "type": "string" } }, "required": [ "approve", "decision" ], "type": "object" }, "Register": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "name": { "maxLength": 120, "minLength": 1, "type": "string" }, "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "password": { "description": "12–128 bytes UTF-8, não caracteres", "type": "string", "writeOnly": true }, "password_confirmation": { "description": "Obrigatório e deve corresponder exatamente à senha", "type": "string", "writeOnly": true }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "tenant_name": { "maxLength": 120, "minLength": 1, "type": "string" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" } }, "required": [ "email", "password", "password_confirmation", "name", "tenant_name" ], "type": "object" }, "Release": { "additionalProperties": false, "example": { "channel": "stable", "created_at": "2026-10-18T00:00:00Z", "download_url": "", "id": "33333333-3333-4333-8333-333333333333", "notes": "Initial release", "product_id": "11111111-1111-4111-8111-111111111111", "published_at": "2026-10-18T00:00:00Z", "sha256": "", "version": "1.0.0" }, "properties": { "channel": { "description": "Canal de publicação, stable ou preview; o padrão é stable.", "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "download_url": { "description": "URL de download HTTPS; sha256 é obrigatório quando uma URL é informada.", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "notes": { "description": "Notas de versão", "type": "string" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "published_at": { "description": "Data e hora de publicação da versão, em UTC; o padrão é o horário do servidor.", "format": "date-time", "type": "string" }, "sha256": { "description": "SHA-256 do arquivo para download, 64 caracteres hexadecimais minúsculos, distinto do algoritmo de assinatura.", "type": "string" }, "version": { "description": "Revisão da política, versão major.minor.patch do produto ou versão 1 do protocolo offline, conforme o objeto.", "type": "string" } }, "required": [ "id", "product_id", "version", "channel", "notes", "download_url", "sha256", "published_at", "created_at" ], "type": "object" }, "ReleaseInput": { "additionalProperties": false, "properties": { "channel": { "description": "Canal de publicação, stable ou preview; o padrão é stable.", "enum": [ "stable", "preview" ], "type": "string" }, "download_url": { "description": "URL de download HTTPS; sha256 é obrigatório quando uma URL é informada.", "format": "uri", "maxLength": 2000, "type": "string" }, "notes": { "description": "Notas de versão", "maxLength": 10000, "type": "string" }, "published_at": { "description": "Data e hora de publicação da versão, em UTC; o padrão é o horário do servidor.", "format": "date-time", "type": "string" }, "sha256": { "description": "SHA-256 do arquivo para download, 64 caracteres hexadecimais minúsculos, distinto do algoritmo de assinatura.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "version": { "description": "Revisão da política, versão major.minor.patch do produto ou versão 1 do protocolo offline, conforme o objeto.", "pattern": "^(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})$", "type": "string" } }, "required": [ "version" ], "type": "object" }, "ReleaseList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Release" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total", "limit", "offset" ], "type": "object" }, "Renew": { "additionalProperties": false, "properties": { "days": { "description": "Dias adicionais, 1–36500; renovações de licença e manutenção afetam prazos diferentes.", "maximum": 36500, "minimum": 1, "type": "integer" } }, "required": [ "days" ], "type": "object" }, "RenewalPlans": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Price" }, "type": "array" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [ "items", "mode" ], "type": "object" }, "Renewed": { "additionalProperties": false, "example": { "duration_days": 60, "expires_at": null, "id": "33333333-3333-4333-8333-333333333333" }, "properties": { "duration_days": { "description": "Renovações antes da primeira ativação aumentam este valor. Após a ativação, ele mantém a duração original; use expires_at para o prazo real.", "maximum": 36500, "minimum": 1, "type": [ "integer", "null" ] }, "expires_at": { "anyOf": [ { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "format": "date-time", "type": "string" }, { "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial.", "type": "null" } ], "description": "Expiração da licença; null para licenças timed/trial não ativadas ou perpetual. Em objetos de chave, expiração da credencial." }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, "required": [ "id", "expires_at", "duration_days" ], "type": "object" }, "ReservationResult": { "additionalProperties": false, "properties": { "activation_id": { "description": "UUID do vínculo ou sessão. Salve para próximas requisições; não é chave de licença.", "format": "uuid", "type": "string" }, "heartbeat_seconds": { "anyOf": [ { "const": 0 }, { "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "Intervalo atual em segundos; a contagem não atualiza a assinatura nem o temporizador.", "type": "integer" }, "reservation": { "$ref": "#/components/schemas/FeatureReservation" } }, "required": [ "activation_id", "reservation" ], "type": "object" }, "Revenue": { "additionalProperties": false, "properties": { "invoices": { "items": { "additionalProperties": false, "properties": { "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "email": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "month": { "type": "string" }, "paid_at": { "format": "date-time", "type": "string" }, "plan": { "type": "string" }, "plan_name": { "type": "string" }, "refunded_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "tenant_name": { "type": "string" }, "total_cents": { "type": "integer" } }, "required": [], "type": "object" }, "type": "array" }, "limit": { "type": "integer" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "month": { "type": "string" }, "offset": { "type": "integer" }, "paddle_totals": { "description": "Pagamentos brutos e reembolsos cumulativos de compras de serviço e recargas de carteira, agrupados por mês original de pagamento e moeda; não é liquidação bancária.", "items": { "additionalProperties": false, "properties": { "currency": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" }, "paid_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" }, "refunded_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" } }, "required": [ "currency", "paid_cents", "refunded_cents" ], "type": "object" }, "type": "array" }, "paid_users": { "type": "integer" }, "purchase_total": { "type": "integer" }, "purchases": { "items": { "additionalProperties": false, "properties": { "api_calls": { "type": "integer" }, "api_overage_cents": { "type": "integer" }, "base_cents": { "type": "integer" }, "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "email": { "type": "string" }, "ends_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "overage_cents": { "type": "integer" }, "plan": { "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "plan_name": { "type": "string" }, "source": { "enum": [ "purchase", "gift" ], "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "pending", "active", "cancelled" ], "type": "string" }, "tenant_name": { "type": "string" }, "term_months": { "default": 1, "enum": [ 1, 3, 6, 12 ], "type": "integer" } }, "required": [], "type": "object" }, "type": "array" }, "recharged_users": { "type": "integer" }, "registered_users": { "type": "integer" }, "sales": { "items": { "additionalProperties": false, "properties": { "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "plan": { "type": "string" }, "plan_name": { "type": "string" }, "quantity": { "type": "integer" }, "total_cents": { "type": "integer" } }, "required": [], "type": "object" }, "type": "array" }, "sold_subscriptions": { "type": "integer" }, "timezone": { "type": "string" }, "topup_total": { "type": "integer" }, "topups": { "items": { "additionalProperties": false, "properties": { "amount_cents": { "type": "integer" }, "credited_at": { "format": "date-time", "type": "string" }, "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "email": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "provider": { "description": "Provedor original da recarga de carteira; reembolsos permanecem vinculados a ele.", "enum": [ "paypal", "paddle", "waffo" ], "type": "string" }, "refunded_cents": { "type": "integer" }, "status": { "type": "string" }, "tenant_name": { "type": "string" } }, "required": [], "type": "object" }, "type": "array" }, "total": { "type": "integer" }, "totals": { "items": { "additionalProperties": false, "properties": { "consumption_cents": { "type": "integer" }, "consumption_refund_cents": { "type": "integer" }, "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "paypal_refund_cents": { "type": "integer" }, "recharge_cents": { "type": "integer" }, "wallet_refund_cents": { "description": "Reembolsos/reversões de carteira executados em PayPal, Paddle e Waffo; exclui retenções temporárias de reembolso.", "type": "integer" } }, "required": [], "type": "object" }, "type": "array" }, "upgrade_total": { "description": "Número de upgrades aplicados no ambiente e período de relatório selecionados, incluindo upgrades gratuitos. Contado separadamente das vendas iniciais de pacotes.", "type": "integer" }, "upgrades": { "items": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Valor proporcional efetivamente pago; não é o novo preço mensal integral.", "type": "integer" }, "applied_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "email": { "type": "string" }, "ends_at": { "description": "Expiração original do pacote, inalterada pelo upgrade.", "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "plan_name": { "description": "Nome do pacote de destino.", "type": "string" }, "previous_plan_name": { "description": "Pacote efetivo antes deste upgrade.", "type": "string" }, "tenant_name": { "type": "string" } }, "required": [ "id", "email", "tenant_name", "plan_name", "previous_plan_name", "currency", "amount_cents", "applied_at", "ends_at" ], "type": "object" }, "type": "array" }, "waffo_totals": { "description": "Pagamentos brutos e reembolsos cumulativos de compras de serviço e recargas de carteira, agrupados por mês original de pagamento e moeda; não é liquidação bancária.", "items": { "additionalProperties": false, "properties": { "currency": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "paid_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" }, "refunded_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" } }, "required": [ "currency", "paid_cents", "refunded_cents" ], "type": "object" }, "type": "array" } }, "required": [], "type": "object" }, "RuntimeAPIPeriod": { "additionalProperties": false, "properties": { "api_calls": { "description": "Chamadas API de execução medidas e bem-sucedidas no escopo; solicitações de gerenciamento são excluídas.", "type": "integer" }, "api_hard_limit": { "description": "Se chamadas de execução param no limite da franquia API.", "type": "boolean" }, "api_overage_cents": { "description": "Cobrança de excedente API em centésimos neste ciclo.", "type": "integer" }, "api_unit_micros": { "description": "Preço por chamada de execução excedente em milionésimos.", "minimum": 0, "type": "integer" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "included_api_calls": { "description": "null = ilimitado; 0 = nenhuma chamada bem-sucedida incluída", "maximum": 1000000000000, "minimum": 0, "type": [ "integer", "null" ] }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "price_version": { "description": "Revisão do preço", "type": "string" } }, "required": [], "type": "object" }, "RuntimeInput": { "additionalProperties": false, "properties": { "activation_id": { "description": "data.activation_id da última ativação. Obrigatório em validação, heartbeat, consume e desativação; omita só no primeiro activate.", "format": "uuid", "type": "string" }, "app_version": { "description": "Versão atual major.minor.patch, como 1.0.0. Obrigatória com manutenção ou faixa. Não declare versão antiga falsa.", "pattern": "^$|^(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})$", "type": "string" }, "device_id": { "description": "SHA-256 de 64 caracteres hexadecimais minúsculos calculado de produto, sistema e hardware. Não use valor fixo arbitrário.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "device_name": { "description": "Nome no painel, até 120 caracteres. Não determina identidade do dispositivo.", "maxLength": 120, "type": "string" }, "device_profile": { "$ref": "#/components/schemas/DeviceProfile", "description": "Perfil gerado pelo SDK. Forneça conforme regras de hardware, rejeição de VM ou migração por hardware." }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "feature": { "description": "Identificador do recurso consumido.", "maxLength": 64, "type": "string" }, "identity_token": { "description": "JWT de identidade Launch Ed25519 tipado e de uso único; nenhuma declaração de entitlement é confiável como direito de compra.", "maxLength": 12288, "type": "string", "writeOnly": true }, "launch_connection_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "license_key": { "description": "Chave completa: lv_lic_ normal; lv_tmp_ para resgate inicial. Após sucesso, o SDK usa lv_dev_ vinculado à máquina. Não é API Key de gestão.", "pattern": "^(?:lv_(?:lic|tmp|dev)_[A-Za-z0-9_-]{43})?$", "type": "string", "writeOnly": true }, "product_id": { "description": "UUID do produto; deve corresponder ao produto da licença.", "format": "uuid", "type": "string" }, "quantity": { "description": "Unidades solicitadas para esta operação, inteiro 1–1000000000.", "maximum": 1000000000, "minimum": 1, "type": "integer" }, "request_logout_ticket": { "description": "Negociação de capacidades do SDK. Solicite um ticket de logout apenas para desvinculação quando não houver ticket guardado para a vinculação atual. Omita quando já houver ticket válido; heartbeats em estado estável evitam busca adicional.", "type": "boolean" }, "reservation_id": { "description": "ID da reserva; envie este valor para confirmar ou cancelar.", "format": "uuid", "type": "string" }, "reservation_seconds": { "default": 900, "description": "Duração opcional: 30–3600 segundos, padrão 900. O reinício do período pode encerrá-la antes.", "maximum": 3600, "minimum": 30, "type": "integer" }, "session_id": { "description": "Obrigatório em flutuante: novo UUID por instância, reutilizado nas requisições dela. Opcional no modo vinculado.", "format": "uuid", "type": "string" } }, "required": [ "product_id", "license_key", "device_id" ], "type": "object" }, "RuntimePolicy": { "additionalProperties": false, "properties": { "heartbeat_seconds": { "anyOf": [ { "const": 0 }, { "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "Intervalo de heartbeat online, em segundos. 0 desativa os periódicos. A permissão offline é separada.", "type": "integer" }, "offline_mode": { "description": "limited: offline limitado; none: proibido; permanent: sem limite adicional offline, mas sujeito à validade da licença.", "enum": [ "limited", "none", "permanent" ], "type": "string" }, "offline_seconds": { "description": "Segundos offline permitidos: 1–31536000 para limited, 0 para none/permanent. Este não é o intervalo de heartbeat. Com os heartbeats ativados, as novas políticas offline limitadas devem cumprir offline_seconds \u003e= 3 × heartbeat_seconds; as concessões de assentos flutuantes também devem abranger pelo menos três intervalos de heartbeat.", "maximum": 31536000, "minimum": 0, "type": "integer" } }, "required": [ "heartbeat_seconds", "offline_mode", "offline_seconds" ], "type": "object" }, "RuntimeResult": { "additionalProperties": false, "properties": { "activation_id": { "description": "UUID do vínculo ou sessão. Salve para próximas requisições; não é chave de licença.", "format": "uuid", "type": "string" }, "deactivated": { "description": "true ao desativar. Libera vínculo ou sessão, sem excluir licença ou reiniciar validade.", "type": "boolean" }, "device_key": { "description": "Credencial de dispositivo restrita e vinculada ao dispositivo e à geração da vinculação. Credenciais no modo de conta também exigem sessão de autorização ativa e entitlement; não podem reativar uma vinculação liberada.", "pattern": "^lv_dev_[A-Za-z0-9_-]{43}$", "type": "string" }, "heartbeat_seconds": { "anyOf": [ { "const": 0, "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline." }, { "description": "Intervalo de heartbeat em segundos: 0 desativa; caso contrário, 600–86400. Se omitido, usa os padrões do servidor; independente da permissão offline.", "maximum": 86400, "minimum": 600, "type": "integer" } ], "description": "Segundos sugeridos. O campo superior pode faltar para 0; runtime_policy.heartbeat_seconds assinado é o valor da política.", "type": "integer" }, "lease": { "$ref": "#/components/schemas/Lease", "description": "Cache assinado pelo servidor. Aceite após verificar com chave confiável fixa e conferir produto/dispositivo. Não retorna em desativação ou consume." }, "logout_ticket": { "$ref": "#/components/schemas/LogoutTicket", "description": "Capacidade apenas de desvinculação para esta geração exata da vinculação; mantenha fora dos logs de solicitações de execução." } }, "required": [ "activation_id" ], "type": "object" }, "SDKConfig": { "additionalProperties": false, "example": { "allow_http": false, "app_version": "", "base_url": "https://www.licentivo.com", "cache_path": "", "device_name": "My application", "license_key": "", "product_id": "11111111-1111-4111-8111-111111111111", "trusted_keys": { "66666666-6666-4666-8666-666666666666": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "properties": { "allow_http": { "description": "Indica se HTTP é permitido, somente para desenvolvimento local.", "type": "boolean" }, "app_version": { "description": "Versão atual major.minor.patch do software.", "type": "string" }, "base_url": { "description": "Origem do servidor de licenças, normalmente HTTPS, sem /api/v1.", "type": "string" }, "cache_path": { "description": "Caminho do cache local; vazio permite que o SDK escolha um diretório privado do usuário.", "type": "string" }, "device_name": { "description": "Rótulo de dispositivo legível por pessoas, não uma identidade de segurança.", "type": "string" }, "license_key": { "description": "Chave completa de licença do cliente fornecida na ativação. Código de inicialização do produto e downloads de exemplo não contêm este segredo. Solicitações offline usam a credencial fornecida pelo SDK.", "type": "string" }, "product_id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "trusted_keys": { "additionalProperties": { "type": "string" }, "description": "Mapa do UUID da chave pública para a chave pública Base64URL usada na verificação com chave fixada.", "type": "object" } }, "required": [ "base_url", "product_id", "license_key", "app_version", "device_name", "trusted_keys", "cache_path", "allow_http" ], "type": "object" }, "SDKExampleInfo": { "additionalProperties": false, "properties": { "available": { "type": "boolean" }, "can_configure": { "type": "boolean" }, "duration_days": { "const": 3, "type": "integer" }, "starts_at_first_activation": { "type": "boolean" } }, "required": [], "type": "object" }, "SDKExampleSetting": { "additionalProperties": false, "properties": { "available": { "type": "boolean" }, "duration_days": { "const": 3, "type": "integer" }, "policy_id": { "description": "UUID da política dedicada; vazio antes da configuração inicial.", "type": "string" }, "product_id": { "description": "UUID do produto dedicado; vazio antes da configuração inicial.", "type": "string" } }, "required": [ "available", "duration_days", "product_id", "policy_id" ], "type": "object" }, "SDKExampleSetup": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" } }, "required": [], "type": "object" }, "SDKExampleTrial": { "additionalProperties": false, "properties": { "duration_days": { "const": 3, "type": "integer" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "first_activated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "license_key": { "type": "string" }, "starts_at_first_activation": { "type": "boolean" }, "status": { "type": "string" } }, "required": [], "type": "object" }, "SDKInitializer": { "additionalProperties": false, "example": { "language": "go", "product_id": "11111111-1111-4111-8111-111111111111", "source": "const productID = \"11111111-1111-4111-8111-111111111111\"\nvar trustedKeys = map[string]string{\"66666666-6666-4666-8666-666666666666\": \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\"}\n", "trusted_keys": { "66666666-6666-4666-8666-666666666666": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "properties": { "language": { "description": "Identificador da linguagem SDK do pacote para download.", "type": "string" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" }, "source": { "description": "Constantes públicas do produto para colar no código; nenhum segredo de ativação do cliente.", "type": "string" }, "trusted_keys": { "additionalProperties": { "type": "string" }, "description": "Mapa do UUID da chave pública para a chave pública Base64URL usada na verificação com chave fixada.", "type": "object" } }, "required": [ "product_id", "trusted_keys", "language", "source" ], "type": "object" }, "ScheduledPlan": { "additionalProperties": false, "properties": { "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "type": "string" }, "effective_month": { "description": "Mês UTC YYYY-MM em que o agendamento entra em vigor.", "type": "string" }, "plan": { "description": "Identificador estável do plano de faturamento do catálogo publicado.", "type": "string" }, "sandbox": { "description": "Ambiente de teste", "type": "boolean" } }, "required": [], "type": "object" }, "ScopedRefundPreview": { "additionalProperties": false, "properties": { "affected_purchases": { "items": { "$ref": "#/components/schemas/ScopedRefundPurchase" }, "type": "array" }, "auto_renewal_disabled": { "type": "boolean" }, "auto_renewal_enabled": { "type": "boolean" }, "cancellation_at": { "const": "approval", "type": "string" }, "pending_purchase_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "pending_upgrade_ids": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "quote_hash": { "type": "string" }, "quoted_at": { "format": "date-time", "type": "string" }, "remaining_purchases": { "items": { "$ref": "#/components/schemas/ScopedRefundPurchase" }, "type": "array" }, "request": { "$ref": "#/components/schemas/CustomerRefundInput" }, "scope": { "enum": [ "purchase", "service" ], "type": "string" }, "totals": { "items": { "$ref": "#/components/schemas/ScopedRefundTotal" }, "type": "array" } }, "required": [], "type": "object" }, "ScopedRefundPurchase": { "additionalProperties": false, "properties": { "amount_cents": { "type": "integer" }, "approved_cents": { "type": "integer" }, "currency": { "type": "string" }, "ends_at": { "format": "date-time", "type": "string" }, "maximum_cents": { "type": "integer" }, "plan_name": { "type": "string" }, "purchase_id": { "format": "uuid", "type": "string" }, "requires_review": { "type": "boolean" }, "source": { "type": "string" }, "starts_at": { "format": "date-time", "type": "string" } }, "required": [], "type": "object" }, "ScopedRefundTotal": { "additionalProperties": false, "properties": { "amount_cents": { "type": "integer" }, "approved_cents": { "type": "integer" }, "currency": { "type": "string" }, "held_cents": { "type": "integer" }, "manual_cents": { "type": "integer" } }, "required": [], "type": "object" }, "ServiceCompensation": { "additionalProperties": false, "properties": { "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "incident_id": { "description": "UUID do incidente de serviço relacionado.", "format": "uuid", "type": "string" }, "intervals": { "description": "Intervalos de tempo compensados retornados como uma string JSON.", "type": "string" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "type": "string" }, "purchase_id": { "description": "UUID da compra de pacote relacionada.", "format": "uuid", "type": "string" }, "seconds": { "description": "Segundos adicionados como compensação de serviço.", "type": "integer" } }, "required": [ "id", "incident_id", "mode", "seconds", "purchase_id", "created_at" ], "type": "object" }, "ServiceCompensationList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/ServiceCompensation" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "ServiceIncident": { "additionalProperties": false, "properties": { "affected_tenants": { "description": "Array de IDs de espaços de trabalho codificado em JSON; [] indica global.", "type": "string" }, "body": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "emergency": { "type": "boolean" }, "ends_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "format": "uuid", "type": "string" }, "kind": { "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "required": [], "type": "object" }, "ServiceIncidentInput": { "additionalProperties": false, "properties": { "affected_tenants": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "body": { "type": "string" }, "emergency": { "type": "boolean" }, "ends_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "expected_version": { "type": "string" }, "id": { "type": "string" }, "kind": { "enum": [ "maintenance", "incident" ], "type": "string" }, "starts_at": { "format": "date-time", "type": "string" }, "title": { "type": "string" } }, "required": [ "kind", "title", "body", "starts_at" ], "type": "object" }, "ServiceIncidentList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ServiceIncident" }, "type": "array" }, "now": { "format": "date-time", "type": "string" }, "total": { "type": "integer" } }, "required": [], "type": "object" }, "SignedCapabilities": { "additionalProperties": false, "properties": { "app_version": { "description": "app version para esta operação de autorização Launch.", "pattern": "^(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})\\.(0|[1-9][0-9]{0,8})$", "type": "string" }, "binding_version": { "description": "Geração assinada da vinculação do dispositivo, associada à sessão de autorização.", "minimum": 1, "type": "integer" }, "environment": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" }, "launch_connection_id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "license_model": { "description": "license model para esta operação de autorização Launch.", "enum": [ "node_locked", "floating" ], "type": "string" }, "maintenance_until": { "description": "maintenance until para esta operação de autorização Launch.", "type": "integer" }, "session_expires_at": { "description": "session expires at para esta operação de autorização Launch.", "maximum": 253402300799, "type": "integer" }, "session_id": { "description": "session id para esta operação de autorização Launch.", "format": "uuid", "type": "string" }, "version_released_at": { "description": "version released at para esta operação de autorização Launch.", "type": "integer" } }, "required": [ "license_model" ], "type": "object" }, "SigningKey": { "additionalProperties": false, "properties": { "active": { "description": "Indicador da chave de assinatura atual; em uma prévia de política, quantidade de dispositivos/sessões ativos.", "type": "boolean" }, "algorithm": { "const": "Ed25519", "description": "Algoritmo de assinatura, atualmente Ed25519.", "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "key_id": { "description": "UUID da chave de assinatura do produto usado para selecionar uma chave de verificação.", "format": "uuid", "type": "string" }, "public_key": { "description": "Chave pública Ed25519 codificada em Base64URL; sem material privado.", "type": "string" }, "retired_at": { "anyOf": [ { "description": "Data e hora de aposentadoria da chave; null para chaves atuais. Chaves públicas aposentadas continuam disponíveis para verificação.", "format": "date-time", "type": "string" }, { "description": "Data e hora de aposentadoria da chave; null para chaves atuais. Chaves públicas aposentadas continuam disponíveis para verificação.", "type": "null" } ], "description": "Data e hora de aposentadoria da chave; null para chaves atuais. Chaves públicas aposentadas continuam disponíveis para verificação." } }, "required": [ "key_id", "public_key", "active" ], "type": "object" }, "StateResult": { "additionalProperties": false, "example": { "id": "33333333-3333-4333-8333-333333333333", "status": "pending" }, "properties": { "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "type": "string" } }, "required": [ "id", "status" ], "type": "object" }, "Subscription": { "additionalProperties": false, "properties": { "current": { "$ref": "#/components/schemas/Period", "description": "Snapshot de faturamento padrão do mês UTC atual." }, "next": { "anyOf": [ { "$ref": "#/components/schemas/PendingPlan", "description": "Plano padrão agendado para o próximo mês, ou null." }, { "description": "Plano padrão agendado para o próximo mês, ou null.", "type": "null" } ], "description": "Plano padrão agendado para o próximo mês, ou null." }, "sandbox": { "description": "Ambiente de teste", "type": "boolean" } }, "required": [], "type": "object" }, "Summary": { "additionalProperties": false, "properties": { "active_licenses": { "description": "Quantidade de licenças ativas e não expiradas, incluindo as aguardando primeira ativação.", "type": "integer" }, "licenses": { "description": "Número de licenças não arquivadas.", "type": "integer" }, "policies": { "description": "Número de políticas não arquivadas.", "type": "integer" }, "products": { "description": "Quantidade de produtos no resumo; grupos de uso de dispositivos por produto nas respostas de uso.", "type": "integer" } }, "required": [ "products", "policies", "licenses", "active_licenses" ], "type": "object" }, "SupportCase": { "additionalProperties": false, "properties": { "amount_cents": { "type": "integer" }, "approved_cents": { "type": "integer" }, "cancellation_preview": { "description": "Prévia de cancelamento codificada em JSON.", "type": "string" }, "cancellation_scope": { "type": "string" }, "change_id": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "decision": { "type": "string" }, "first_response_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "held_cents": { "type": "integer" }, "id": { "format": "uuid", "type": "string" }, "incident_id": { "type": "string" }, "kind": { "type": "string" }, "manual_cents": { "type": "integer" }, "manual_refund_pending": { "type": "boolean" }, "mode": { "type": "string" }, "order_id": { "type": "string" }, "purchase_id": { "type": "string" }, "reason": { "type": "string" }, "refund_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "refund_totals": { "description": "Totais por moeda codificados em JSON; nunca some moedas diferentes.", "type": "string" }, "request_id": { "type": "string" }, "response_due_at": { "format": "date-time", "type": "string" }, "review_due_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "scope_ids": { "type": "string" }, "status": { "type": "string" }, "subject": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [], "type": "object" }, "SupportCaseDetail": { "additionalProperties": false, "properties": { "case": { "$ref": "#/components/schemas/SupportCase" }, "messages": { "items": { "additionalProperties": false, "properties": { "body": { "type": "string" }, "case_id": { "format": "uuid", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "staff": { "type": "boolean" }, "user_id": { "format": "uuid", "type": "string" } }, "required": [], "type": "object" }, "type": "array" }, "original_refund_receipts": { "items": { "additionalProperties": false, "properties": { "amount_cents": { "minimum": 0, "type": "integer" }, "currency": { "type": "string" }, "intent_id": { "format": "uuid", "type": "string" }, "refund_id": { "type": "string" } }, "type": "object" }, "type": "array" }, "original_refunds": { "items": { "$ref": "#/components/schemas/ProviderRefund" }, "type": "array" }, "refund_payments": { "items": { "additionalProperties": false, "properties": { "amount_cents": { "minimum": 0, "type": "integer" }, "currency": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "provider": { "type": "string" }, "provider_order_id": { "type": "string" }, "refunded_cents": { "minimum": 0, "type": "integer" }, "status": { "type": "string" } }, "type": "object" }, "type": "array" }, "refund_provider": { "type": "string" }, "refund_unverified": { "type": "boolean" }, "refunds": { "items": { "$ref": "#/components/schemas/PayPalRefund" }, "type": "array" } }, "required": [], "type": "object" }, "SupportCaseInput": { "additionalProperties": false, "properties": { "body": { "maxLength": 10000, "type": "string" }, "kind": { "enum": [ "support", "privacy", "appeal" ], "type": "string" }, "request_id": { "maxLength": 80, "type": "string" }, "subject": { "maxLength": 200, "type": "string" } }, "required": [ "subject", "body", "request_id" ], "type": "object" }, "SupportCaseList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/SupportCase" }, "type": "array" }, "now": { "format": "date-time", "type": "string" }, "total": { "type": "integer" } }, "required": [], "type": "object" }, "SupportContact": { "additionalProperties": false, "properties": { "email": { "description": "E-mail público de suporte e Reply-To dos e-mails de faturamento. Vazio oculta o contato. Não altera o endereço SMTP From existente nem cria uma caixa de entrada.", "maxLength": 254, "type": "string" } }, "required": [ "email" ], "type": "object" }, "SupportReadInput": { "additionalProperties": false, "properties": { "last_message_id": { "format": "uuid", "type": "string" } }, "required": [ "last_message_id" ], "type": "object" }, "SupportReply": { "additionalProperties": false, "properties": { "body": { "maxLength": 10000, "type": "string" }, "expected_updated_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "", "reviewing", "awaiting_info", "resolved" ], "type": "string" } }, "required": [ "body" ], "type": "object" }, "SupportUnread": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "case_id": { "format": "uuid", "type": "string" }, "unread_messages": { "type": "integer" } }, "required": [], "type": "object" }, "type": "array" }, "unread_cases": { "type": "integer" }, "unread_messages": { "type": "integer" }, "unread_notices": { "type": "integer" } }, "required": [], "type": "object" }, "SystemSettings": { "additionalProperties": false, "properties": { "database": { "$ref": "#/components/schemas/DatabaseStatus" }, "environment": { "type": "string" }, "mail": { "$ref": "#/components/schemas/MailSettings" }, "public_url": { "format": "uri", "type": "string" } }, "required": [ "mail", "database" ], "type": "object" }, "TLSCertificateInfo": { "additionalProperties": false, "properties": { "algorithm": { "type": "string" }, "chain_length": { "maximum": 10, "minimum": 1, "type": "integer" }, "domains": { "items": { "type": "string" }, "type": "array" }, "fingerprint_sha256": { "pattern": "^[0-9a-f]{64}$", "type": "string" }, "issuer": { "type": "string" }, "not_after": { "format": "date-time", "type": "string" }, "not_before": { "format": "date-time", "type": "string" }, "self_signed": { "type": "boolean" }, "serial_number": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "domains", "subject", "issuer", "not_before", "not_after", "fingerprint_sha256", "serial_number", "algorithm", "chain_length", "self_signed" ], "type": "object" }, "TLSCertificateInput": { "additionalProperties": false, "properties": { "certificate_pem": { "description": "Certificado final PEM seguido de seus certificados intermediários, em ordem. Deve corresponder a public_url. Somente o desenvolvimento local permite um certificado autoassinado.", "maxLength": 32768, "type": "string", "writeOnly": true }, "expected_version": { "description": "Use version de GET /system/tls. Obrigatório para atualizações; uma substituição concorrente retorna 409.", "type": "string" }, "private_key_pem": { "description": "Chave PEM correspondente não criptografada (PKCS#8, RSA ou EC). Nunca é retornada por nenhuma resposta.", "maxLength": 16384, "type": "string", "writeOnly": true } }, "required": [ "certificate_pem", "private_key_pem" ], "type": "object" }, "TLSCertificateResult": { "additionalProperties": false, "properties": { "certificate": { "$ref": "#/components/schemas/TLSCertificateInfo" }, "updated_at": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "required": [ "certificate", "version", "updated_at" ], "type": "object" }, "TLSCertificateUpdateInput": { "additionalProperties": false, "properties": { "certificate_pem": { "description": "Certificado final PEM seguido de seus certificados intermediários, em ordem. Deve corresponder a public_url. Somente o desenvolvimento local permite um certificado autoassinado.", "maxLength": 32768, "type": "string", "writeOnly": true }, "expected_version": { "description": "Use version de GET /system/tls. Obrigatório para atualizações; uma substituição concorrente retorna 409.", "type": "string" }, "private_key_pem": { "description": "Chave PEM correspondente não criptografada (PKCS#8, RSA ou EC). Nunca é retornada por nenhuma resposta.", "maxLength": 16384, "type": "string", "writeOnly": true } }, "required": [ "certificate_pem", "private_key_pem", "expected_version" ], "type": "object" }, "TLSStatus": { "additionalProperties": false, "properties": { "address": { "type": "string" }, "certificate": { "anyOf": [ { "$ref": "#/components/schemas/TLSCertificateInfo" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "http_redirect_address": { "type": "string" }, "public_url": { "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "version": { "type": "string" } }, "required": [ "enabled", "public_url", "address", "http_redirect_address", "certificate", "version", "updated_at" ], "type": "object" }, "TestMail": { "additionalProperties": false, "properties": { "to": { "format": "email", "type": "string" } }, "required": [ "to" ], "type": "object" }, "Token": { "additionalProperties": false, "properties": { "token": { "maxLength": 100, "minLength": 32, "type": "string", "writeOnly": true } }, "required": [ "token" ], "type": "object" }, "TokenPassword": { "additionalProperties": false, "properties": { "password": { "description": "12–128 bytes UTF-8, não caracteres", "type": "string", "writeOnly": true }, "password_confirmation": { "description": "Obrigatório e deve corresponder exatamente à senha", "type": "string", "writeOnly": true }, "token": { "maxLength": 100, "minLength": 32, "type": "string", "writeOnly": true } }, "required": [ "token", "password", "password_confirmation" ], "type": "object" }, "TransferCode": { "additionalProperties": false, "properties": { "activation_code": { "pattern": "^lv_tmp_[A-Za-z0-9_-]{43}$", "type": "string" }, "activation_id": { "format": "uuid", "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "license_id": { "format": "uuid", "type": "string" } }, "required": [ "activation_id", "activation_code", "expires_at", "license_id" ], "type": "object" }, "TranslationCheck": { "additionalProperties": false, "properties": { "connected": { "type": "boolean" }, "languages": { "items": { "$ref": "#/components/schemas/TranslationLanguage" }, "type": "array" }, "provider_usage": { "additionalProperties": false, "properties": { "character_count": { "type": "integer" }, "character_limit": { "type": "integer" } }, "required": [ "character_count", "character_limit" ], "type": "object" } }, "required": [ "connected", "languages", "provider_usage" ], "type": "object" }, "TranslationLanguage": { "additionalProperties": false, "properties": { "lang": { "description": "Código de destino BCP 47 retornado pelo DeepL v3, como en-US ou zh-Hant.", "type": "string" }, "name": { "type": "string" }, "usable_as_target": { "type": "boolean" } }, "required": [ "lang", "name", "usable_as_target" ], "type": "object" }, "TranslationOptions": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "languages": { "items": { "$ref": "#/components/schemas/TranslationLanguage" }, "type": "array" }, "provider": { "type": "string" } }, "required": [ "enabled", "languages", "provider" ], "type": "object" }, "TranslationSettings": { "additionalProperties": false, "properties": { "checked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "key_configured": { "type": "boolean" }, "languages": { "items": { "$ref": "#/components/schemas/TranslationLanguage" }, "type": "array" }, "local_usage": { "$ref": "#/components/schemas/TranslationUsage" }, "monthly_limit": { "description": "Orçamento mensal local de caracteres, independente da cota da conta DeepL e das datas de faturamento.", "type": "integer" }, "requests_per_minute": { "type": "integer" }, "tier": { "enum": [ "free", "pro" ], "type": "string" }, "version": { "type": "string" } }, "required": [ "enabled", "tier", "key_configured", "monthly_limit", "requests_per_minute", "languages", "checked_at", "version", "local_usage" ], "type": "object" }, "TranslationSettingsInput": { "additionalProperties": false, "properties": { "api_key": { "description": "Armazenada de forma criptografada. Vazio preserva a chave salva, a menos que clear_key seja true. Alterar a chave/o nível exige outra verificação de conexão bem-sucedida.", "maxLength": 1000, "type": "string", "writeOnly": true }, "clear_key": { "type": "boolean" }, "enabled": { "type": "boolean" }, "expected_version": { "type": "string" }, "monthly_limit": { "maximum": 1000000000, "minimum": 1, "type": "integer" }, "requests_per_minute": { "maximum": 60, "minimum": 1, "type": "integer" }, "tier": { "enum": [ "free", "pro" ], "type": "string" } }, "required": [ "enabled", "tier", "monthly_limit", "requests_per_minute", "expected_version" ], "type": "object" }, "TranslationUsage": { "additionalProperties": false, "properties": { "characters": { "description": "Caracteres faturados com sucesso mais reservas conservadoras para solicitações com resultados desconhecidos. Resultados obtidos do cache não aumentam o uso.", "type": "integer" }, "month": { "description": "Mês civil UTC YYYY-MM.", "type": "string" } }, "required": [ "month", "characters" ], "type": "object" }, "Trial": { "additionalProperties": false, "properties": { "base_url": { "type": "string" }, "duration_days": { "const": 7, "type": "integer" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "isolated": { "type": "boolean" }, "key": { "type": "string", "writeOnly": true }, "license_id": { "format": "uuid", "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "trusted_keys": { "items": { "$ref": "#/components/schemas/SigningKey" }, "type": "array" } }, "required": [ "product_id", "license_id", "key", "trusted_keys" ], "type": "object" }, "UpgradeList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/PlanUpgrade" }, "type": "array" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "UpgradePart": { "additionalProperties": false, "description": "Cálculo congelado de upgrade para um período pré-pago atual ou futuro. change.amount_cents é a diferença deste período; somente a cotação pai cobra a soma combinada.", "properties": { "change": { "$ref": "#/components/schemas/PlanUpgrade", "description": "Alteração de preço e direitos desta parte do upgrade." }, "ends_at": { "description": "Data e hora de término do pacote ou ciclo, UTC; pode ser null antes da ativação.", "format": "date-time", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "source": { "description": "Origem do entitlement, como purchase ou gift.", "enum": [ "purchase", "gift", "auto_renewal" ], "type": "string" }, "starts_at": { "description": "Data e hora de início do pacote ou ciclo, UTC.", "format": "date-time", "type": "string" } }, "required": [ "id", "source", "starts_at", "ends_at", "change" ], "type": "object" }, "UpgradeQuoteInput": { "additionalProperties": false, "properties": { "currency": { "pattern": "^[A-Z]{3}$", "type": "string" }, "plan": { "pattern": "^[a-z][a-z0-9_-]{0,63}$", "type": "string" }, "price_version": { "type": "string" }, "request_id": { "maxLength": 80, "type": "string" } }, "required": [ "plan", "currency", "price_version", "request_id" ], "type": "object" }, "Usage": { "additionalProperties": false, "properties": { "active_devices": { "description": "Para o mês UTC atual: ocupação atual de produto/dispositivo registrado, independente do histórico mensal de uso. Registros comuns continuam contados offline até serem liberados. Sessões floating contam apenas com concessões válidas e são deduplicadas por hardware, usando identidade do dispositivo na falta deste. A liberação ou expiração da última sessão floating devolve capacidade; registros válidos continuam entre meses de cota. Registros isolados de teste SDK são excluídos. Para outro mês UTC: histórico distinto de uso de dispositivos registrado naquele mês.", "type": "integer" }, "api_calls": { "description": "Chamadas activate, validate, heartbeat e deactivate bem-sucedidas no mês UTC e ambiente de pagamento selecionados. Falhas, replays idempotentes válidos, verificações locais e consumo de recursos de software são excluídos. Para comparar a franquia do pacote comprado, use purchased.api_calls, que segue o mês de cota do pacote.", "type": "integer" }, "api_period": { "anyOf": [ { "$ref": "#/components/schemas/RuntimeAPIPeriod", "description": "Snapshot da franquia API padrão deste mês UTC; pode ser null quando desativada." }, { "description": "Snapshot da franquia API padrão deste mês UTC; pode ser null quando desativada.", "type": "null" } ], "description": "Franquia API padrão do mês UTC; null se indisponível. Com pacote comprado, use purchased.api_calls e purchased.included_api_calls para o mês de cota atual." }, "billable_devices": { "description": "Sem compra ativa no mês UTC atual, ocupação atual de dispositivos sob a franquia padrão. Para meses fechados ou cobertura pré-paga, pico de faturamento salvo do período padrão. As estimativas usam pelo menos o pico registrado; liberar dispositivo não reembolsa cobranças incorridas.", "type": "integer" }, "estimated_total_cents": { "description": "Cobrança mensal estimada padrão de dispositivos em centésimos da unidade monetária.", "type": "integer" }, "estimated_total_micros": { "description": "Cobrança mensal estimada padrão de dispositivos em milionésimos; não é o agregado de todos os pacotes.", "type": "integer" }, "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "type": "string" }, "operations": { "description": "Contagem de chamadas medidas bem-sucedidas agrupadas por activate, validate, heartbeat e deactivate.", "items": { "additionalProperties": false, "properties": { "count": { "description": "Quantidade no grupo atual ou registros processados por um lote.", "type": "integer" }, "operation": { "description": "Nome da operação; lotes suportam create/renew/revoke/apply_policy e solicitações offline activate/deactivate.", "type": "string" } }, "required": [], "type": "object" }, "type": "array" }, "overage_devices": { "description": "Dispositivos que excedem a franquia incluída.", "type": "integer" }, "period": { "anyOf": [ { "$ref": "#/components/schemas/Period", "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta." }, { "description": "Snapshot de faturamento mensal UTC padrão; regras de medição usam month/day/lifetime e linhas de uso usam a chave de período concreta.", "type": "null" } ], "description": "Franquia de faturamento UTC padrão/histórica fixada. Null quando não existe período e a oferta padrão está desativada; uma compra ativa continua utilizável." }, "products": { "description": "Quantidade de produtos no resumo; grupos de uso de dispositivos por produto nas respostas de uso.", "items": { "additionalProperties": false, "properties": { "active_devices": { "description": "Ocupação atual por produto no mês UTC atual; uso histórico distinto de dispositivos em mês UTC passado.", "type": "integer" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } }, "required": [], "type": "object" }, "type": "array" }, "purchased": { "anyOf": [ { "$ref": "#/components/schemas/PlanPurchase", "description": "Pacote ativo atual de mês móvel, ou null." }, { "description": "Pacote ativo atual de mês móvel, ou null.", "type": "null" } ], "description": "Pacote ativo no ambiente de pagamento atual, retornado apenas para o mês UTC atual. A cota principal de dispositivos deve usar purchased.included_devices, não period.included_devices." }, "purchased_active_devices": { "description": "Quando purchased está presente: ocupação atual de produto/dispositivo registrado, independente do histórico mensal de uso. Registros comuns continuam contados offline até serem liberados. Sessões floating contam apenas com concessões válidas e são deduplicadas por hardware, usando identidade do dispositivo na falta deste. A liberação ou expiração da última sessão floating devolve capacidade; registros válidos continuam entre meses de cota. Registros isolados de teste SDK são excluídos.", "type": "integer" }, "sandbox": { "description": "Ambiente de teste", "type": "boolean" }, "timezone": { "description": "Fuso horário da agregação de uso, UTC.", "type": "string" }, "warning": { "description": "normal, near_quota ou quota_reached para a franquia padrão de dispositivos.", "type": "string" } }, "required": [], "type": "object" }, "UsageDevice": { "additionalProperties": false, "properties": { "device_id": { "description": "Impressão digital do dispositivo no escopo do produto, geralmente 64 caracteres hex minúsculos, derivada pelo SDK.", "type": "string" }, "first_seen_at": { "description": "Data e hora da primeira atividade do dispositivo neste mês UTC.", "format": "date-time", "type": "string" }, "last_seen_at": { "description": "Data e hora da última atividade do dispositivo observada pelo servidor, UTC.", "format": "date-time", "type": "string" }, "month": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "type": "string" }, "product_id": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } }, "required": [], "type": "object" }, "UsageDeviceList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/UsageDevice" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "Verified": { "additionalProperties": false, "properties": { "verified": { "type": "boolean" } }, "required": [ "verified" ], "type": "object" }, "VersionedActivationReleaseInput": { "additionalProperties": false, "properties": { "expected_generation": { "description": "Geração do vínculo exibida na lista atual de dispositivos. Obrigatória para vínculos de contas do Launch; versões desatualizadas nunca liberam um vínculo mais recente.", "minimum": 1, "type": "integer" }, "operation_id": { "description": "UUID estável da operação para recuperação por novas tentativas. Obrigatório para vínculos de contas do Launch.", "format": "uuid", "type": "string" } }, "required": [], "type": "object" }, "WaffoCheck": { "additionalProperties": false, "properties": { "connected": { "description": "Ativado", "type": "boolean" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [ "connected", "mode" ], "type": "object" }, "WaffoOrder": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" }, "applied_at": { "anyOf": [ { "description": "Prazo UTC da janela original de criação do checkout.", "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Horário UTC em que o pagamento verificado ativou o serviço ou creditou uma recarga da carteira. purchase_id e upgrade_id null identificam uma recarga." }, "checkout_expires_at": { "description": "Prazo UTC da janela original de criação do checkout.", "format": "date-time", "type": "string" }, "created_at": { "description": "Prazo UTC da janela original de criação do checkout.", "format": "date-time", "type": "string" }, "currency": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "paid_at": { "anyOf": [ { "description": "Prazo UTC da janela original de criação do checkout.", "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Horário UTC em que o backend verificou uma transação Waffo concluída." }, "provider_order_id": { "anyOf": [ { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, { "type": "null" } ], "description": "Identificador ORD_ original recuperado de uma resposta de API verificada." }, "purchase_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Compra ou renovação de serviço existente e pendente; mutuamente exclusiva com upgrade_id." }, "refunded_cents": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" }, "request_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "status": { "description": "Ciclo de vida do pagamento, incluindo paid_unapplied quando os fundos cobrados exigem revisão e reembolso pelo operador.", "enum": [ "creating", "created", "completed", "paid_unapplied", "partially_refunded", "refunded" ], "type": "string" }, "upgrade_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Cotação de upgrade existente e pendente; mutuamente exclusiva com purchase_id." } }, "required": [ "id", "request_id", "mode", "provider_order_id", "purchase_id", "upgrade_id", "currency", "amount_cents", "refunded_cents", "status", "checkout_expires_at", "paid_at", "applied_at", "created_at" ], "type": "object" }, "WaffoOrderInput": { "additionalProperties": false, "description": "Paga uma compra/upgrade congelado ou cria uma recarga da carteira com amount e currency e sem IDs de serviço. Um request_id estável retorna o pagamento original; alterar sua intenção, valor ou moeda é rejeitado. Somente pagamentos concluídos verificados de forma independente creditam uma carteira ou ativam o serviço. Os retornos de recarga levam à carteira. As novas tentativas reutilizam a chave de idempotência original do provedor somente dentro da janela original de criação do checkout.", "oneOf": [ { "not": { "anyOf": [ { "required": [ "amount" ] }, { "required": [ "currency" ] } ] }, "properties": { "purchase_id": { "format": "uuid", "type": "string" }, "upgrade_id": { "type": "null" } }, "required": [ "purchase_id" ] }, { "not": { "anyOf": [ { "required": [ "amount" ] }, { "required": [ "currency" ] } ] }, "properties": { "purchase_id": { "type": "null" }, "upgrade_id": { "format": "uuid", "type": "string" } }, "required": [ "upgrade_id" ] }, { "properties": { "purchase_id": { "type": "null" }, "upgrade_id": { "type": "null" } }, "required": [ "amount", "currency" ] } ], "properties": { "amount": { "description": "Obrigatório somente para uma recarga da carteira. Valor decimal de exibição dentro dos limites configurados. Pedidos de serviço rejeitam valores informados pelo cliente.", "pattern": "^\\d+(?:\\.\\d{1,2})?$", "type": "string" }, "currency": { "description": "Obrigatório somente para uma recarga da carteira e deve estar ativado para este provedor.", "type": "string" }, "overage_accepted": { "description": "Autorização explícita separada para o excedente cobrável exibido.", "type": "boolean" }, "policy_version": { "description": "Versão imutável da política atualmente publicada. Obrigatória para ações protegidas por consentimento após a publicação pelo operador, em qualquer ambiente de pagamento.", "type": "string" }, "purchase_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Compra ou renovação de serviço existente e pendente; mutuamente exclusiva com upgrade_id." }, "request_id": { "description": "Chave de solicitação estável gerada pelo chamador. As repetições retornam o checkout original.", "maxLength": 80, "type": "string" }, "terms_accepted": { "description": "Aceitação explícita, desmarcada por padrão.", "type": "boolean" }, "upgrade_id": { "anyOf": [ { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" }, { "type": "null" } ], "description": "Cotação de upgrade existente e pendente; mutuamente exclusiva com purchase_id." } }, "required": [ "request_id" ], "type": "object" }, "WaffoOrderList": { "additionalProperties": false, "properties": { "items": { "description": "Itens", "items": { "$ref": "#/components/schemas/WaffoOrder" }, "type": "array" }, "total": { "description": "Preço integral de serviço fixado na menor unidade monetária; sem recarga de carteira ou pagamento misto.", "type": "integer" } }, "required": [ "items", "total" ], "type": "object" }, "WaffoOrderResult": { "additionalProperties": false, "properties": { "approval_url": { "description": "URL autenticada de checkout de curta duração ou vazia após pagamento, vencimento ou desativação do canal. Nunca a registre em logs nem a armazene em cache.", "type": "string" }, "order": { "$ref": "#/components/schemas/WaffoOrder", "description": "Pedido" }, "return_url": { "description": "URL do painel da carteira para uma recarga; URL de conciliação de preços para um pagamento de serviço. Uma URL de retorno, por si só, nunca comprova o pagamento.", "format": "uri", "type": "string" } }, "required": [ "order", "approval_url", "return_url" ], "type": "object" }, "WaffoSettings": { "additionalProperties": false, "properties": { "currencies": { "description": "Moedas", "items": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "type": "array" }, "enabled": { "description": "Ativado", "type": "boolean" }, "maximum_cents": { "description": "Recarga máxima da carteira em unidades monetárias menores; o padrão é 100000 e não pode ser inferior a minimum_cents.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "merchant_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "minimum_cents": { "description": "Recarga mínima da carteira em unidades monetárias menores; o padrão é 100.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "private_key_configured": { "description": "Ativado", "type": "boolean" }, "product_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "store_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "version": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "webhook_public_key": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "webhook_url": { "description": "URL do webhook", "format": "uri", "type": "string" } }, "required": [ "enabled", "mode", "merchant_id", "store_id", "product_id", "currencies", "private_key_configured", "webhook_public_key", "version", "webhook_url" ], "type": "object" }, "WaffoSettingsInput": { "additionalProperties": false, "properties": { "clear_private_key": { "description": "Ativado", "type": "boolean" }, "currencies": { "description": "Moedas", "items": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "type": "array" }, "enabled": { "description": "Ativado", "type": "boolean" }, "expected_version": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "maximum_cents": { "description": "Recarga máxima da carteira em unidades monetárias menores; o padrão é 100000 e não pode ser inferior a minimum_cents.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "merchant_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "minimum_cents": { "description": "Recarga mínima da carteira em unidades monetárias menores; o padrão é 100.", "maximum": 100000000, "minimum": 1, "type": "integer" }, "mode": { "description": "Ambiente de pagamento. Os registros sandbox e live são isolados.", "enum": [ "sandbox", "live" ], "type": "string" }, "private_key": { "description": "Chave privada de assinatura RSA. Criptografada em repouso; vazio preserva a chave salva.", "maxLength": 8192, "type": "string", "writeOnly": true }, "product_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "store_id": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" }, "webhook_public_key": { "description": "Substituição opcional da chave pública oficial do webhook. Vazio usa a chave do SDK do ambiente selecionado.", "maxLength": 8192, "type": "string" } }, "required": [ "enabled", "mode", "merchant_id", "store_id", "product_id", "currencies", "expected_version" ], "type": "object" }, "WaffoWebhookEvent": { "description": "Evento Waffo bruto autenticado com X-Waffo-Signature, a chave pública do ambiente selecionado, store e mode. Pagamentos/reembolsos são verificados de forma independente pela API.", "type": "object" }, "Wallet": { "additionalProperties": false, "properties": { "balance_cents": { "description": "Saldo da carteira, ou saldo após o lançamento, em centésimos.", "type": "integer" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [], "type": "object" }, "WalletEntry": { "additionalProperties": false, "properties": { "amount_cents": { "description": "Valor em centésimos; lançamentos contábeis podem ser créditos positivos ou débitos negativos.", "type": "integer" }, "balance_cents": { "description": "Saldo da carteira, ou saldo após o lançamento, em centésimos.", "type": "integer" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "currency": { "description": "Código de moeda de três letras maiúsculas, como USD.", "pattern": "^[A-Z]{3}$", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "kind": { "description": "plan_upgrade registra um upgrade pago. paypal_refund_reserve retém fundos disponíveis da carteira; paypal_refund_release remove a retenção; paypal_refund registra o reembolso em dinheiro confirmado. Movimentos de reserva/liberação não são pagamentos em dinheiro e se anulam na conclusão do acerto.", "type": "string" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "reference": { "description": "Referência comercial relacionada usada para rastreamento.", "type": "string" } }, "required": [], "type": "object" }, "WalletEntryList": { "additionalProperties": false, "properties": { "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/WalletEntry" }, "type": "array" }, "limit": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "type": "integer" }, "offset": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "type": "integer" }, "total": { "description": "Total de registros correspondentes, não o tamanho da página atual.", "type": "integer" } }, "required": [], "type": "object" }, "WalletRefundRequest": { "additionalProperties": false, "properties": { "amount_cents": { "minimum": 1, "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "customer_email": { "description": "Somente na lista do administrador.", "type": "string" }, "decision": { "type": "string" }, "id": { "format": "uuid", "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "order_id": { "format": "uuid", "type": "string" }, "reason": { "type": "string" }, "refund_id": { "format": "uuid", "type": [ "string", "null" ] }, "refund_status": { "type": "string" }, "request_id": { "format": "uuid", "type": "string" }, "review_status": { "enum": [ "pending", "approved", "declined", "cancelled" ], "type": "string" }, "reviewed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "enum": [ "pending_review", "refund_pending", "refunded", "refund_failed", "declined", "cancelled" ], "type": "string" }, "tenant_name": { "description": "Somente na lista do administrador.", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "order_id", "mode", "currency", "amount_cents", "reason", "status", "review_status" ], "type": "object" }, "WalletRefundRequestInput": { "additionalProperties": false, "properties": { "amount": { "description": "Valor positivo, limitado tanto pelo valor não reembolsado do pedido quanto pelo crédito atual não gasto da carteira.", "pattern": "^[0-9]+(?:\\.[0-9]{1,2})?$", "type": "string" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "reason": { "maxLength": 255, "minLength": 1, "type": "string" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "amount", "reason", "request_id", "mode" ], "type": "object" }, "WalletRefundRequestList": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/WalletRefundRequest" }, "type": "array" }, "limit": { "type": "integer" }, "mode": { "enum": [ "sandbox", "live" ], "type": "string" }, "offset": { "type": "integer" }, "total": { "type": "integer" } }, "required": [ "items", "total", "mode" ], "type": "object" }, "WalletRefundReview": { "additionalProperties": false, "properties": { "approve": { "type": "boolean" }, "decision": { "maxLength": 1000, "minLength": 1, "type": "string" }, "expected_updated_at": { "format": "date-time", "type": "string" } }, "required": [ "approve", "decision" ], "type": "object" }, "WalletResult": { "additionalProperties": false, "properties": { "currencies": { "description": "Códigos de moeda permitidos neste ambiente.", "items": { "pattern": "^[A-Z]{3}$", "type": "string" }, "type": "array" }, "items": { "description": "Registros retornados; consulte items[] para campos dos elementos. Algumas coleções vazias podem ser null; consulte o tipo.", "items": { "$ref": "#/components/schemas/Wallet" }, "type": "array" }, "maximum_cents": { "description": "Recarga máxima do canal de recarga de carteira habilitado, em unidades menores.", "type": "integer" }, "minimum_cents": { "description": "Recarga mínima do canal de recarga de carteira habilitado, em unidades menores.", "type": "integer" }, "mode": { "description": "Prazo da licença: perpetual, timed ou trial; objetos de faturamento usam modo de pagamento sandbox ou live.", "enum": [ "sandbox", "live" ], "type": "string" }, "payment_channels": { "description": "Configuração disponível de canais de pagamento. Mostre apenas canais habilitados compatíveis com o ambiente de faturamento ativo e a moeda da compra.", "items": { "$ref": "#/components/schemas/PaymentChannel" }, "type": "array" }, "paypal_enabled": { "description": "Se PayPal está habilitado neste ambiente de pagamento.", "type": "boolean" } }, "required": [], "type": "object" }, "WebhookAttempt": { "additionalProperties": false, "properties": { "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "delivery_id": { "description": "UUID da tarefa de entrega desta tentativa.", "format": "uuid", "type": "string" }, "duration_ms": { "description": "Duração da entrega em milissegundos.", "type": "integer" }, "error": { "description": "Objeto de erro ou categoria de falha de entrega; consulte os campos filhos ou o tipo atual.", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "number": { "description": "Número de sequência acumulado da tentativa.", "type": "integer" }, "status_code": { "description": "Status HTTP desta tentativa; pode ser 0 em caso de falha de transporte.", "type": "integer" } }, "required": [ "id", "delivery_id", "number", "status_code", "error", "duration_ms", "created_at" ], "type": "object" }, "WebhookDelivery": { "additionalProperties": false, "properties": { "attempts": { "description": "Número cumulativo de tentativas da tarefa.", "type": "integer" }, "available_at": { "description": "Primeiro horário UTC em que a tarefa pode executar.", "format": "date-time", "type": "string" }, "created_at": { "description": "Hora de criação em UTC; solicitações offline usam segundos Unix.", "format": "date-time", "type": "string" }, "delivered_at": { "anyOf": [ { "description": "Data e hora da entrega bem-sucedida ou null.", "format": "date-time", "type": "string" }, { "description": "Data e hora da entrega bem-sucedida ou null.", "type": "null" } ], "description": "Data e hora da entrega bem-sucedida ou null." }, "endpoint_id": { "description": "UUID do endpoint de webhook.", "format": "uuid", "type": "string" }, "event_id": { "description": "UUID do evento original; use-o para deduplicação no receptor.", "format": "uuid", "type": "string" }, "id": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" }, "last_error": { "description": "Categoria da falha mais recente; pode estar vazia.", "type": "string" }, "last_status": { "description": "Status da resposta HTTP mais recente; pode ser 0 se nenhuma resposta tiver chegado.", "type": "integer" }, "status": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "type": "string" } }, "required": [ "id", "endpoint_id", "event_id", "status", "attempts", "available_at", "last_status", "last_error", "delivered_at", "created_at" ], "type": "object" }, "WebhookEvent": { "description": "Evento PayPal assinado exato, verificado pela API PayPal", "type": "object" }, "WebhookReceived": { "additionalProperties": false, "properties": { "ignored": { "type": "boolean" }, "received": { "type": "boolean" } }, "required": [], "type": "object" } }, "securitySchemes": { "closureExport": { "description": "Credencial restrita de download de 15 minutos, nunca sessão do dashboard. Em produção usa __Host-licentivo_closure_export; sempre limitada ao prazo original de fechamento.", "in": "cookie", "name": "licentivo_closure_export", "type": "apiKey" }, "customerSession": { "description": "Em produção usa __Host-licenova_customer; a identidade do comprador é independente da sessão do fornecedor.", "in": "cookie", "name": "licenova_customer", "type": "apiKey" }, "managementKey": { "bearerFormat": "lv_api_...", "scheme": "bearer", "type": "http" }, "session": { "description": "Em produção usa __Host-licenova_session", "in": "cookie", "name": "licenova_session", "type": "apiKey" } } }, "info": { "description": "API de gestão e licenciamento Licentivo. Oferece autorizações de execução assinadas, licenças vinculadas a dispositivos ou flutuantes, cotas de dispositivos atualmente ativados, uso mensal da API, funcionalidades de software medidas por consumo, sessões de conta Launch, pacotes pré-pagos, presentes, renovação automática por carteira e upgrades de toda a cobertura. PayPal, Paddle e Waffo oferecem pagamentos verificados e reembolsos pelo meio original. Inclui políticas do cliente, cancelamento limitado ao escopo aprovado, suporte, compensação, exportação de dados e encerramento lógico da conta. Ambientes de pagamento e moedas são isolados; credenciais privadas são criptografadas e nunca retornadas.", "title": "API Licentivo", "version": "0.12.0", "x-document-language": "pt" }, "openapi": "3.1.0", "paths": { "/api/v1/account/closure-export.zip": { "get": { "description": "Credencial e prazo original de fechamento são verificados novamente em cada solicitação e após a geração. Restaurar backup não reinicia a janela.", "operationId": "get__api_v1_account_closure_export_zip", "parameters": [], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "closureExport": [] } ], "summary": "Baixar durante a janela de fechamento de 30 dias" } }, "/api/v1/account/closure-export/session": { "post": { "description": "Exige e-mail/senha originais verificados e fechamento confirmado ainda dentro de exatamente 30 dias. O cookie de 15 minutos é limitado ao prazo original, sujeito a limite de taxa e não pode autorizar acesso normal à API/dashboard.", "operationId": "post__api_v1_account_closure_export_session", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosureExportLogin" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ClosureExportCredential" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Verificar conta fechada para exportação restrita" } }, "/api/v1/account/data-export": { "get": { "description": "Downloads do Owner incluem CSVs comerciais do workspace. O arquivo pessoal de um membro contém seu perfil, publicações e solicitações. Segredos/hashes de credenciais e chaves privadas de assinatura são excluídos.", "operationId": "get__api_v1_account_data_export", "parameters": [], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Baixar seus dados pessoais e autorizados", "x-required-role": "session" } }, "/api/v1/account/deletions": { "get": { "description": "", "operationId": "get__api_v1_account_deletions", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AccountClosureList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler suas solicitações de fechamento lógico", "x-required-role": "session" }, "post": { "description": "Fechamento de Owner deve selecionar workspace; membro só pode fechar sua conta. A confirmação revoga sessões/chaves API, mas preserva dados. Exportação é permitida por 30 dias após a confirmação.", "operationId": "post__api_v1_account_deletions", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountClosureInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AccountClosure" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Solicitar fechamento lógico de conta ou workspace", "x-required-role": "session" } }, "/api/v1/account/deletions/{id}/cancel": { "post": { "description": "", "operationId": "post__api_v1_account_deletions__id__cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Retirar fechamento não confirmado", "x-required-role": "session" } }, "/api/v1/account/legal-acceptances": { "get": { "description": "", "operationId": "get__api_v1_account_legal_acceptances", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LegalAcceptanceList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler seus recibos de aceitação jurídica", "x-required-role": "session" } }, "/api/v1/account/profile": { "patch": { "description": "Exige a senha atual. O novo e-mail de login recebe link de verificação de uso único, válido por 30 minutos. O e-mail de login verificado atual e o acesso permanecem inalterados até a confirmação.", "operationId": "patch__api_v1_account_profile", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCorrection" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Corrigir seu nome ou solicitar alteração do e-mail de login", "x-required-role": "session" } }, "/api/v1/activate": { "post": { "description": "Autenticação por product_id + license_key + device_id, sem cookie, CSRF ou chave administrativa do fornecedor. activation_id é obrigatório, exceto em activate. Cada requisição bem-sucedida consome uma chamada de API; replay idempotente e falhas não consomem. Excedentes debitam a carteira atomicamente ou retornam API_QUOTA_EXCEEDED/API_BALANCE_INSUFFICIENT. A cota de dispositivos do espaço de trabalho acompanha as ativações atuais. A liberação devolve capacidade; expirar um lease flutuante também devolve, mas um dispositivo comum registrado continua contado quando offline. Só há cobrança de excedente de dispositivos quando o pico de faturamento do mês da cota aumenta além da capacidade já paga; liberar não reembolsa custos incorridos. O uso da API é separado.", "operationId": "post_api_v1_activate", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RuntimeResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Ativar em runtime" } }, "/api/v1/activations": { "get": { "operationId": "get_api_v1_activations", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "license_id", "schema": { "description": "UUID da licença, diferente do segredo lv_lic_.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "product_id", "schema": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "status", "schema": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "released" ], "type": "string" } }, { "in": "query", "name": "q", "schema": { "description": "Texto de busca; campos pesquisados e comprimento máximo dependem da operação.", "maxLength": 120, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "created_at": "2026-10-18T00:00:00Z", "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "device_name": "Office PC", "generation": 1, "id": "44444444-4444-4444-8444-444444444444", "last_seen_at": "2026-10-18T00:00:00Z", "license_id": "33333333-3333-4333-8333-333333333333", "product_id": "11111111-1111-4111-8111-111111111111", "released_at": null, "status": "active", "virtual_machine": false } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ActivationList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar ativações", "x-management-reference": { "group": "devices" }, "x-required-scope": "read" } }, "/api/v1/activations/{id}/release": { "post": { "operationId": "post_api_v1_activations_by_id_release", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_generation": 1, "operation_id": "11111111-1111-4111-8111-111111111111" }, "schema": { "$ref": "#/components/schemas/VersionedActivationReleaseInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "status": "released" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/StateResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Liberar ativação", "x-management-reference": { "group": "devices" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/api-keys": { "get": { "operationId": "get_api_v1_api-keys", "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "allow_http": false, "created_at": "2026-10-18T00:00:00Z", "expires_at": "2026-10-18T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "name": "Report app", "prefix": "lv_api_AAAAAAA", "revoked": false, "scope": "read" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/KeyList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Listar chaves de API", "x-management-reference": { "group": "keys" }, "x-required-role": "owner", "x-required-scope": "owner_session" }, "post": { "operationId": "post_api_v1_api-keys", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "description": "Obrigatório em escritas autenticadas por cookie; obtenha data.csrf_token de GET /api/v1/auth/csrf e conserve os cookies.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "allow_http": false, "expires_days": 90, "name": "Order system", "scope": "write" }, "schema": { "$ref": "#/components/schemas/KeyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "expires_at": "2027-01-16T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "key": "lv_api_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "prefix": "lv_api_AAAAAAA" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/KeySecret", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Criar chave de API", "x-management-reference": { "group": "keys" }, "x-required-role": "owner", "x-required-scope": "owner_session" } }, "/api/v1/api-keys/{id}": { "delete": { "operationId": "delete_api_v1_api-keys_by_id", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "description": "Obrigatório em escritas autenticadas por cookie; obtenha data.csrf_token de GET /api/v1/auth/csrf e conserve os cookies.", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Revogar chave de API", "x-management-reference": { "group": "keys" }, "x-required-role": "owner", "x-required-scope": "owner_session" }, "patch": { "description": "Exige sessão Owner e token CSRF. Atualiza apenas esta chave ativa; a rotação conserva a configuração. Não altera conexões Launch existentes nem autorizações de execução. Esta configuração não habilita HTTP na API Licentivo.", "operationId": "patch_api_v1_api-keys_by_id", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "description": "Obrigatório em escritas autenticadas por cookie; obtenha data.csrf_token de GET /api/v1/auth/csrf e conserve os cookies.", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "allow_http": true }, "schema": { "$ref": "#/components/schemas/KeyUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "allow_http": false, "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/KeyUpdated", "description": "Response data for the completed operation." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Atualizar acesso HTTP aos sites", "x-management-reference": { "group": "keys" }, "x-required-role": "owner", "x-required-scope": "owner_session" } }, "/api/v1/api-keys/{id}/rotate": { "post": { "operationId": "post_api_v1_api-keys_by_id_rotate", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "description": "Obrigatório em escritas autenticadas por cookie; obtenha data.csrf_token de GET /api/v1/auth/csrf e conserve os cookies.", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "key": "lv_api_BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB", "prefix": "lv_api_BBBBBBB" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/KeyRotated", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Rotacionar chave de API", "x-management-reference": { "group": "keys" }, "x-required-role": "owner", "x-required-scope": "owner_session" } }, "/api/v1/audit-logs": { "get": { "operationId": "get_api_v1_audit-logs", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "action": "license.create", "actor_id": "33333333-3333-4333-8333-333333333333", "actor_kind": "api_key", "created_at": "2026-10-18T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "request_id": "55555555-5555-4555-8555-555555555555", "resource_id": "" } ], "limit": 25, "offset": 0 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AuditList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar logs de auditoria", "x-management-reference": { "group": "usage" }, "x-required-scope": "read" } }, "/api/v1/auth/accept-invitation": { "post": { "operationId": "post_api_v1_auth_accept-invitation", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenPassword" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PasswordSet" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Aceitar convite" } }, "/api/v1/auth/change-password": { "post": { "operationId": "post_api_v1_auth_change-password", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePassword" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PasswordSet" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Revogar todas as credenciais da conta e definir senha" } }, "/api/v1/auth/confirm-email-change": { "post": { "description": "Verifique o desafio criptografado de uso único. Somente confirmação bem-sucedida altera e verifica o e-mail de login e revoga sessões, chaves API e links de autenticação existentes. Desafios expirados, substituídos ou invalidados pela senha não podem alterar a conta.", "operationId": "post__api_v1_auth_confirm_email_change", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailChangeConfirmation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Confirmar novo e-mail de login" } }, "/api/v1/auth/csrf": { "get": { "operationId": "get_api_v1_auth_csrf", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CSRF" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Emitir token CSRF vinculado à sessão" } }, "/api/v1/auth/forgot-password": { "post": { "operationId": "post_api_v1_auth_forgot-password", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Email" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Notice" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Esqueci a senha" } }, "/api/v1/auth/login": { "post": { "operationId": "post_api_v1_auth_login", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CSRF" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Entrar" } }, "/api/v1/auth/logout": { "post": { "operationId": "post_api_v1_auth_logout", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LoggedOut" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Revogar a sessão atual" } }, "/api/v1/auth/me": { "get": { "operationId": "get_api_v1_auth_me", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Me" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Conta atual do cookie" } }, "/api/v1/auth/register": { "post": { "description": "Em qualquer ambiente de pagamento, termos publicados exigem policy_version e aceitação explícita. Excedentes de serviço cobrados exigem também overage_accepted. Antes da primeira publicação, o consentimento com o rascunho não é registrado e cada operação mantém suas verificações normais de cadastro, preço e pagamento.", "operationId": "post_api_v1_auth_register", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Register" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Notice" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Cadastrar" } }, "/api/v1/auth/resend-verification": { "post": { "operationId": "post_api_v1_auth_resend-verification", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Email" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Notice" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Reenviar verificação" } }, "/api/v1/auth/reset-password": { "post": { "operationId": "post_api_v1_auth_reset-password", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenPassword" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PasswordSet" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Redefinir senha" } }, "/api/v1/auth/verify-email": { "post": { "operationId": "post_api_v1_auth_verify-email", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Verified" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Verificar e-mail" } }, "/api/v1/billing/auto-renewal": { "get": { "description": "Somente sessão. PATCH exige Owner do workspace. Desativado por padrão. Para ativar, é necessário saldo suficiente no modo e moeda atuais para uma renovação, além do plano pago mais recente revisado, prazo oferecido e versão de preço. No vencimento, somente fundos da carteira são cobrados, nunca PayPal ou cartão. Um worker por minuto e mutações de execução processam renovações devidas sob bloqueio do tenant. Tentativas repetidas cobram uma vez. Fundos insuficientes aguardam recarga; alterações de preço, plano ou disponibilidade suspendem cobranças até novo consentimento. Desativar cancela cobranças automáticas futuras, não a cobertura paga.", "operationId": "get_api_v1_billing_auto_renewal", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "next_renewal_at": null, "setting": { "amount_cents": 0, "currency": "USD", "enabled": true, "mode": "sandbox", "plan": "starter", "plan_name": "Starter", "policy_version": "", "price_version": "example-v1", "status": "disabled", "term_months": 1, "updated_at": "2026-10-18T00:00:00Z", "version": "" } }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AutoRenewalResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "example": { "error": { "code": "DEFAULT_PLAN_DISABLED", "message": "The default allowance plan has not been enabled by the administrator" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler configurações de renovação automática", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" }, "patch": { "description": "Somente sessão. PATCH exige Owner do workspace. Desativado por padrão. Para ativar, é necessário saldo suficiente no modo e moeda atuais para uma renovação, além do plano pago mais recente revisado, prazo oferecido e versão de preço. No vencimento, somente fundos da carteira são cobrados, nunca PayPal ou cartão. Um worker por minuto e mutações de execução processam renovações devidas sob bloqueio do tenant. Tentativas repetidas cobram uma vez. Fundos insuficientes aguardam recarga; alterações de preço, plano ou disponibilidade suspendem cobranças até novo consentimento. Desativar cancela cobranças automáticas futuras, não a cobertura paga. Termos publicados exigem policy_version e aceitação explícita em qualquer ambiente de pagamento. Excedente de serviço cobrável também exige overage_accepted. Antes da primeira publicação da política, o consentimento do rascunho não é registrado e cada operação segue suas verificações normais de registro, preços e pagamento.", "operationId": "patch_api_v1_billing_auto_renewal", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoRenewalInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AutoRenewal" }, "request_id": { "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ativar ou desativar renovação por carteira com consentimento explícito" } }, "/api/v1/billing/invoices": { "get": { "operationId": "get_api_v1_billing_invoices", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "month", "schema": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "pattern": "^[0-9]{4}-[0-9]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "active_devices": 0, "base_covered": false, "base_micros": 0, "created_at": "2026-10-18T00:00:00Z", "currency": "USD", "finalized_at": null, "id": "33333333-3333-4333-8333-333333333333", "included_devices": 0, "month": "2026-09", "overage_devices": 0, "paid_at": null, "payment_mode": "sandbox", "plan": "starter", "plan_name": "Starter", "price_version": "example-v1", "refunded_at": null, "status": "draft", "total_cents": 0, "total_micros": 0, "unit_micros": 0, "voided_at": null } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/InvoiceList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar faturas", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/billing/invoices/{id}": { "get": { "operationId": "get_api_v1_billing_invoices_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "active_devices": 0, "base_covered": false, "base_micros": 0, "created_at": "2026-10-18T00:00:00Z", "currency": "USD", "finalized_at": null, "id": "33333333-3333-4333-8333-333333333333", "included_devices": 0, "month": "2026-09", "overage_devices": 0, "paid_at": null, "payment_mode": "sandbox", "plan": "starter", "plan_name": "Starter", "price_version": "example-v1", "refunded_at": null, "status": "draft", "total_cents": 0, "total_micros": 0, "unit_micros": 0, "voided_at": null }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Invoice", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler fatura", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/billing/invoices/{id}/export.csv": { "get": { "operationId": "get_api_v1_billing_invoices_by_id_export_csv", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "invoice_id,month,currency,status,plan,price_version,active_devices,included_devices,overage_devices,base_micros,unit_micros,total_micros,total_cents\n", "schema": { "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Exportar fatura", "x-csv-columns": [ "invoice_id", "month", "currency", "status", "plan", "price_version", "active_devices", "included_devices", "overage_devices", "base_micros", "unit_micros", "total_micros", "total_cents" ], "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/billing/invoices/{id}/finalize": { "post": { "operationId": "post_api_v1_billing_invoices_by_id_finalize", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "status": "finalized" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/StateResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Finalizar fatura", "x-management-reference": { "group": "billing" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/billing/invoices/{id}/pay": { "post": { "description": "Um novo pagamento exige aceitação explícita da política atual. O replay de um pagamento já concluído preserva o recibo original.", "operationId": "post_api_v1_billing_invoices_by_id_pay", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalConsent" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Invoice" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Pagar fatura histórica confirmada com o saldo", "x-required-role": "owner" } }, "/api/v1/billing/invoices/{id}/void": { "post": { "operationId": "post_api_v1_billing_invoices_by_id_void", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "status": "void" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/StateResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Anular fatura", "x-management-reference": { "group": "billing" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/billing/jobs": { "get": { "operationId": "get_api_v1_billing_jobs", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "attempts": 0, "available_at": "2026-10-18T00:00:00Z", "created_at": "2026-10-18T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "last_error": "", "month": "2026-09", "status": "pending" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingJobList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar tarefas de faturamento", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" }, "post": { "operationId": "post_api_v1_billing_jobs", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "month": "2026-09" }, "schema": { "$ref": "#/components/schemas/MonthInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "attempts": 0, "available_at": "2026-10-18T00:00:00Z", "created_at": "2026-10-18T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "last_error": "", "month": "2026-09", "status": "pending" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingJob", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Enfileirar tarefa de faturamento", "x-management-reference": { "group": "billing" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/billing/jobs/{id}/retry": { "post": { "operationId": "post_api_v1_billing_jobs_by_id_retry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "status": "pending" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/StateResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Repetir tarefa de faturamento", "x-management-reference": { "group": "billing" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/billing/notification-preferences": { "get": { "description": "Somente sessão Owner; chaves de gerenciamento são rejeitadas. Por padrão, os quatro tipos estão habilitados e zh é usado até salvamento explícito. Preferências pertencem a este usuário e workspace. Reutiliza transporte de e-mail de autenticação, remetente, fila persistente criptografada e tentativas. Tanto a permissão da plataforma quanto o consentimento do destinatário devem permitir o tipo. A entrega verifica novamente o consentimento atual e o estado do evento. As escolhas de e-mail não concedem nem revogam consentimento para debitar a carteira. Mensagens sandbox são identificadas. Não são criadas notificações para compras pendentes não pagas ou presentes.", "operationId": "get__api_v1_billing_notification_preferences", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingNotificationPreferencesResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler consentimento de e-mail do proprietário atual", "x-required-role": "owner" }, "patch": { "description": "Atualização parcial para o proprietário da sessão; não pode visar outro usuário. Locale controla mensagens futuras. E-mails existentes de verificação e segurança permanecem independentes. Reutiliza transporte de e-mail de autenticação, remetente, fila persistente criptografada e tentativas. Tanto a permissão da plataforma quanto o consentimento do destinatário devem permitir o tipo. A entrega verifica novamente o consentimento atual e o estado do evento. As escolhas de e-mail não concedem nem revogam consentimento para debitar a carteira. Mensagens sandbox são identificadas. Não são criadas notificações para compras pendentes não pagas ou presentes.", "operationId": "patch__api_v1_billing_notification_preferences", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingNotificationPreferenceInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingNotificationPreference" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Salvar consentimento de e-mail do proprietário atual", "x-required-role": "owner" } }, "/api/v1/billing/overage-consent": { "post": { "description": "", "operationId": "post__api_v1_billing_overage_consent", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerOverageConsent" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Autorizar explicitamente o excedente atual da carteira", "x-required-role": "owner" } }, "/api/v1/billing/overage-settings": { "get": { "description": "Somente tenant atual. Membros somente leitura podem visualizar. Uma franquia API ilimitada nunca é limitada por preferência de excedente do cliente. Um plano null significa que a franquia padrão não está disponível.", "operationId": "get__api_v1_billing_overage_settings", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "customer_api_settings_enabled": false, "customer_device_settings_enabled": false, "plan": null, "preference": { "block_api_overage": false, "block_device_overage": false, "mode": "sandbox", "updated_at": "2026-10-18T00:00:00Z", "version": "" } }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OverageSettings", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "example": { "error": { "code": "DEFAULT_PLAN_DISABLED", "message": "The default allowance plan has not been enabled by the administrator" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler preferências de excedente", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" }, "patch": { "description": "Somente Owner de sessão. Cada escolha fornecida exige a permissão administrativa correspondente; um campo não autorizado rejeita toda a solicitação com 403. Limite rígido de execução = limite do administrador OR preferência de bloqueio do cliente quando essa permissão está habilitada. Não apaga uso ou cobranças anteriores. Preferências sandbox e live são independentes.", "operationId": "patch__api_v1_billing_overage_settings", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OverageSettingsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OveragePreference" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Salvar preferências independentes de excedente de dispositivos e API" } }, "/api/v1/billing/paddle/orders": { "get": { "operationId": "get__api_v1_billing_paddle_orders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleOrderList" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar pagamentos de serviços e recargas de carteira Paddle", "x-licentivo-access": "session" }, "post": { "operationId": "post__api_v1_billing_paddle_orders", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaddleOrderInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Criar ou recuperar um pagamento de serviço Paddle", "x-licentivo-access": "owner" } }, "/api/v1/billing/paddle/orders/{id}": { "get": { "operationId": "get__api_v1_billing_paddle_orders__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler transação de checkout própria e token público do cliente", "x-licentivo-access": "session" } }, "/api/v1/billing/paddle/orders/{id}/reconcile": { "post": { "operationId": "post__api_v1_billing_paddle_orders__id__reconcile", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaddleReconcileInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Verificar pagamento e atender o serviço comprado uma vez", "x-licentivo-access": "owner" } }, "/api/v1/billing/paypal/orders": { "get": { "operationId": "get_api_v1_billing_paypal_orders", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "amount_cents": 0, "approval_url": "", "capture_id": null, "created_at": "2026-10-18T00:00:00Z", "credited_at": null, "currency": "USD", "id": "33333333-3333-4333-8333-333333333333", "mode": "sandbox", "paypal_order_id": null, "purchase_id": null, "refunded_cents": 0, "request_id": "55555555-5555-4555-8555-555555555555", "status": "creating", "upgrade_id": null } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalOrderList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar pedidos de recarga", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" }, "post": { "description": "Em qualquer ambiente de pagamento, termos publicados exigem policy_version e aceitação explícita. Excedentes de serviço cobrados exigem também overage_accepted. Antes da primeira publicação, o consentimento com o rascunho não é registrado e cada operação mantém suas verificações normais de cadastro, preço e pagamento.", "operationId": "post_api_v1_billing_paypal_orders", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechargeInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalOrder" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Criar ou recuperar recarga idempotente", "x-required-role": "owner" } }, "/api/v1/billing/paypal/orders/{id}/capture": { "post": { "operationId": "post_api_v1_billing_paypal_orders_by_id_capture", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalOrder" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Confirmar fundos vinculados ao comerciante uma única vez", "x-required-role": "owner" } }, "/api/v1/billing/paypal/orders/{id}/reconcile": { "post": { "operationId": "post_api_v1_billing_paypal_orders_by_id_reconcile", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalOrder" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Confirmar fundos vinculados ao comerciante uma única vez", "x-required-role": "owner" } }, "/api/v1/billing/paypal/orders/{id}/refund-requests": { "post": { "description": "Somente sessões por cookie; chaves API de gerenciamento não são aceitas. Leituras do cliente são limitadas ao seu workspace. Gravações do cliente exigem Owner verificado do workspace, sem permissão de administrador da plataforma. Solicitações não movem nem reservam fundos. A aprovação administrativa verifica novamente a carteira atual e o valor capturado ainda não reembolsado, então usa o fluxo existente idempotente de reembolso pelo meio original e reserva. A aprovação não cancela planos.", "operationId": "post__api_v1_billing_paypal_orders__id__refund_requests", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletRefundRequestInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletRefundRequest" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" } }, "security": [ { "session": [] } ], "summary": "Solicitar reembolso do meu crédito de recarga não gasto", "x-required-role": "owner" } }, "/api/v1/billing/plans": { "get": { "operationId": "get_api_v1_billing_plans", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Catálogo público de preços mantido pelo administrador" } }, "/api/v1/billing/purchases": { "get": { "operationId": "get_api_v1_billing_purchases", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "active": null, "active_devices": 0, "coverage_ends_at": null, "items": [ { "api_calls": 0, "api_hard_limit": false, "api_overage_cents": 0, "api_unit_micros": 0, "base_cents": 0, "cancelled_at": null, "created_at": "2026-10-18T00:00:00Z", "currency": "USD", "current_cycle_index": 0, "current_upgrade_id": "", "cycle_ends_at": "2026-10-18T00:00:00Z", "cycle_starts_at": "2026-10-18T00:00:00Z", "effective_included_devices": 0, "effective_plan": "", "effective_plan_name": "", "ends_at": null, "entitlement_cents": 0, "gift_batch_id": "", "gift_follows_current": false, "hard_limit": false, "id": "33333333-3333-4333-8333-333333333333", "included_api_calls": null, "included_devices": 0, "mode": "sandbox", "overage_cents": 0, "plan": "starter", "plan_name": "Starter", "price_version": "example-v1", "refunded_cents": 0, "renewal": false, "renewal_of": "", "request_id": "55555555-5555-4555-8555-555555555555", "service_credit_basis_cents": 0, "service_credit_basis_seconds": 0, "source": "purchase", "starts_at": null, "status": "pending", "term_months": 1, "total_api_calls": 0, "total_api_overage_cents": 0, "total_device_overage_cents": 0, "unit_micros": 0 } ], "mode": "sandbox", "renewal_package": null, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PurchaseList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar compras de pacotes", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" }, "post": { "description": "Cria uma compra com o plano, moeda, revisão de preço e prazo escolhidos. Tenta liquidar imediatamente pela carteira; saldo insuficiente retorna pending sem iniciar cobertura. Use renewal=true para renovar um pacote ativo. O pagamento bem-sucedido agenda o serviço após a cobertura existente; GET /billing/purchases informa coverage_ends_at. Uso atual da cota e expiração de licenças de software não mudam. Repetições reutilizam request_id e não cobram em duplicidade. Em qualquer ambiente de pagamento, termos publicados exigem policy_version e aceitação explícita. Excedentes de serviço cobrados exigem também overage_accepted. Antes da primeira publicação, o consentimento com o rascunho não é registrado e cada operação mantém suas verificações normais de cadastro, preço e pagamento.", "operationId": "post_api_v1_billing_purchases", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BuyPlan" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanPurchase" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Comprar pacote ou pagar renovação antecipada", "x-required-role": "owner" } }, "/api/v1/billing/refund-requests": { "get": { "description": "Somente sessões por cookie; chaves API de gerenciamento não são aceitas. Leituras do cliente são limitadas ao seu workspace. Gravações do cliente exigem Owner verificado do workspace, sem permissão de administrador da plataforma. Solicitações não movem nem reservam fundos. A aprovação administrativa verifica novamente a carteira atual e o valor capturado ainda não reembolsado, então usa o fluxo existente idempotente de reembolso pelo meio original e reserva. A aprovação não cancela planos.", "operationId": "get__api_v1_billing_refund_requests", "parameters": [ { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletRefundRequestList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" } }, "security": [ { "session": [] } ], "summary": "Listar solicitações de reembolso do meu workspace" } }, "/api/v1/billing/refund-requests/{id}/cancel": { "post": { "description": "Somente sessões por cookie; chaves API de gerenciamento não são aceitas. Leituras do cliente são limitadas ao seu workspace. Gravações do cliente exigem Owner verificado do workspace, sem permissão de administrador da plataforma. Solicitações não movem nem reservam fundos. A aprovação administrativa verifica novamente a carteira atual e o valor capturado ainda não reembolsado, então usa o fluxo existente idempotente de reembolso pelo meio original e reserva. A aprovação não cancela planos.", "operationId": "post__api_v1_billing_refund_requests__id__cancel", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletRefundRequest" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" } }, "security": [ { "session": [] } ], "summary": "Retirar minha solicitação de reembolso pendente", "x-required-role": "owner" } }, "/api/v1/billing/renewal-plans": { "get": { "description": "Somente titularidade de compra concluída e upgrade aplicado. Retorna ofertas publicadas habilitadas e ofertas ocultas apenas de renovação para seus clientes existentes. Cotações pendentes não estabelecem titularidade. Renove usando POST /billing/purchases antecipadamente ou após a expiração.", "operationId": "get__api_v1_billing_renewal_plans", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "api_hard_limit": false, "api_unit_micros": 0, "base_micros": 0, "currency": "USD", "description": "Desktop reporting software", "enabled": true, "hard_limit": false, "included_api_calls": null, "included_devices": 0, "name": "Report app", "plan": "starter", "price_version": "example-v1", "public": false, "renewal_only": false, "sort_order": 0, "terms": [], "unit_micros": 0, "updated_at": "2026-10-18T00:00:00Z" } ], "mode": "sandbox" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RenewalPlans", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "example": { "error": { "code": "DEFAULT_PLAN_DISABLED", "message": "The default allowance plan has not been enabled by the administrator" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar ofertas de renovação", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/billing/subscription": { "get": { "operationId": "get_api_v1_billing_subscription", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "current": { "base_covered": false, "base_micros": 0, "created_at": "2026-10-18T00:00:00Z", "currency": "USD", "hard_limit": false, "included_devices": 0, "month": "2026-09", "payment_mode": "sandbox", "plan": "starter", "plan_name": "Starter", "price_version": "example-v1", "unit_micros": 0 }, "next": null, "sandbox": false }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Subscription", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "503": { "content": { "application/json": { "example": { "error": { "code": "DEFAULT_PLAN_DISABLED", "message": "The default allowance plan has not been enabled by the administrator" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Franquia padrão desativada (DEFAULT_PLAN_DISABLED)" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler assinatura mensal", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" }, "patch": { "operationId": "patch_api_v1_billing_subscription", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "currency": "USD", "plan": "starter", "price_version": "example-v1" }, "schema": { "$ref": "#/components/schemas/PlanChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "currency": "USD", "effective_month": "2026-11", "plan": "starter", "sandbox": false }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ScheduledPlan", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Agendar plano mensal", "x-management-reference": { "group": "billing" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/billing/upgrades": { "get": { "description": "", "operationId": "get__api_v1_billing_upgrades", "parameters": [ { "in": "query", "name": "limit", "schema": { "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "amount_cents": 0, "api_hard_limit": false, "api_unit_micros": 0, "applied_at": null, "base_cents": 0, "created_at": "2026-10-18T00:00:00Z", "currency": "USD", "cycle_seconds": 0, "ends_at": "2026-10-18T00:00:00Z", "expires_at": "2026-10-18T00:00:00Z", "hard_limit": false, "id": "33333333-3333-4333-8333-333333333333", "included_api_calls": null, "included_devices": 0, "mode": "sandbox", "parent_id": "33333333-3333-4333-8333-333333333333", "parts": [], "plan": "starter", "plan_name": "Starter", "previous_base_cents": 0, "previous_plan_name": "", "previous_upgrade_id": "", "price_version": "example-v1", "purchase_id": "33333333-3333-4333-8333-333333333333", "remaining_seconds": 0, "request_id": "55555555-5555-4555-8555-555555555555", "status": "pending", "unit_micros": 0 } ], "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/UpgradeList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "example": { "error": { "code": "DEFAULT_PLAN_DISABLED", "message": "The default allowance plan has not been enabled by the administrator" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar upgrades de pacotes", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/billing/upgrades/quote": { "post": { "description": "Exige Owner de sessão. O destino deve usar a mesma moeda, sem preço mensal ou franquia de dispositivos/API menor. Mantém expiração e uso originais. O upgrade sempre inclui toda a cobertura pré-paga/presenteada atual e futura. Cada período credita seu valor original de benefício proporcional aos segundos restantes; um período não iniciado usa toda a duração. Valor de presente não é dinheiro reembolsável. O pagamento é uma única cobrança atômica da carteira; datas e cota consumida permanecem. Renovações, presentes ou cancelamentos entre cotação e pagamento invalidam a cotação com UPGRADE_STATE_CONFLICT; recarga PayPal vinculada tardia permanece como crédito da carteira. Cobertura alterada exige nova cotação.", "operationId": "post__api_v1_billing_upgrades_quote", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeQuoteInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanUpgrade" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Visualizar upgrade proporcional de plano sem debitar a carteira" } }, "/api/v1/billing/upgrades/{id}/pay": { "post": { "description": "Retorna pending sem alterar o plano quando o saldo é insuficiente. Retorna applied após cobrar uma vez. Plano ativo alterado ou cotação expirada retorna 409. O upgrade sempre inclui toda a cobertura pré-paga/presenteada atual e futura. Cada período credita seu valor original de benefício proporcional aos segundos restantes; um período não iniciado usa toda a duração. Valor de presente não é dinheiro reembolsável. O pagamento é uma única cobrança atômica da carteira; datas e cota consumida permanecem. Renovações, presentes ou cancelamentos entre cotação e pagamento invalidam a cotação com UPGRADE_STATE_CONFLICT; recarga PayPal vinculada tardia permanece como crédito da carteira. Cobertura alterada exige nova cotação. Aceitação explícita da política atual é necessária antes de novo pagamento. Um replay já pago preserva o recibo original.", "operationId": "post__api_v1_billing_upgrades__id__pay", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalConsent" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanUpgrade" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Confirmar e pagar uma cotação válida de upgrade uma vez" } }, "/api/v1/billing/waffo/orders": { "get": { "operationId": "get__api_v1_billing_waffo_orders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoOrderList" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar pagamentos de serviços e recargas de carteira Waffo", "x-licentivo-access": "session" }, "post": { "operationId": "post__api_v1_billing_waffo_orders", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaffoOrderInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Criar ou recuperar um pagamento de serviço Waffo", "x-licentivo-access": "owner" } }, "/api/v1/billing/waffo/orders/{id}": { "get": { "operationId": "get__api_v1_billing_waffo_orders__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler checkout Waffo do próprio workspace", "x-licentivo-access": "session" } }, "/api/v1/billing/waffo/orders/{id}/reconcile": { "post": { "operationId": "post__api_v1_billing_waffo_orders__id__reconcile", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Verificar pagamento e reconciliar serviço e reembolsos", "x-licentivo-access": "owner" } }, "/api/v1/billing/wallet": { "get": { "operationId": "get_api_v1_billing_wallet", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "currencies": [], "items": [ { "balance_cents": 0, "currency": "USD", "mode": "sandbox" } ], "maximum_cents": 0, "minimum_cents": 0, "mode": "sandbox", "payment_channels": [], "paypal_enabled": false }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler saldos da carteira", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/billing/wallet/entries": { "get": { "operationId": "get_api_v1_billing_wallet_entries", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "amount_cents": 0, "balance_cents": 0, "created_at": "2026-10-18T00:00:00Z", "currency": "USD", "id": "33333333-3333-4333-8333-333333333333", "kind": "", "mode": "sandbox", "reference": "" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletEntryList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar lançamentos da carteira", "x-management-reference": { "group": "billing" }, "x-required-scope": "read" } }, "/api/v1/consume": { "post": { "description": "Operação de runtime autenticada por licença, sem cookie do fornecedor ou API Key. O consumo de funcionalidades exige Idempotency-Key estável; consume não debita a API da plataforma.", "operationId": "post_api_v1_consume", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ConsumptionResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "/consume" } }, "/api/v1/consume/cancel": { "post": { "description": "Reserve antes da ação de negócio, confirme somente após sucesso e cancele em caso de falha. Conserve o identificador da tarefa e o corpo nas tentativas. Um timeout de commit é incerto: repita commit; nunca cancele nem repita trabalho concluído. Reservas encerradas retornam seu estado atual; não há débito da API da plataforma. A conclusão emite license.consume; retenções provisórias não emitem eventos de consumo.", "operationId": "post_api_v1_consume_cancel", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ReservationResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Unidades de funcionalidade: cancelar" } }, "/api/v1/consume/commit": { "post": { "description": "Reserve antes da ação de negócio, confirme somente após sucesso e cancele em caso de falha. Conserve o identificador da tarefa e o corpo nas tentativas. Um timeout de commit é incerto: repita commit; nunca cancele nem repita trabalho concluído. Reservas encerradas retornam seu estado atual; não há débito da API da plataforma. A conclusão emite license.consume; retenções provisórias não emitem eventos de consumo.", "operationId": "post_api_v1_consume_commit", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ReservationResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Unidades de funcionalidade: confirmar" } }, "/api/v1/consume/reserve": { "post": { "description": "Reserve antes da ação de negócio, confirme somente após sucesso e cancele em caso de falha. Conserve o identificador da tarefa e o corpo nas tentativas. Um timeout de commit é incerto: repita commit; nunca cancele nem repita trabalho concluído. Reservas encerradas retornam seu estado atual; não há débito da API da plataforma. A conclusão emite license.consume; retenções provisórias não emitem eventos de consumo.", "operationId": "post_api_v1_consume_reserve", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ReservationResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Unidades de funcionalidade: reservar" } }, "/api/v1/customer/activations/{id}/release": { "post": { "operationId": "post_api_v1_customer_activations_by_id_release", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerReleaseInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CustomerReleaseResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "customerSession": [] } ], "summary": "/customer/activations/{id}/release" } }, "/api/v1/customer/cases": { "get": { "description": "", "operationId": "get__api_v1_customer_cases", "parameters": [ { "description": "Exclua um tipo de solicitação antes da contagem e paginação. Use refund para excluir casos de reembolso da lista de suporte; o acesso permanece limitado à sessão atual.", "in": "query", "name": "exclude_kind", "schema": { "maxLength": 24, "type": "string" } }, { "description": "Limitar casos de reembolso a recargas de carteira ou cancelamento de serviço.", "in": "query", "name": "refund_scope", "required": false, "schema": { "enum": [ "wallet", "service" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar solicitações de clientes", "x-required-role": "session" }, "post": { "description": "request_id estável tem escopo do workspace; conteúdo alterado não pode reutilizá-lo.", "operationId": "post__api_v1_customer_cases", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportCaseInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCase" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Criar solicitação de suporte, privacidade ou apelação", "x-required-role": "session" } }, "/api/v1/customer/cases/unread": { "get": { "description": "Conversas de reembolso são excluídas. Clientes veem apenas tickets autorizados do workspace; membros veem os próprios. Cada administrador tem marcador de leitura independente.", "operationId": "get__api_v1_customer_cases_unread", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportUnread" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler contagens de tickets e avisos pessoais não lidos", "x-required-role": "session" } }, "/api/v1/customer/cases/{id}": { "get": { "description": "", "operationId": "get__api_v1_customer_cases__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler solicitação e respostas", "x-required-role": "session" } }, "/api/v1/customer/cases/{id}/messages": { "post": { "description": "Casos de reembolso rejeitam respostas com REFUND_REVIEW_WORKFLOW; administradores aprovam ou recusam diretamente. Tickets comuns mantêm respostas. Fechamentos revisados mantêm o estado de seu fluxo de privacidade.", "operationId": "post__api_v1_customer_cases__id__messages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportReply" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Responder a um ticket de suporte", "x-required-role": "session" } }, "/api/v1/customer/cases/{id}/read": { "post": { "description": "Somente mensagens até a última exibida são marcadas como lidas. Novas chegadas continuam não lidas e confirmações atrasadas não podem retroceder o marcador.", "operationId": "post__api_v1_customer_cases__id__read", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportReadInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Confirmar mensagens de ticket exibidas", "x-required-role": "session" } }, "/api/v1/customer/compensations": { "get": { "description": "", "operationId": "get__api_v1_customer_compensations", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "created_at": "2026-10-18T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333", "incident_id": "33333333-3333-4333-8333-333333333333", "intervals": "", "mode": "timed", "purchase_id": "33333333-3333-4333-8333-333333333333", "seconds": 0 } ] }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ServiceCompensationList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar compensações de serviço", "x-management-reference": { "group": "service" }, "x-required-role": "session", "x-required-scope": "read" } }, "/api/v1/customer/licenses": { "get": { "operationId": "get_api_v1_customer_licenses", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CustomerLicenses" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "customerSession": [] } ], "summary": "Licenças vinculadas ao comprador" } }, "/api/v1/customer/login": { "post": { "operationId": "post_api_v1_customer_login", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Email" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Notice" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "/customer/login" } }, "/api/v1/customer/logout": { "post": { "operationId": "post_api_v1_customer_logout", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LoggedOut" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "customerSession": [] } ], "summary": "/customer/logout" } }, "/api/v1/customer/notices": { "get": { "description": "", "operationId": "get__api_v1_customer_notices", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "body": "", "created_at": "2026-10-18T00:00:00Z", "effective_at": null, "emailed_at": null, "id": "33333333-3333-4333-8333-333333333333", "kind": "", "read_at": null, "reference": "", "title": "" } ] }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceNoticeList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar avisos de serviço", "x-management-reference": { "group": "service" }, "x-required-role": "session", "x-required-scope": "read" } }, "/api/v1/customer/notices/{id}/read": { "post": { "description": "", "operationId": "post__api_v1_customer_notices__id__read", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Marcar seu aviso como lido", "x-required-role": "session" } }, "/api/v1/customer/offline/respond": { "post": { "operationId": "post_api_v1_customer_offline_respond", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfflineRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OfflineResponse" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "customerSession": [] } ], "summary": "/customer/offline/respond" } }, "/api/v1/customer/refunds": { "post": { "description": "Escopo explícito exige confirmação e quote_hash e quoted_at retornados. O serviço permanece ativo até aprovação administrativa. Estado alterado ou cotações expiradas exigem nova prévia; pedidos pendentes conflitantes são rejeitados. Solicitações sem escopo permitem cancelamento imediato elegível após confirmação explícita. Um order_id também pode selecionar pagamento Waffo/Paddle paid_unapplied com reason=failed_delivery; não congela crédito de carteira que nunca foi concedido.", "operationId": "post__api_v1_customer_refunds", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRefundInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCase" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Enviar pedido de reembolso para análise direta", "x-required-role": "owner" } }, "/api/v1/customer/refunds/quote": { "post": { "description": "Escopo explícito de compra/serviço retorna hash de snapshot limitado, compras afetadas, estimativas de reembolso por moeda e datas restantes. O envio não encerra o serviço. Presentes não têm valor em dinheiro; upgrades pagos continuam reembolsáveis sob revisão.", "operationId": "post__api_v1_customer_refunds_quote", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRefundQuoteInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CustomerRefundQuote" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Visualizar escopo de cancelamento, reembolsos e serviço restante", "x-required-role": "owner" } }, "/api/v1/customer/refunds/{id}/cancel": { "post": { "operationId": "post__api_v1_customer_refunds__id__cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelCustomerRefund" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" } }, "security": [ { "session": [] } ], "summary": "Retirar minha solicitação de reembolso restante ainda não analisada", "x-required-role": "owner" } }, "/api/v1/customer/verify": { "post": { "operationId": "post_api_v1_customer_verify", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CustomerSession" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "/customer/verify" } }, "/api/v1/deactivate": { "post": { "description": "Autenticação por product_id + license_key + device_id, sem cookie, CSRF ou chave administrativa do fornecedor. activation_id é obrigatório, exceto em activate. Cada requisição bem-sucedida consome uma chamada de API; replay idempotente e falhas não consomem. Excedentes debitam a carteira atomicamente ou retornam API_QUOTA_EXCEEDED/API_BALANCE_INSUFFICIENT. A cota de dispositivos do espaço de trabalho acompanha as ativações atuais. A liberação devolve capacidade; expirar um lease flutuante também devolve, mas um dispositivo comum registrado continua contado quando offline. Só há cobrança de excedente de dispositivos quando o pico de faturamento do mês da cota aumenta além da capacidade já paga; liberar não reembolsa custos incorridos. O uso da API é separado.", "operationId": "post_api_v1_deactivate", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RuntimeResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Desativar em runtime" } }, "/api/v1/demo/trial": { "post": { "operationId": "post_api_v1_demo_trial", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Trial" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Criar uma avaliação SDK isolada de sete dias por proprietário", "x-required-role": "owner" } }, "/api/v1/examples/sdk": { "get": { "operationId": "get_api_v1_examples_sdk", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SDKExampleInfo" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Disponibilidade do exemplo público do SDK" } }, "/api/v1/examples/sdk/download/{name}": { "get": { "operationId": "get_api_v1_examples_sdk_download_{name}", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "description": "Linguagem seguida de .zip, por exemplo csharp.zip", "type": "string" } } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Baixar fontes com as configurações públicas do produto já no código" } }, "/api/v1/examples/sdk/trial": { "post": { "description": "Exige CSRF do navegador e cookie HttpOnly do visitante. Cada visitante recebe uma licença separada; os três dias começam na primeira ativação. Repetir a solicitação nunca estende a expiração. Libera export, não pro.", "operationId": "post_api_v1_examples_sdk_trial", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SDKExampleTrial" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Obter ou recuperar a avaliação independente de três dias deste visitante" } }, "/api/v1/forum/images": { "post": { "operationId": "post__api_v1_forum_images", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "image": { "description": "PNG, JPEG ou GIF; no máximo 5 MB, 4096 × 4096 e 16 milhões de pixels. GIF é armazenado como PNG estático. Privado até ser anexado a uma publicação.", "format": "binary", "type": "string" } }, "required": [ "image" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ForumImage" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Enviar uma imagem privada de rascunho", "tags": [ "Community" ] } }, "/api/v1/forum/replies/{id}": { "delete": { "operationId": "delete__api_v1_forum_replies__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Excluir uma resposta (autor ou administrador da plataforma)", "tags": [ "Community" ] }, "patch": { "operationId": "patch__api_v1_forum_replies__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForumReplyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Editar sua própria resposta", "tags": [ "Community" ] } }, "/api/v1/forum/topics": { "get": { "operationId": "get__api_v1_forum_topics", "parameters": [ { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "q", "schema": { "type": "string" } }, { "in": "query", "name": "category", "schema": { "type": "string" } }, { "in": "query", "name": "language", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ForumTopicList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [], "summary": "Listar discussões públicas, fixadas primeiro", "tags": [ "Community" ] }, "post": { "operationId": "post__api_v1_forum_topics", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForumTopicInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Criar discussão; disponível a qualquer membro verificado do tenant", "tags": [ "Community" ] } }, "/api/v1/forum/topics/{id}": { "delete": { "operationId": "delete__api_v1_forum_topics__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Excluir uma discussão (autor ou administrador da plataforma)", "tags": [ "Community" ] }, "get": { "operationId": "get__api_v1_forum_topics__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ForumTopicDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [], "summary": "Ler discussão pública e respostas", "tags": [ "Community" ] }, "patch": { "operationId": "patch__api_v1_forum_topics__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForumTopicInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Editar sua própria discussão", "tags": [ "Community" ] } }, "/api/v1/forum/topics/{id}/moderation": { "post": { "operationId": "post__api_v1_forum_topics__id__moderation", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForumModerationInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Fixar, desafixar, ocultar ou bloquear discussões (administrador da plataforma)", "tags": [ "Community" ] } }, "/api/v1/forum/topics/{id}/replies": { "post": { "operationId": "post__api_v1_forum_topics__id__replies", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForumReplyInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "type": "string" } }, "required": [ "id" ], "type": "object" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Código de erro e ID da requisição; sem expor dados da conta" } }, "security": [ { "session": [] } ], "summary": "Responder a uma discussão", "tags": [ "Community" ] } }, "/api/v1/forum/topics/{id}/translate": { "post": { "description": "Visitantes anônimos podem usar este endpoint com token CSRF. Aceita apenas texto de fórum publicado e armazenado, nunca texto arbitrário enviado. Traduções são armazenadas em cache por conteúdo e idioma de destino. Tópicos/respostas ocultos retornam 404; tradução concorrente pode retornar TRANSLATION_PENDING. Originais são preservados.", "operationId": "post__api_v1_forum_topics__id__translate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForumTranslationInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ForumTranslationResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [], "summary": "Traduzir um tópico ou resposta publicados" } }, "/api/v1/forum/translation": { "get": { "description": "", "operationId": "get__api_v1_forum_translation", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TranslationOptions" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [], "summary": "Obter idiomas de destino de tradução disponíveis publicamente" } }, "/api/v1/heartbeat": { "post": { "description": "Autenticação por product_id + license_key + device_id, sem cookie, CSRF ou chave administrativa do fornecedor. activation_id é obrigatório, exceto em activate. Cada requisição bem-sucedida consome uma chamada de API; replay idempotente e falhas não consomem. Excedentes debitam a carteira atomicamente ou retornam API_QUOTA_EXCEEDED/API_BALANCE_INSUFFICIENT. Recibos de repetição de validação e heartbeat expiram após 3600 segundos. Enquanto a autorização original permanecer válida, requisições correspondentes nessa janela recuperam o resultado sem novo débito. Após a janela, use nova chave; uma chave antiga já usada pode ser tratada como nova requisição. Recibos de ativação, desativação e consumo de funcionalidades permanecem duráveis. A cota de dispositivos acompanha as ativações atuais. Liberar devolve capacidade; expirar um lease flutuante também devolve, mas um registro comum offline continua contado. Só há cobrança de excedente de dispositivos quando o pico do mês da cota cresce além da capacidade já paga; liberar não reembolsa custos incorridos. O uso da API é separado.", "operationId": "post_api_v1_heartbeat", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RuntimeResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Heartbeat em runtime" } }, "/api/v1/launch/connections": { "get": { "description": "Listar conexões de confiança Launch. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_get__api_v1_launch_connections", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": {}, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "Resultado desta operação.", "properties": { "items": { "description": "Registros correspondentes no escopo solicitado.", "items": { "$ref": "#/components/schemas/LaunchConnection" }, "type": "array" } }, "required": [], "type": "object" }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Listar conexões de confiança Launch", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-scope": "read" }, "post": { "description": "Registrar um emissor Launch e ambiente comercial. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_post__api_v1_launch_connections", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "audience": "licentivo:launch", "enabled": true, "environment": "live", "issuer": "https://shop.example.test", "public_keys": { "launch-1": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "schema": { "$ref": "#/components/schemas/LaunchConnectionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "audience": "licentivo:launch", "enabled": true, "environment": "live", "id": "11111111-1111-4111-8111-111111111111", "issuer": "https://shop.example.test" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LaunchConnection", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Registrar um emissor Launch e ambiente comercial", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}": { "put": { "description": "Emissor, audience e ambiente são imutáveis. Forneça o conjunto completo de chaves públicas confiáveis.", "operationId": "launch_put__api_v1_launch_connections_id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "audience": "licentivo:launch", "enabled": true, "environment": "live", "issuer": "https://shop.example.test", "public_keys": { "launch-1": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "schema": { "$ref": "#/components/schemas/LaunchConnectionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "audience": "licentivo:launch", "enabled": true, "environment": "live", "id": "11111111-1111-4111-8111-111111111111", "issuer": "https://shop.example.test" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LaunchConnection", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Rotacionar chaves Launch ou atualizar limites de execução", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}/devices/{activation}/release": { "post": { "description": "Licentivo reserva a franquia de liberações próprias de 30 dias, registra a operação e gerencia tentativas e revisão manual. O worker compara a versão da vinculação e revoga sessões e credenciais sob os mesmos bloqueios transacionais. Sessões de login Launch antigas não podem trocar outra asserção de identidade no dispositivo revogado.", "operationId": "launch_post__api_v1_launch_connections_id_devices_activation_release", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, { "in": "path", "name": "activation", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "account_ref": "account_ref_example", "entitlement_ref": "entitlement_ref_example", "environment": "live", "expected_generation": 1, "operation_id": "11111111-1111-4111-8111-111111111111" }, "schema": { "$ref": "#/components/schemas/LaunchDeviceReleaseInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "activation_id": "11111111-1111-4111-8111-111111111111", "expected_generation": 1, "license_id": "11111111-1111-4111-8111-111111111111", "operation_id": "11111111-1111-4111-8111-111111111111", "source": "logout", "status": "pending" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/DeviceReleaseOperation", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Solicitar liberação remota versionada de dispositivo da conta", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}/entitlements/{entitlement}/devices": { "get": { "description": "Ler dispositivos da conta, franquia oficial de liberações e operações. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_get__api_v1_launch_connections_id_entitlements_entitlement_devices", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, { "in": "path", "name": "entitlement", "required": true, "schema": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" } }, { "in": "query", "name": "account_ref", "required": true, "schema": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" } }, { "in": "query", "name": "environment", "required": true, "schema": { "description": "Ambiente comercial, fixado na conexão e no grant assinado.", "enum": [ "live", "sandbox" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": {}, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "Resultado desta operação.", "properties": { "can_release": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" }, "items": { "description": "Registros correspondentes no escopo solicitado.", "items": { "additionalProperties": false, "properties": { "device_name": { "description": "Rótulo de dispositivo legível por pessoas.", "type": "string" }, "generation": { "description": "Geração atual da vinculação de dispositivo.", "type": "integer" }, "id": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" }, "last_seen_at": { "description": "Hora de criação do registro em UTC.", "format": "date-time", "type": "string" }, "status": { "description": "Estado atual de ciclo de vida ou processamento controlado pelo servidor.", "type": "string" } }, "required": [], "type": "object" }, "type": "array" }, "operations": { "description": "Histórico de operações de liberação de dispositivo controlado pelo servidor.", "items": { "$ref": "#/components/schemas/DeviceReleaseOperation" }, "type": "array" }, "remaining": { "description": "Liberações de autoatendimento restantes nos últimos 30 dias, calculadas pelo Licentivo.", "type": "integer" } }, "required": [], "type": "object" }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Ler dispositivos da conta, franquia oficial de liberações e operações", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-scope": "read" } }, "/api/v1/launch/connections/{id}/events": { "post": { "description": "Persista antes da confirmação. IDs duplicados com corpos diferentes conflitam. Workers aplicam validade absoluta e versões agregadas monotonicamente crescentes em transações, ignoram versões antigas e repetem falhas até 12 tentativas antes de revisão manual. Para entitlement existente, reembolsos, suspensão e expiração revogam acesso independentemente de mapeamentos de plano, versões de política, modos de validade e ocupação de dispositivos, mantendo verificações de titularidade e versão. Downgrades aplicam juntos novos recursos, regras de medição e limite efetivo de dispositivos, mantêm as vinculações mais antigas e revogam sessões e credenciais dos dispositivos excedentes sem consumir a franquia de liberação própria. Renovações, alterações de plano e salvamentos de política preservam limites manuais independentes de recursos e dispositivos. Snapshots explícitos entitlement.downgraded mantêm estado comercial ativo, mas bloqueiam direitos antigos de forma durável se a aplicação falhar. Snapshots ativos existentes com reduções comprováveis recebem a mesma proteção. Somente snapshot aplicado na versão da restrição pendente ou superior remove a barreira. Tentativas idempotentes em execução preservam a deduplicação da operação enquanto atualizam prazos de autorização e compra alterados. Consulte o evento antes de declarar a autorização pronta.", "operationId": "launch_post__api_v1_launch_connections_id_events", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "account_ref": "account_ref_example", "entitlement_ref": "entitlement_ref_example", "environment": "live", "event_id": "11111111-1111-4111-8111-111111111111", "launch_product_id": "11111111-1111-4111-8111-111111111111", "plan_ref": "plan_ref_example", "type": "entitlement.created", "valid_from": "2026-10-24T00:00:00Z", "version": 1 }, "schema": { "$ref": "#/components/schemas/LaunchCommerceEvent" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "example": { "data": { "attempts": 1, "available_at": "2026-10-24T00:00:00Z", "connection_id": "11111111-1111-4111-8111-111111111111", "event_id": "11111111-1111-4111-8111-111111111111", "status": "pending" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LaunchEvent", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Receber snapshot comercial Launch completo", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}/events/{event}": { "get": { "description": "Ler resultado de evento comercial Launch. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_get__api_v1_launch_connections_id_events_event_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, { "in": "path", "name": "event", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "attempts": 1, "available_at": "2026-10-24T00:00:00Z", "connection_id": "11111111-1111-4111-8111-111111111111", "event_id": "11111111-1111-4111-8111-111111111111", "status": "pending" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LaunchEvent", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Ler resultado de evento comercial Launch", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-scope": "read" } }, "/api/v1/launch/connections/{id}/events/{event}/retry": { "post": { "description": "Tentar novamente evento Launch não aplicado. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_post__api_v1_launch_connections_id_events_event_retry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, { "in": "path", "name": "event", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "additionalProperties": false, "properties": {}, "required": [], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": {}, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "Resultado desta operação.", "properties": { "queued": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" } }, "required": [], "type": "object" }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Tentar novamente evento Launch não aplicado", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}/plans/{plan}": { "put": { "description": "Mapear versão de plano Launch para política de licenciamento. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_put__api_v1_launch_connections_id_plans_plan_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, { "in": "path", "name": "plan", "required": true, "schema": { "description": "Referência imutável de entitlement de compra sensível a maiúsculas.", "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "launch_product_id": "11111111-1111-4111-8111-111111111111", "policy_id": "11111111-1111-4111-8111-111111111111", "policy_version": 1, "product_id": "11111111-1111-4111-8111-111111111111" }, "schema": { "$ref": "#/components/schemas/LaunchPlanMappingInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": {}, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "Resultado desta operação.", "properties": { "saved": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" } }, "required": [], "type": "object" }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Mapear versão de plano Launch para política de licenciamento", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}/session-revocations": { "post": { "description": "Revogação síncrona e atômica: HTTP 200 significa que sessões, credenciais, vinculações de dispositivos correspondentes e recibo durável foram confirmados. A conexão determina o ambiente; environment opcional não vazio deve corresponder. Omissão e valor explícito correspondente são equivalentes para idempotência. Reutilize event_id e o mesmo corpo normalizado nas tentativas, inclusive concorrentes; corpos diferentes conflitam. Replays bem-sucedidos retornam as contagens originais e não revogam logins mais novos. Contas/sid desconhecidos são bem-sucedidos com zero linhas afetadas e mantêm marcador de rejeição de login. O escopo de conta registra corte de autenticação no horário de aceitação do servidor. Validade do entitlement comprado e termos da licença são preservados. Conexões desativadas aceitam revogações.", "operationId": "launch_post__api_v1_launch_connections_id_session_revocations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "account_ref": "account_456", "event_id": "11111111-1111-4111-8111-111111111111", "reason": "forced_logout", "scope": "session", "sid": "login_123" }, "schema": { "$ref": "#/components/schemas/LaunchSessionRevocationInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "account_ref": "account_456", "completed_at": "2026-10-24T05:00:00.145678Z", "connection_id": "11111111-1111-4111-8111-111111111111", "created_at": "2026-10-24T05:00:00.123456Z", "environment": "live", "event_id": "11111111-1111-4111-8111-111111111111", "reason": "forced_logout", "released_devices": 2, "revoked_credentials": 2, "revoked_sessions": 2, "scope": "session", "sid": "login_123", "status": "succeeded" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LaunchSessionRevocation", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "404": { "description": "Conexão não existe neste tenant" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "415": { "description": "Use Content-Type: application/json" }, "500": { "description": "Falha de banco ou resultado desconhecido; consulte ou repita o evento original sem alterar ID ou corpo" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Revogar um login Launch ou todas as sessões de autorização da conta", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/connections/{id}/session-revocations/{event}": { "get": { "description": "Retorna o recibo durável original deste tenant e conexão. HTTP 404 significa que nenhum resultado confirmado está visível no momento; repita o POST original com o mesmo event_id e corpo. Nenhum worker assíncrono é necessário.", "operationId": "launch_get__api_v1_launch_connections_id_session_revocations_event_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } }, { "in": "path", "name": "event", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "account_ref": "account_456", "completed_at": "2026-10-24T05:00:00.145678Z", "connection_id": "11111111-1111-4111-8111-111111111111", "created_at": "2026-10-24T05:00:00.123456Z", "environment": "live", "event_id": "11111111-1111-4111-8111-111111111111", "reason": "forced_logout", "released_devices": 2, "revoked_credentials": 2, "revoked_sessions": 2, "scope": "session", "sid": "login_123", "status": "succeeded" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LaunchSessionRevocation", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "404": { "description": "Nenhum resultado confirmado existe neste tenant e conexão" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "500": { "description": "Falha de banco ou resultado desconhecido; consulte ou repita o evento original sem alterar ID ou corpo" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Consultar resultado confirmado de revogação de sessão Launch", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-scope": "read" } }, "/api/v1/launch/device-operations/{operation}": { "get": { "description": "Ler progresso da liberação remota. Decisões, tentativas e verificações de escopo são realizadas pelo Licentivo.", "operationId": "launch_get__api_v1_launch_device_operations_operation_", "parameters": [ { "in": "path", "name": "operation", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "activation_id": "11111111-1111-4111-8111-111111111111", "expected_generation": 1, "license_id": "11111111-1111-4111-8111-111111111111", "operation_id": "11111111-1111-4111-8111-111111111111", "source": "logout", "status": "pending" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/DeviceReleaseOperation", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Ler progresso da liberação remota", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-scope": "read" } }, "/api/v1/launch/device-operations/{operation}/retry": { "post": { "description": "Uma operação manual_review precisa de approve=true do proprietário. Aprovação nunca ignora a versão original da vinculação.", "operationId": "launch_post__api_v1_launch_device_operations_operation_retry", "parameters": [ { "in": "path", "name": "operation", "required": true, "schema": { "description": "UUID do recurso Licentivo.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "additionalProperties": false, "properties": { "approve": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" } }, "required": [], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": {}, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "description": "Resultado desta operação.", "properties": { "queued": { "description": "Se esta conexão de confiança pode autorizar novo uso em execução.", "type": "boolean" } }, "required": [], "type": "object" }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [ { "managementKey": [] }, { "session": [] } ], "summary": "Tentar novamente ou aprovar explicitamente liberação revisada", "tags": [ "Launch account licensing" ], "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/launch/exchange": { "post": { "description": "Idempotency-Key é obrigatória. Cabeçalho JWT alg=Ed25519, typ=licentivo-launch-identity+jwt e kid fixado; iss/aud/environment, sub, sid, jti, iat, nbf, exp, auth_time, session_exp, launch_product_id, product_id e entitlement_ref exatos são obrigatórios. A asserção dura no máximo 120 segundos. Replays só recuperam a mesma sessão de dispositivo ativa com a mesma solicitação e chave de idempotência. Compras são lidas exclusivamente do Licentivo.", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "description": "Idempotency-Key para esta operação de autorização Launch.", "maxLength": 80, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "environment": "live", "identity_token": "identity_token_example", "launch_connection_id": "11111111-1111-4111-8111-111111111111", "product_id": "11111111-1111-4111-8111-111111111111" }, "schema": { "$ref": "#/components/schemas/LaunchExchangeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "activation_id": "11111111-1111-4111-8111-111111111111" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RuntimeResult", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [], "summary": "Trocar identidade de conta Launch por autorização de dispositivo", "tags": [ "Launch account licensing" ] } }, "/api/v1/legal/policy": { "get": { "description": "Retorna documentos fixados de serviço, reembolso e privacidade em todos os 13 idiomas suportados. Detalhes opcionais de perfil não confirmados são omitidos. Versão publicada exige aceitação explícita; fluxos existentes continuam até a primeira publicação.", "operationId": "get__api_v1_legal_policy", "parameters": [ { "in": "query", "name": "version", "schema": { "type": "string" } }, { "in": "query", "name": "locale", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommercePolicy" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Ler política jurídica imutável" } }, "/api/v1/licenses": { "get": { "operationId": "get_api_v1_licenses", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "product_id", "schema": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "q", "schema": { "description": "Texto de busca; campos pesquisados e comprimento máximo dependem da operação.", "maxLength": 254, "type": "string" } }, { "in": "query", "name": "status", "schema": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "expired", "suspended", "revoked" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "created_at": "2026-10-18T00:00:00Z", "customer": "Order #1001", "duration_days": 30, "expires_at": null, "features": [ "export" ], "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key_prefix": "lv_lic_AAAAAAA", "max_devices": 1, "mode": "timed", "policy_id": "22222222-2222-4222-8222-222222222222", "policy_version": 1, "product_id": "11111111-1111-4111-8111-111111111111", "status": "active", "updated_at": "2026-10-18T00:00:00Z" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicenseList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar licenças", "x-management-reference": { "group": "licenses" }, "x-required-scope": "read" }, "post": { "description": "Exige sessão Owner ou chave de escrita de um Owner ativo. Não repete automaticamente com Idempotency-Key.", "operationId": "post_api_v1_licenses", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "customer": "Order #1001", "customer_email": "buyer@example.com", "duration_days": 30, "policy_id": "22222222-2222-4222-8222-222222222222", "product_id": "11111111-1111-4111-8111-111111111111" }, "schema": { "$ref": "#/components/schemas/LicenseCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "duration_days": 30, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "key_prefix": "lv_lic_AAAAAAA" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicenseSecret", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Emitir licença", "x-management-reference": { "group": "licenses" }, "x-request-variants": [ { "name": "timed", "request": { "customer": "Order #1001", "customer_email": "buyer@example.com", "duration_days": 30, "policy_id": "22222222-2222-4222-8222-222222222222", "product_id": "11111111-1111-4111-8111-111111111111" }, "response": { "data": { "duration_days": 30, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "key_prefix": "lv_lic_AAAAAAA" }, "request_id": "55555555-5555-4555-8555-555555555555" } }, { "name": "perpetual", "request": { "customer": "Order #1001", "customer_email": "buyer@example.com", "duration_days": null, "policy_id": "22222222-2222-4222-8222-222222222223", "product_id": "11111111-1111-4111-8111-111111111111" }, "response": { "data": { "duration_days": null, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "key_prefix": "lv_lic_AAAAAAA" }, "request_id": "55555555-5555-4555-8555-555555555555" } } ], "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/batch": { "post": { "description": "Aplicar uma política nunca altera o modo nem a duração da licença. Criar cada licença timed/trial exige duração explícita no item ou no campo comum do lote. Licenças gerenciadas pelo Launch rejeitam renovação independente individual ou em lote com HTTP 409 LAUNCH_VALIDITY_MANAGED; renove a compra no Launch e sincronize a validade absoluta. Um lote misto de renovação é revertido integralmente.", "operationId": "post_api_v1_licenses_batch", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "duration_days": 30, "entries": [ { "customer": "Order #1001", "customer_email": "buyer@example.com" } ], "operation": "create", "policy_id": "22222222-2222-4222-8222-222222222222", "product_id": "11111111-1111-4111-8111-111111111111", "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/BatchInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "count": 1, "items": [ { "customer": "Order #1001", "customer_email": "buyer@example.com", "duration_days": 30, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } ], "operation": "create", "request_id": "55555555-5555-4555-8555-555555555555" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BatchResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Operar licenças em lote", "x-management-reference": { "group": "licenses" }, "x-request-variants": [ { "name": "create", "request": { "duration_days": 30, "entries": [ { "customer": "Order #1001", "customer_email": "buyer@example.com" } ], "operation": "create", "policy_id": "22222222-2222-4222-8222-222222222222", "product_id": "11111111-1111-4111-8111-111111111111", "request_id": "55555555-5555-4555-8555-555555555555" }, "response": { "data": { "count": 1, "items": [ { "customer": "Order #1001", "customer_email": "buyer@example.com", "duration_days": 30, "expires_at": null, "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } ], "operation": "create", "request_id": "55555555-5555-4555-8555-555555555555" }, "request_id": "55555555-5555-4555-8555-555555555555" } }, { "name": "renew", "request": { "days": 30, "ids": [ "33333333-3333-4333-8333-333333333333" ], "operation": "renew", "request_id": "55555555-5555-4555-8555-555555555555" }, "response": { "data": { "count": 1, "items": [ { "id": "33333333-3333-4333-8333-333333333333", "operation": "renew" } ], "operation": "renew", "request_id": "55555555-5555-4555-8555-555555555555" }, "request_id": "55555555-5555-4555-8555-555555555555" } }, { "name": "revoke", "request": { "ids": [ "33333333-3333-4333-8333-333333333333" ], "operation": "revoke", "request_id": "55555555-5555-4555-8555-555555555555" }, "response": { "data": { "count": 1, "items": [ { "id": "33333333-3333-4333-8333-333333333333", "operation": "revoke" } ], "operation": "revoke", "request_id": "55555555-5555-4555-8555-555555555555" }, "request_id": "55555555-5555-4555-8555-555555555555" } }, { "name": "apply_policy", "request": { "ids": [ "33333333-3333-4333-8333-333333333333" ], "operation": "apply_policy", "policy_id": "22222222-2222-4222-8222-222222222222", "preview_token": "REPLACE_WITH_THE_UNEXPIRED_PREVIEW_TOKEN", "request_id": "55555555-5555-4555-8555-555555555555" }, "response": { "data": { "count": 1, "items": [ { "id": "33333333-3333-4333-8333-333333333333", "operation": "apply_policy" } ], "operation": "apply_policy", "request_id": "55555555-5555-4555-8555-555555555555" }, "request_id": "55555555-5555-4555-8555-555555555555" } } ], "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/export.csv": { "get": { "operationId": "get_api_v1_licenses_export_csv", "parameters": [ { "in": "query", "name": "product_id", "schema": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "q", "schema": { "description": "Texto de busca; campos pesquisados e comprimento máximo dependem da operação.", "maxLength": 254, "type": "string" } }, { "in": "query", "name": "status", "schema": { "description": "Estado atual do recurso; consulte enum e as notas da operação.", "enum": [ "active", "expired", "suspended", "revoked" ], "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "id,product_id,key_prefix,customer,mode,status,max_devices,expires_at\n", "schema": { "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "413": { "content": { "application/json": { "example": { "error": { "code": "EXPORT_TOO_LARGE", "message": "Filter the export to at most 5000 records" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Filtrar para no máximo 5000 registros" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Exportar licenças", "x-csv-columns": [ "id", "product_id", "key_prefix", "customer", "mode", "status", "max_devices", "expires_at" ], "x-management-reference": { "group": "licenses" }, "x-required-scope": "read" } }, "/api/v1/licenses/policy-preview": { "post": { "description": "Aplicar uma política nunca altera o modo nem a duração da licença. Criar cada licença timed/trial exige duração explícita no item ou no campo comum do lote.", "operationId": "post_api_v1_licenses_policy-preview", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "ids": [ "33333333-3333-4333-8333-333333333333" ], "policy_id": "22222222-2222-4222-8222-222222222222" }, "schema": { "$ref": "#/components/schemas/PreviewInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "changes": [], "expires_in": 600, "note": "", "policy_version": 1, "preview_token": "" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PolicyPreview", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Pré-visualizar aplicação da política", "x-management-reference": { "group": "licenses" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/{id}": { "delete": { "operationId": "delete_api_v1_licenses_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Arquivar licença", "x-management-reference": { "group": "licenses" }, "x-required-role": "owner", "x-required-scope": "write" }, "get": { "operationId": "get_api_v1_licenses_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "created_at": "2026-10-18T00:00:00Z", "customer": "Order #1001", "duration_days": 30, "expires_at": null, "features": [ "export" ], "first_activated_at": null, "id": "33333333-3333-4333-8333-333333333333", "key_prefix": "lv_lic_AAAAAAA", "max_devices": 1, "mode": "timed", "policy_id": "22222222-2222-4222-8222-222222222222", "policy_version": 1, "product_id": "11111111-1111-4111-8111-111111111111", "status": "active", "updated_at": "2026-10-18T00:00:00Z" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/License", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler licença", "x-management-reference": { "group": "licenses" }, "x-required-scope": "read" }, "patch": { "operationId": "patch_api_v1_licenses_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "status": "suspended" }, "schema": { "$ref": "#/components/schemas/LicenseUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Atualizar licença", "x-management-reference": { "group": "licenses" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/{id}/capabilities": { "get": { "operationId": "get_api_v1_licenses_by_id_capabilities", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "customer_email": "buyer@example.com", "license": { "license_id": "33333333-3333-4333-8333-333333333333", "license_model": "node_locked", "maintenance_days": 0, "maintenance_until": null, "max_version": "", "min_version": "", "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z" }, "meter_rules": [], "usage": null }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicenseCapabilityResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler capacidades da licença", "x-management-reference": { "group": "licenses" }, "x-required-scope": "read" } }, "/api/v1/licenses/{id}/customer": { "patch": { "operationId": "patch_api_v1_licenses_by_id_customer", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "email": "buyer@example.com", "name": "Sample customer" }, "schema": { "$ref": "#/components/schemas/CustomerAssignment" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Atribuir cliente", "x-management-reference": { "group": "licenses" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/{id}/maintenance/renew": { "post": { "operationId": "post_api_v1_licenses_by_id_maintenance_renew", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "days": 30 }, "schema": { "$ref": "#/components/schemas/Renew" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "license_id": "33333333-3333-4333-8333-333333333333", "license_model": "node_locked", "maintenance_days": 0, "maintenance_until": null, "max_version": "", "min_version": "", "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicenseCapabilities", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Renovar manutenção", "x-management-reference": { "group": "licenses" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/{id}/renew": { "post": { "description": "Antes da primeira ativação, a renovação aumenta duration_days. Depois dela, a extensão começa no instante mais recente entre agora e expires_at; licenças expiradas não perdem prazo comprado. Licenças gerenciadas pelo Launch rejeitam renovação independente individual ou em lote com HTTP 409 LAUNCH_VALIDITY_MANAGED; renove a compra no Launch e sincronize a validade absoluta. Um lote misto de renovação é revertido integralmente.", "operationId": "post_api_v1_licenses_by_id_renew", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "days": 30 }, "schema": { "$ref": "#/components/schemas/Renew" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "duration_days": 60, "expires_at": null, "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Renewed", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Renovar licença", "x-management-reference": { "group": "licenses" }, "x-request-variants": [ { "name": "before_activation", "request": { "days": 30 }, "response": { "data": { "duration_days": 60, "expires_at": null, "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" } }, { "name": "after_activation", "request": { "days": 30 }, "response": { "data": { "duration_days": 30, "expires_at": "2026-12-17T00:00:00Z", "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" } } ], "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/licenses/{id}/reveal-key": { "post": { "description": "Requires an active Owner browser session and CSRF token. Management API keys and read-only members are forbidden. Keys are encrypted at rest and each view is audited without recording the secret. Ordinary lists, details and CSV exports contain only the prefix. Older encrypted batch/onboarding receipts are recovered during migration. Older hash-only issuances return LICENSE_KEY_UNAVAILABLE (409); Launch account licenses return LICENSE_KEY_NOT_APPLICABLE (409). Viewing does not rotate the key or change validity, devices or usage.", "operationId": "post_api_v1_licenses_by_id_reveal-key", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicenseKeyReveal" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "View the original license key", "x-required-role": "owner" } }, "/api/v1/licenses/{id}/revoke": { "post": { "operationId": "post_api_v1_licenses_by_id_revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Revogar licença", "x-management-reference": { "group": "licenses" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/members": { "get": { "operationId": "get_api_v1_members", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MemberList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "GET /members", "x-required-role": "owner" }, "post": { "operationId": "post_api_v1_members", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invite" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Invited" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "POST /members", "x-required-role": "owner" } }, "/api/v1/members/{id}": { "patch": { "operationId": "patch_api_v1_members_by_id", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "PATCH /members/{id}", "x-required-role": "owner" } }, "/api/v1/offline/respond": { "post": { "operationId": "post_api_v1_offline_respond", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "activation_id": "44444444-4444-4444-8444-444444444444", "app_version": "1.0.0", "created_at": 1792281600, "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "device_name": "Office PC", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "operation": "deactivate", "product_id": "11111111-1111-4111-8111-111111111111", "request_id": "55555555-5555-4555-8555-555555555555", "version": 1 }, "schema": { "$ref": "#/components/schemas/OfflineRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "operation": "deactivate", "request_id": "55555555-5555-4555-8555-555555555555", "result": { "activation_id": "44444444-4444-4444-8444-444444444444", "deactivated": true }, "version": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OfflineResponse", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Emitir resposta offline", "x-management-reference": { "group": "integration" }, "x-request-variants": [ { "name": "activate", "request": { "app_version": "1.0.0", "created_at": 1792281600, "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "device_name": "Office PC", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "operation": "activate", "product_id": "11111111-1111-4111-8111-111111111111", "request_id": "55555555-5555-4555-8555-555555555555", "version": 1 }, "response": { "data": { "operation": "activate", "request_id": "55555555-5555-4555-8555-555555555555", "result": { "activation_id": "44444444-4444-4444-8444-444444444444", "device_key": "lv_dev_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "heartbeat_seconds": 600, "lease": { "key_id": "66666666-6666-4666-8666-666666666666", "payload": "BASE64URL_ENCODED_SIGNED_CLAIMS", "signature": "BASE64URL_ED25519_SIGNATURE", "version": 1 } }, "version": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" } }, { "name": "deactivate", "request": { "activation_id": "44444444-4444-4444-8444-444444444444", "app_version": "1.0.0", "created_at": 1792281600, "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "device_name": "Office PC", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "operation": "deactivate", "product_id": "11111111-1111-4111-8111-111111111111", "request_id": "55555555-5555-4555-8555-555555555555", "version": 1 }, "response": { "data": { "operation": "deactivate", "request_id": "55555555-5555-4555-8555-555555555555", "result": { "activation_id": "44444444-4444-4444-8444-444444444444", "deactivated": true }, "version": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" } } ], "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/onboarding": { "post": { "operationId": "post_api_v1_onboarding", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "duration_days": 7, "mode": "trial", "name": "Report app", "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/OnboardingInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "config": { "allow_http": false, "app_version": "1.0.0", "base_url": "https://license.example.com", "cache_path": "", "device_name": "My application", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "product_id": "11111111-1111-4111-8111-111111111111", "trusted_keys": { "66666666-6666-4666-8666-666666666666": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "license_id": "33333333-3333-4333-8333-333333333333", "license_key": "lv_lic_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", "next": "Choose a language and download the configured SDK bundle.", "policy_id": "22222222-2222-4222-8222-222222222222", "product_id": "11111111-1111-4111-8111-111111111111" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OnboardingResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Criar recursos de integração", "x-management-reference": { "group": "integration" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/payments/paddle/webhook": { "post": { "operationId": "post__api_v1_payments_paddle_webhook", "parameters": [ { "in": "header", "name": "Paddle-Signature", "required": true, "schema": { "description": "Nome de exibição do serviço de pagamento.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaddleWebhookEvent" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WebhookReceived" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Verificar assinatura Paddle e reconciliar pagamentos concluídos ou ajustes", "x-licentivo-access": "public" } }, "/api/v1/payments/paypal/webhook": { "post": { "operationId": "post_api_v1_payments_paypal_webhook", "parameters": [ { "in": "header", "name": "Paypal-Auth-Algo", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Paypal-Cert-Url", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Paypal-Transmission-Id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Paypal-Transmission-Sig", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Paypal-Transmission-Time", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WebhookReceived" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Notificação verificada de captura, reembolso ou reversão" } }, "/api/v1/payments/waffo/webhook": { "post": { "operationId": "post__api_v1_payments_waffo_webhook", "parameters": [ { "in": "header", "name": "X-Waffo-Signature", "required": true, "schema": { "description": "Identificador do comerciante iniciado por MER_.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaffoWebhookEvent" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WebhookReceived" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Verificar assinatura Waffo e reconciliar pagamento ou reembolso", "x-licentivo-access": "public" } }, "/api/v1/policies": { "get": { "operationId": "get_api_v1_policies", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "product_id", "schema": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "created_at": "2026-10-18T00:00:00Z", "features": [ "export" ], "heartbeat_seconds": 600, "id": "22222222-2222-4222-8222-222222222222", "max_devices": 1, "mode": "timed", "name": "One device", "offline_mode": "limited", "offline_seconds": 86400, "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z", "version": 1 } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PolicyList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar políticas", "x-management-reference": { "group": "policies" }, "x-required-scope": "read" }, "post": { "description": "Exige sessão Owner ou chave de escrita de um Owner ativo. Não repete automaticamente com Idempotency-Key.", "operationId": "post_api_v1_policies", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "features": [ "export" ], "heartbeat_seconds": 600, "max_devices": 1, "mode": "timed", "name": "One device", "offline_mode": "limited", "offline_seconds": 86400, "product_id": "11111111-1111-4111-8111-111111111111" }, "schema": { "$ref": "#/components/schemas/PolicyCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Criar política", "x-management-reference": { "group": "policies" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/policies/{id}": { "delete": { "operationId": "delete_api_v1_policies_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Arquivar política", "x-management-reference": { "group": "policies" }, "x-required-role": "owner", "x-required-scope": "write" }, "get": { "operationId": "get_api_v1_policies_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "created_at": "2026-10-18T00:00:00Z", "features": [ "export" ], "heartbeat_seconds": 600, "id": "22222222-2222-4222-8222-222222222222", "max_devices": 1, "mode": "timed", "name": "One device", "offline_mode": "limited", "offline_seconds": 86400, "product_id": "11111111-1111-4111-8111-111111111111", "updated_at": "2026-10-18T00:00:00Z", "version": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Policy", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler política", "x-management-reference": { "group": "policies" }, "x-required-scope": "read" }, "patch": { "description": "Atualiza atomicamente a política e os instantâneos de todas as licenças vinculadas não revogadas. Preserva prazos existentes, uso confirmado e extensões de manutenção independentes. Retorna synced_licenses. ACTIVE_DEVICES_CONFLICT reverte todo o salvamento.", "operationId": "patch_api_v1_policies_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "max_devices": 2 }, "schema": { "$ref": "#/components/schemas/PolicyUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "synced_licenses": 0 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PolicySyncResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Atualizar política básica", "x-management-reference": { "group": "policies" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/policies/{id}/capabilities": { "get": { "operationId": "get_api_v1_policies_by_id_capabilities", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "allow_vm": true, "device_match": "system", "license_model": "node_locked", "maintenance_days": 0, "max_version": "", "meter_rules": [], "min_version": "", "policy_id": "22222222-2222-4222-8222-222222222222", "policy_version": 1, "product_id": "11111111-1111-4111-8111-111111111111", "require_hardware": false, "self_release_limit": 3, "session_seconds": 7200, "updated_at": "2026-10-18T00:00:00Z" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PolicyCapabilities", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler capacidades da política", "x-management-reference": { "group": "policies" }, "x-required-scope": "read" }, "patch": { "description": "Use policy_version atual. Atualiza atomicamente a política e os instantâneos de todas as licenças vinculadas não revogadas, preservando prazos emitidos, uso confirmado e extensões independentes de manutenção. Retorna synced_licenses. POLICY_CHANGED ou ACTIVE_DEVICES_CONFLICT reverte todo o salvamento.", "operationId": "patch_api_v1_policies_by_id_capabilities", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "license_model": "node_locked", "meter_rules": [ { "allow_overage": false, "feature": "export", "limit": 500, "max_overage": 0, "period": "month" } ], "policy_version": 1 }, "schema": { "$ref": "#/components/schemas/PolicyCapabilitiesInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "synced_licenses": 0 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PolicySyncResult", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Atualizar capacidades da política", "x-management-reference": { "group": "policies" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/products": { "get": { "operationId": "get_api_v1_products", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "q", "schema": { "description": "Texto de busca; campos pesquisados e comprimento máximo dependem da operação.", "maxLength": 120, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "created_at": "2026-10-18T00:00:00Z", "description": "Desktop reporting software", "id": "11111111-1111-4111-8111-111111111111", "name": "Report app", "status": "active", "updated_at": "2026-10-18T00:00:00Z" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProductList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar produtos", "x-management-reference": { "group": "products" }, "x-required-scope": "read" }, "post": { "description": "Exige sessão Owner ou chave de escrita de um Owner ativo. Não repete automaticamente com Idempotency-Key.", "operationId": "post_api_v1_products", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "description": "Desktop reporting software", "name": "Report app" }, "schema": { "$ref": "#/components/schemas/ProductCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Criar produto", "x-management-reference": { "group": "products" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/products/{id}": { "delete": { "operationId": "delete_api_v1_products_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Arquivar produto", "x-management-reference": { "group": "products" }, "x-required-role": "owner", "x-required-scope": "write" }, "get": { "operationId": "get_api_v1_products_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "created_at": "2026-10-18T00:00:00Z", "description": "Desktop reporting software", "id": "11111111-1111-4111-8111-111111111111", "name": "Report app", "status": "active", "updated_at": "2026-10-18T00:00:00Z" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Product", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Ler produto", "x-management-reference": { "group": "products" }, "x-required-scope": "read" }, "patch": { "operationId": "patch_api_v1_products_by_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Report app Pro", "status": "active" }, "schema": { "$ref": "#/components/schemas/ProductUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Atualizar produto", "x-management-reference": { "group": "products" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/products/{id}/public-keys": { "get": { "operationId": "get_api_v1_products_by_id_public-keys", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/KeyBundle" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Conjunto de chaves públicas fixadas do produto" } }, "/api/v1/products/{id}/releases": { "get": { "operationId": "get_api_v1_products_by_id_releases", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "channel": "stable", "created_at": "2026-10-18T00:00:00Z", "download_url": "", "id": "33333333-3333-4333-8333-333333333333", "notes": "Initial release", "product_id": "11111111-1111-4111-8111-111111111111", "published_at": "2026-10-18T00:00:00Z", "sha256": "", "version": "1.0.0" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ReleaseList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar versões", "x-management-reference": { "group": "releases" }, "x-required-scope": "read" }, "post": { "operationId": "post_api_v1_products_by_id_releases", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "channel": "stable", "notes": "Initial release", "version": "1.0.0" }, "schema": { "$ref": "#/components/schemas/ReleaseInput" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "channel": "stable", "created_at": "2026-10-18T00:00:00Z", "download_url": "", "id": "33333333-3333-4333-8333-333333333333", "notes": "Initial release", "product_id": "11111111-1111-4111-8111-111111111111", "published_at": "2026-10-18T00:00:00Z", "sha256": "", "version": "1.0.0" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Release", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Publicar versão", "x-management-reference": { "group": "releases" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/products/{id}/sdk-bundle": { "post": { "operationId": "post_api_v1_products_by_id_sdk-bundle", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "language": "go" }, "schema": { "$ref": "#/components/schemas/BundleInput" } } }, "required": true }, "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Baixar o código-fonte de exemplo do produto", "x-management-reference": { "group": "products" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/products/{id}/sdk-initializer": { "get": { "operationId": "get_api_v1_products_by_id_sdk-initializer", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "language", "schema": { "default": "go", "description": "Identificador da linguagem SDK do pacote para download.", "enum": [ "go", "java", "c", "cpp", "csharp", "python", "javascript", "rust", "ruby" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "language": "go", "product_id": "11111111-1111-4111-8111-111111111111", "source": "const productID = \"11111111-1111-4111-8111-111111111111\"\nvar trustedKeys = map[string]string{\"66666666-6666-4666-8666-666666666666\": \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\"}\n", "trusted_keys": { "66666666-6666-4666-8666-666666666666": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SDKInitializer", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Copiar código de inicialização do produto", "x-management-reference": { "group": "products" }, "x-required-scope": "read" } }, "/api/v1/products/{id}/signing-keys": { "get": { "operationId": "get_api_v1_products_by_id_signing-keys", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "keys": [], "product_id": "11111111-1111-4111-8111-111111111111" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ManagementKeyBundle", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar chaves de assinatura", "x-management-reference": { "group": "products" }, "x-required-scope": "read" } }, "/api/v1/products/{id}/signing-keys/rotate": { "post": { "operationId": "post_api_v1_products_by_id_signing-keys_rotate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "data": { "active": true, "algorithm": "Ed25519", "created_at": "2026-10-18T00:00:00Z", "key_id": "66666666-6666-4666-8666-666666666666", "public_key": "", "retired_at": null }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SigningKey", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Rotacionar chave de assinatura", "x-management-reference": { "group": "products" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/releases/eligible": { "post": { "description": "Operação de runtime autenticada por licença, sem cookie do fornecedor ou API Key. O consumo de funcionalidades exige Idempotency-Key estável; consume não debita a API da plataforma.", "operationId": "post_api_v1_releases_eligible", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/EligibleReleases" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "/releases/eligible" } }, "/api/v1/service/status": { "get": { "description": "Somente avisos globais são públicos; IDs de workspaces direcionados não são expostos.", "operationId": "get__api_v1_service_status", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ServiceIncidentList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Ler manutenção e incidentes públicos" } }, "/api/v1/sessions/logout": { "post": { "description": "Sem cookies de navegador ou token CSRF. Operação duplicada é reproduzida sem liberar vinculações mais novas. Estado stale é conclusão bem-sucedida de revogação obsoleta. SDKs negam uso local e limpam credenciais de execução antes de enviar esta solicitação.", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "activation_id": "11111111-1111-4111-8111-111111111111", "expected_generation": 1, "operation_id": "11111111-1111-4111-8111-111111111111", "product_id": "11111111-1111-4111-8111-111111111111", "release_token": "lv_out_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" }, "schema": { "$ref": "#/components/schemas/LogoutTicket" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "activation_id": "11111111-1111-4111-8111-111111111111", "expected_generation": 1, "license_id": "11111111-1111-4111-8111-111111111111", "operation_id": "11111111-1111-4111-8111-111111111111", "source": "logout", "status": "pending" }, "request_id": "request_id_example" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/DeviceReleaseOperation", "description": "Resultado desta operação." }, "request_id": { "description": "Identificador de correlação da solicitação HTTP.", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resultado aceito" }, "400": { "description": "Entrada inválida" }, "401": { "description": "Autenticação ou asserção de identidade rejeitada" }, "403": { "description": "Entitlement, credencial, ambiente ou login revogado" }, "409": { "description": "Conflito de versão de idempotência, política, análise ou vinculação" }, "503": { "description": "Falha temporária; repita a operação original" } }, "security": [], "summary": "Revogar uma vinculação de dispositivo versionada usando ticket apenas de desvinculação", "tags": [ "Launch account licensing" ] } }, "/api/v1/summary": { "get": { "operationId": "get_api_v1_summary", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "active_licenses": 0, "licenses": 0, "policies": 0, "products": 0 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Summary", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Contagens do espaço de trabalho", "x-management-reference": { "group": "usage" }, "x-required-scope": "read" } }, "/api/v1/support/contact": { "get": { "description": "Retorna apenas o e-mail de contato configurado; vazio significa oculto. Nenhum e-mail é enviado.", "operationId": "get__api_v1_support_contact", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportContact" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [], "summary": "Ler e-mail público de suporte" } }, "/api/v1/system/billing-notifications": { "get": { "description": "Reutiliza transporte de e-mail de autenticação, remetente, fila persistente criptografada e tentativas. Tanto a permissão da plataforma quanto o consentimento do destinatário devem permitir o tipo. A entrega verifica novamente o consentimento atual e o estado do evento. As escolhas de e-mail não concedem nem revogam consentimento para debitar a carteira. Mensagens sandbox são identificadas. Não são criadas notificações para compras pendentes não pagas ou presentes.", "operationId": "get__api_v1_system_billing_notifications", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingNotificationSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler regras de e-mail de faturamento da plataforma", "x-platform-admin": true, "x-required-role": "owner" }, "patch": { "description": "Atualização parcial; valores explicitamente false persistem. Reutiliza transporte de e-mail de autenticação, remetente, fila persistente criptografada e tentativas. Tanto a permissão da plataforma quanto o consentimento do destinatário devem permitir o tipo. A entrega verifica novamente o consentimento atual e o estado do evento. As escolhas de e-mail não concedem nem revogam consentimento para debitar a carteira. Mensagens sandbox são identificadas. Não são criadas notificações para compras pendentes não pagas ou presentes.", "operationId": "patch__api_v1_system_billing_notifications", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingNotificationSettingsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingNotificationSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Configurar regras de e-mail de faturamento e contato público de suporte", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/billing-notifications/preview": { "get": { "description": "Usa configurações salvas da plataforma e dados sandbox de exemplo. Nenhuma compra ou tarefa de e-mail é criada.", "operationId": "get__api_v1_system_billing_notifications_preview", "parameters": [ { "in": "query", "name": "kind", "required": true, "schema": { "enum": [ "purchase_success", "expiry_reminder", "auto_renewal_success", "auto_renewal_problem" ], "type": "string" } }, { "in": "query", "name": "locale", "schema": { "default": "zh", "enum": [ "zh", "zh-hant", "en", "es", "hi", "ar", "fr", "bn", "pt", "id", "ur" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/BillingEmailPreview" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Visualizar e-mail de faturamento sem enviar", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/billing-notifications/test": { "post": { "description": "Teste explícito usa dados sandbox de exemplo, adiciona [TEST] e segue a configuração de e-mail existente. Pode testar um modelo mesmo se esse tipo de notificação do cliente estiver desativado. Nenhum pagamento ou renovação é realizado.", "operationId": "post__api_v1_system_billing_notifications_test", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingEmailTestInput" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MailQueued" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Enfileirar teste solicitado de e-mail de faturamento", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/check-mail": { "post": { "description": "Verifica apenas o serviço salvo. Verificações de provedores de API fazem requisições somente de leitura e nunca enviam e-mail. Uma chave apenas de envio pode produzir check_status=limited e ok=false; isso não confirma credenciais válidas nem entrega bem-sucedida. Testar o envio exige uma solicitação explícita de e-mail de teste.", "operationId": "post_api_v1_system_check-mail", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MailConnection" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "MAIL_PROVIDER_AUTH_FAILED, MAIL_PROVIDER_RATE_LIMITED ou MAIL_PROVIDER_UNAVAILABLE. A entrega de teste é assíncrona; erros de entrega aparecem no resultado da tarefa, não na resposta HTTP 202 original." } }, "security": [ { "session": [] } ], "summary": "POST /system/check-mail", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases": { "get": { "description": "", "operationId": "get__api_v1_system_customer_cases", "parameters": [ { "description": "Exclua um tipo de solicitação antes da contagem e paginação. Use refund para excluir casos de reembolso da lista de suporte; o acesso permanece limitado à sessão atual.", "in": "query", "name": "exclude_kind", "schema": { "maxLength": 24, "type": "string" } }, { "description": "Limitar casos de reembolso a recargas de carteira ou cancelamento de serviço.", "in": "query", "name": "refund_scope", "required": false, "schema": { "enum": [ "wallet", "service" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar solicitações de clientes", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/unread": { "get": { "description": "Conversas de reembolso são excluídas. Clientes veem apenas tickets autorizados do workspace; membros veem os próprios. Cada administrador tem marcador de leitura independente.", "operationId": "get__api_v1_system_customer_cases_unread", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportUnread" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler contagens de tickets e avisos pessoais não lidos", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}": { "get": { "description": "", "operationId": "get__api_v1_system_customer_cases__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler solicitação e respostas", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/deletion-review": { "post": { "description": "Exige reconhecimento de responsabilidade financeira. Revoga acesso normal imediatamente; fecha a exportação do cliente após exatamente 30 dias e retém todos os registros comerciais para exportação por administrador autorizado.", "operationId": "post__api_v1_system_customer_cases__id__deletion_review", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountClosureReview" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Confirmar ou rejeitar fechamento lógico de conta", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/manual-refund": { "post": { "description": "Exige concordância do cliente e prova de pagamento concluído. Registra a liquidação; nunca envia transferência bancária. Confirmação repetida não pode debitar duas vezes. Pagamentos originais Waffo/Paddle, inclusive serviços, rejeitam esta via apenas declaratória com ORIGINAL_REFUND_REQUIRED.", "operationId": "post__api_v1_system_customer_cases__id__manual_refund", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManualRefundInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Registrar reembolso alternativo efetivamente concluído", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/messages": { "post": { "description": "Casos de reembolso rejeitam respostas com REFUND_REVIEW_WORKFLOW; administradores aprovam ou recusam diretamente. Tickets comuns mantêm respostas. Fechamentos revisados mantêm o estado de seu fluxo de privacidade.", "operationId": "post__api_v1_system_customer_cases__id__messages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportReply" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Responder a um ticket de suporte", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/read": { "post": { "description": "Somente mensagens até a última exibida são marcadas como lidas. Novas chegadas continuam não lidas e confirmações atrasadas não podem retroceder o marcador.", "operationId": "post__api_v1_system_customer_cases__id__read", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportReadInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Confirmar mensagens de ticket exibidas", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/recover-original-refund": { "post": { "description": "Exige confirmação explícita do administrador de que nenhuma transferência alternativa foi realmente feita. Preserva a evidência original e usa lançamentos contábeis compensatórios. Somente o valor restante é solicitado aos pagamentos originais.", "operationId": "post__api_v1_system_customer_cases__id__recover_original_refund", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoverOriginalRefund" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" } }, "security": [ { "session": [] } ], "summary": "Corrigir declaração manual não paga e solicitar reembolso original", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/refund-quote": { "post": { "description": "Nova prévia de escopo, valor e agenda. Alteração do escopo de serviço exige nova solicitação do cliente; o administrador pode recusar diretamente a anterior.", "operationId": "post__api_v1_system_customer_cases__id__refund_quote", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRefundPreviewInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ScopedRefundPreview" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Visualizar pedido pendente com escopo antes da aprovação", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/customer/cases/{id}/refund-review": { "post": { "description": "Serializa no workspace de destino. A aprovação reserva fundos disponíveis da carteira, aloca reembolsos pelo meio original usando IDs estáveis de solicitação ao provedor e mantém qualquer saldo que exija alternativa acordada. Aprovações Waffo/Paddle criam intenções duráveis de reembolso pelo provedor original e enviam solicitações à API de reembolso do comerciante. Nenhuma declaração manual pode concluir esses reembolsos. Estado de aprovação processing/pending não é dinheiro liquidado.", "operationId": "post__api_v1_system_customer_cases__id__refund_review", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundReview" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SupportCaseDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Aprovar ou rejeitar reembolso do cliente", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/legal/policy": { "get": { "description": "", "operationId": "get__api_v1_system_legal_policy", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommercePolicy" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler perfil do operador e versões pendentes de políticas", "x-platform-admin": true, "x-required-role": "owner" }, "patch": { "description": "A publicação exige nome jurídico confirmado do operador e e-mail de contato válido. Outros detalhes do perfil são opcionais e itens não confirmados são omitidos dos documentos públicos. Substituições publicadas preservam a versão anterior durante pelo menos 30 dias de aviso no console e por e-mail enviado com sucesso.", "operationId": "patch__api_v1_system_legal_policy", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommercePolicyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommercePolicy" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Publicar ou agendar políticas de serviço", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/mail-jobs": { "get": { "description": "Somente sessão de administrador da plataforma. As últimas 50 mensagens com tipo, ambiente, destinatário, tentativas, estado e motivo do cancelamento. Conteúdos entregues ou cancelados são apagados. A aceitação SMTP não significa entrega na caixa de entrada nem leitura.", "operationId": "get_api_v1_system_mail-jobs", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MailJobList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "GET /system/mail-jobs", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/mail-jobs/{id}/retry": { "post": { "description": "Redefine a contagem de tentativas e enfileira a mesma mensagem com falha. Tarefas entregues, canceladas, em execução e pendentes retornam MAIL_JOB_NOT_RETRYABLE. Tarefas de faturamento verificam novamente consentimento atual e estado do evento antes da nova tentativa. Erros SMTP nunca revertem pagamento confirmado.", "operationId": "post__api_v1_system_mail_jobs__id__retry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MailQueued" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Tentar novamente e-mail com falha e payload criptografado preservado", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/operations": { "get": { "description": "Somente sessão de administrador da plataforma. Log de aplicativo somente de acréscimo com ator, sujeito, motivo e alterações explícitas.", "operationId": "get__api_v1_system_operations", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "user_id", "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "action", "schema": { "maxLength": 80, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformOperationList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar operações administrativas de clientes" } }, "/api/v1/system/overview": { "get": { "description": "Somente sessão de administrador da plataforma. Métricas de pacotes usam o ambiente de pagamento atualmente configurado. Novos usuários abrangem os últimos 30 dias; expiração abrange os próximos 7 dias.", "operationId": "get__api_v1_system_overview", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformOverview" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler totais de clientes e pacotes da plataforma" } }, "/api/v1/system/paddle": { "get": { "operationId": "get__api_v1_system_paddle", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleSettings" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler configuração Paddle sem chaves privadas", "x-licentivo-access": "platform" }, "patch": { "operationId": "patch__api_v1_system_paddle", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaddleSettingsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleSettings" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Salvar credenciais Paddle Billing criptografadas", "x-licentivo-access": "platform" } }, "/api/v1/system/paddle/check": { "post": { "operationId": "post__api_v1_system_paddle_check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleCheck" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Verificar credenciais Paddle e produto ativo", "x-licentivo-access": "platform" } }, "/api/v1/system/paddle/orders": { "get": { "operationId": "get__api_v1_system_paddle_orders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleOrderList" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar pagamentos de serviços e recargas de carteira Paddle", "x-licentivo-access": "platform" } }, "/api/v1/system/paddle/orders/{id}/reconcile": { "post": { "operationId": "post__api_v1_system_paddle_orders__id__reconcile", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaddleReconcileInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaddleOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Reconciliar ou recuperar uma transação original sem criar cobrança", "x-licentivo-access": "platform" } }, "/api/v1/system/payment-channels": { "get": { "operationId": "get__api_v1_system_payment_channels", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaymentChannels" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar canais de pagamento configuráveis independentemente", "x-licentivo-access": "platform" }, "patch": { "operationId": "patch__api_v1_system_payment_channels", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentChannelInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PaymentChannels" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Habilitar ou desabilitar canais atomicamente com concorrência otimista", "x-licentivo-access": "platform" } }, "/api/v1/system/paypal": { "get": { "operationId": "get_api_v1_system_paypal", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "PayPal", "x-platform-admin": true, "x-required-role": "owner" }, "patch": { "operationId": "patch_api_v1_system_paypal", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayPalInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "PayPal", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/paypal/check": { "post": { "operationId": "post_api_v1_system_paypal_check", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalCheck" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Verificar PayPal", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/paypal/orders/{id}/refund": { "post": { "description": "Somente sessão de administrador da plataforma. Reserva crédito disponível e não gasto da carteira antes de contatar PayPal. Pending significa resultado não confirmado; reconcilie a mesma solicitação. Não cancela um pacote automaticamente.", "operationId": "post__api_v1_system_paypal_orders__id__refund", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalRefund" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Reembolsar fundos não usados da carteira ao método PayPal original" } }, "/api/v1/system/paypal/refund-requests": { "get": { "description": "Somente sessões por cookie; chaves API de gerenciamento não são aceitas. Leituras do cliente são limitadas ao seu workspace. Gravações do cliente exigem Owner verificado do workspace, sem permissão de administrador da plataforma. Solicitações não movem nem reservam fundos. A aprovação administrativa verifica novamente a carteira atual e o valor capturado ainda não reembolsado, então usa o fluxo existente idempotente de reembolso pelo meio original e reserva. A aprovação não cancela planos.", "operationId": "get__api_v1_system_paypal_refund_requests", "parameters": [ { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletRefundRequestList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" } }, "security": [ { "session": [] } ], "summary": "Listar solicitações de reembolso de clientes para análise", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/paypal/refund-requests/{id}/review": { "post": { "description": "Somente sessões por cookie; chaves API de gerenciamento não são aceitas. Leituras do cliente são limitadas ao seu workspace. Gravações do cliente exigem Owner verificado do workspace, sem permissão de administrador da plataforma. Solicitações não movem nem reservam fundos. A aprovação administrativa verifica novamente a carteira atual e o valor capturado ainda não reembolsado, então usa o fluxo existente idempotente de reembolso pelo meio original e reserva. A aprovação não cancela planos.", "operationId": "post__api_v1_system_paypal_refund_requests__id__review", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletRefundReview" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WalletRefundRequest" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, autenticação, titularidade, conflito de revisão ou saldo" } }, "security": [ { "session": [] } ], "summary": "Aprovar ou recusar solicitação de reembolso de cliente", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/paypal/refunds": { "get": { "description": "Somente sessão de administrador da plataforma.", "operationId": "get__api_v1_system_paypal_refunds", "parameters": [ { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RefundList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Listar solicitações de reembolso do ambiente de pagamento selecionado" } }, "/api/v1/system/paypal/refunds/{id}/reconcile": { "post": { "description": "Somente sessão de administrador da plataforma. Repete o mesmo PayPal-Request-Id se o ID do reembolso não foi recebido ou consulta o reembolso existente no provedor.", "operationId": "post__api_v1_system_paypal_refunds__id__reconcile", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PayPalRefund" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Reconciliar o mesmo reembolso sem nova identidade de cobrança" } }, "/api/v1/system/plan-gifts": { "get": { "description": "Somente sessão de administrador da plataforma. O destinatário informado representa o workspace deduplicado. A pesquisa corresponde a e-mail do destinatário, workspace ou nome do pacote.", "operationId": "get__api_v1_system_plan_gifts", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 100000, "minimum": 0, "type": "integer" } }, { "in": "query", "name": "q", "schema": { "type": "string" } }, { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } }, { "in": "query", "name": "user_id", "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanGiftList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar histórico de presentes" }, "post": { "description": "Somente sessão de administrador da plataforma. Lote atômico. Forneça fingerprint da prévia e request_id estável; replay correspondente retorna o mesmo lote. Alterações de nível ou agenda exigem nova prévia. Presentes mantêm pagamento real zero e não podem se tornar reembolso em dinheiro. Seu valor de benefício capturado é creditado normalmente no upgrade. Apenas novos presentes do nível atual ainda não iniciados acompanham upgrade posterior sem pagamento adicional, mantendo datas. Presentes históricos nunca são realinhados; cotas mensais e regras de excedente aplicam-se normalmente. Lotes mistos usam metadados current/---; examine registros individuais de presentes vinculados a compras para cada nível e moeda reais.", "operationId": "post__api_v1_system_plan_gifts", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanGiftInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanGiftResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Confirmar presente revisado do nível atual" } }, "/api/v1/system/plan-gifts/preview": { "post": { "description": "Somente sessão de administrador da plataforma. 1–100 IDs distintos de usuários clientes ativos. Usuários do mesmo workspace recebem um contrato. Cada item herda o pacote efetivo atual desse cliente ou o último pacote expirado no ambiente selecionado. Lotes de níveis mistos retornam o plano e valor de benefício reais por item. Omita plan/currency/price_version; valores explícitos opcionais devem corresponder ao pacote existente de cada cliente. Clientes sem pacote não podem receber outro nível por este endpoint. after_current acrescenta após toda a cobertura paga/presenteada; immediate rejeita direitos sobrepostos. Sem gravações ou cobranças.", "operationId": "post__api_v1_system_plan_gifts_preview", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanGiftPreviewInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanGiftPreview" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Visualizar presente de pacote do nível atual" } }, "/api/v1/system/plan-gifts/{id}/cancel": { "post": { "description": "Somente sessão de administrador da plataforma. Cancelamentos repetidos são seguros. Interrompe este contrato sem excluir histórico, reembolsar excedente ou mover outros contratos agendados.", "operationId": "post__api_v1_system_plan_gifts__id__cancel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformReason" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlanGiftCancellation" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Cancelar presente ativo ou agendado" } }, "/api/v1/system/plans": { "get": { "operationId": "get_api_v1_system_plans", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AdminPlanList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Planos", "x-platform-admin": true, "x-required-role": "owner" }, "post": { "operationId": "post_api_v1_system_plans", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Price" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Planos", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/plans/customer-controls": { "patch": { "description": "Somente sessão de administrador da plataforma. Ambos os controles são false por padrão. Forneça device_enabled, api_enabled ou ambos. Controles omitidos mantêm o estado atual. Cada controle desativado oculta seus controles do cliente e ignora apenas sua própria preferência salva até ser reativado. Franquias API marcadas unlimited permanecem ilimitadas.", "operationId": "patch__api_v1_system_plans_customer_controls", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerControlsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CustomerControlsResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Permitir independentemente configurações de excedente de dispositivos ou API pelo cliente" } }, "/api/v1/system/plans/default": { "patch": { "operationId": "patch_api_v1_system_plans_default", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultPlan" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/DefaultPlan" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Plano padrão", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/privacy/retention": { "get": { "description": "", "operationId": "get__api_v1_system_privacy_retention", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler execuções de arquivamento e retenção", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/privacy/retention/run": { "post": { "description": "Somente arquivamento lógico; linhas de cliente/negócio são preservadas. Rotaciona arquivos de backup .lvb gerenciados e autenticados após 90 dias e logs de segurança próprios do aplicativo após seis meses corridos. Execuções são serializadas com bloqueio de banco.", "operationId": "post__api_v1_system_privacy_retention_run", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Confirmation" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/CommerceResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Processar arquivamento e retenção já devidos", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/provider-refunds/{id}/reconcile": { "post": { "description": "Consulta a solicitação existente pela referência do provedor/negócio. Somente uma intenção durável ainda não enviada pode fazer sua primeira solicitação; envios duplicados ou desconhecidos nunca são repostados. A conclusão exige recibos do provedor original verificados independentemente.", "operationId": "post__api_v1_system_provider_refunds__id__reconcile", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ProviderRefund" }, "request_id": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" } }, "security": [ { "session": [] } ], "summary": "Reconciliar reembolso existente pelo canal original", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/refund-requests": { "get": { "description": "Sessão de administrador da plataforma somente leitura. Combina solicitações de reembolso de carteira e casos de cancelamento de carteira/serviço do provedor. Contagens pendentes no escopo do ambiente são independentes da paginação e dos filtros de escopo. A leitura nunca aprova, congela ou reembolsa fundos; use o endpoint de análise existente de cada origem.", "operationId": "get_system_refund_requests", "parameters": [ { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } }, { "in": "query", "name": "review", "schema": { "enum": [ "pending", "all" ], "type": "string" } }, { "in": "query", "name": "scope", "schema": { "enum": [ "wallet", "service" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RefundInboxList" }, "request_id": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "description": "Solicitações e contagens de análise pendente no escopo do ambiente" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, sessão ou permissão" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, sessão ou permissão" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, sessão ou permissão" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, sessão ou permissão" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, sessão ou permissão" } }, "security": [ { "session": [] } ], "summary": "Fila unificada de análise de reembolsos de clientes", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/refunds": { "get": { "operationId": "get__api_v1_system_refunds", "parameters": [ { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RefundHistory" }, "request_id": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" } }, "security": [ { "session": [] } ], "summary": "Listar reembolsos em PayPal, Waffo e Paddle", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/revenue": { "get": { "operationId": "get_api_v1_system_revenue", "parameters": [ { "in": "query", "name": "mode", "schema": { "enum": [ "sandbox", "live" ], "type": "string" } }, { "in": "query", "name": "month", "schema": { "description": "all ou UTC YYYY-MM", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Revenue" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Receita", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/sdk-example": { "post": { "description": "Somente sessão Owner do administrador da plataforma, com CSRF. Chaves de API são recusadas. Reutiliza o produto e a política dedicados; não renova avaliações existentes.", "operationId": "post_api_v1_system_sdk-example", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKExampleSetup" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SDKExampleSetting" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "Preparar ou ativar o produto dedicado do administrador para o exemplo público do SDK", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/service/incidents": { "get": { "description": "", "operationId": "get__api_v1_system_service_incidents", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ServiceIncidentList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler todos os avisos de serviço", "x-platform-admin": true, "x-required-role": "owner" }, "post": { "description": "Manutenção não emergencial exige aviso de pelo menos 24 horas. Incidente contínuo verificado superior a 24 horas credita o tempo pago realmente afetado; intervalos sobrepostos não são compensados duas vezes. Mais de sete dias pode qualificar para reembolso de serviço não usado.", "operationId": "post__api_v1_system_service_incidents", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceIncidentInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ServiceIncident" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Publicar manutenção ou resolver incidente", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/settings": { "get": { "operationId": "get_api_v1_system_settings", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/SystemSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "GET /system/settings", "x-platform-admin": true, "x-required-role": "owner" }, "patch": { "operationId": "patch_api_v1_system_settings", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MailSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "PATCH /system/settings", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/test-mail": { "post": { "description": "Enfileira explicitamente uma mensagem de teste real para o destinatário informado, usando o serviço salvo. HTTP 202 confirma aceitação na fila, não chegada à caixa de entrada. Acompanhe a tarefa e examine o painel do provedor e a caixa de entrada para verificar problemas de entrega.", "operationId": "post_api_v1_system_test-mail", "parameters": [ { "description": "Obrigatório em escritas com cookie ou autenticação pública; dispensa apenas escritas de recursos que aceitam Bearer", "in": "header", "name": "X-CSRF-Token", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestMail" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/MailQueued" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] } ], "summary": "POST /system/test-mail", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/tls": { "get": { "description": "Somente sessão de navegador do administrador da plataforma. Chaves API de gerenciamento e proprietários de tenants são rejeitados. Reflete o certificado usado por este processo. Nenhum PEM do certificado ou chave privada é exposto.", "operationId": "get__api_v1_system_tls", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TLSStatus" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso; apenas metadados públicos do certificado são retornados." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." } }, "security": [ { "session": [] } ], "summary": "Ler o certificado HTTPS ativo" }, "patch": { "description": "Somente sessão de navegador do administrador da plataforma. Chaves API de gerenciamento e proprietários de tenants são rejeitados. Valida e criptografa o certificado/chave no MySQL, registra evento de auditoria e troca o certificado ativo. Novos handshakes TLS usam-no imediatamente; conexões existentes continuam normalmente. Uma reinicialização prefere o certificado do banco aos arquivos de bootstrap.", "operationId": "patch__api_v1_system_tls", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TLSCertificateUpdateInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TLSCertificateResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso; apenas metadados públicos do certificado são retornados." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." } }, "security": [ { "session": [] } ], "summary": "Substituir o certificado HTTPS imediatamente" } }, "/api/v1/system/tls/check": { "post": { "description": "Somente sessão de navegador do administrador da plataforma. Chaves API de gerenciamento e proprietários de tenants são rejeitados. Verifica formato, força e correspondência da chave, nome do host, validade e cadeia de confiança. HTTPS direto deve estar habilitado. O certificado ativo não muda.", "operationId": "post__api_v1_system_tls_check", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TLSCertificateInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TLSCertificateInfo" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso; apenas metadados públicos do certificado são retornados." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code. TLS_KEY_MISMATCH, TLS_DOMAIN_MISMATCH, TLS_EXPIRED, TLS_CHAIN_UNTRUSTED e TLS_SETTINGS_CONFLICT mantêm o certificado anterior." } }, "security": [ { "session": [] } ], "summary": "Validar certificado e chave privada sem salvar" } }, "/api/v1/system/translation": { "get": { "description": "Somente sessão de administrador da plataforma.", "operationId": "get__api_v1_system_translation", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TranslationSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Ler configurações DeepL sem expor a chave API" }, "patch": { "description": "Somente sessão de administrador da plataforma. Use expected_version do GET mais recente. A chave nunca é retornada.", "operationId": "patch__api_v1_system_translation", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranslationSettingsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TranslationSettings" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Salvar configurações DeepL criptografadas" } }, "/api/v1/system/translation/check": { "post": { "description": "Chama apenas endpoints de idiomas e uso DeepL; nenhum conteúdo do fórum é enviado.", "operationId": "post__api_v1_system_translation_check", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/TranslationCheck" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte error.code e error.message; request_id identifica a solicitação." } }, "security": [ { "session": [] } ], "summary": "Verificar a chave API salva e obter idiomas suportados e uso" } }, "/api/v1/system/users": { "get": { "description": "Somente sessão de administrador da plataforma. Inclui contas não verificadas e membros da equipe; nunca retorna hashes ou tokens de autenticação.", "operationId": "get__api_v1_system_users", "parameters": [ { "description": "Correspondência parcial de e-mail, nome ou workspace sem diferenciar maiúsculas; caracteres curinga são escapados.", "in": "query", "name": "q", "schema": { "maxLength": 254, "type": "string" } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "disabled" ], "type": "string" } }, { "in": "query", "name": "role", "schema": { "enum": [ "owner", "read_only" ], "type": "string" } }, { "in": "query", "name": "verified", "schema": { "enum": [ "true", "false" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformUserList" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar todos os usuários registrados" } }, "/api/v1/system/users/export.csv": { "get": { "description": "Somente sessão de administrador da plataforma. Máximo 10000 registros correspondentes, UTF-8 BOM e escape de fórmulas de planilha. Sem credenciais.", "operationId": "get__api_v1_system_users_export_csv", "parameters": [ { "description": "Correspondência parcial de e-mail, nome ou workspace sem diferenciar maiúsculas; caracteres curinga são escapados.", "in": "query", "name": "q", "schema": { "maxLength": 254, "type": "string" } }, { "in": "query", "name": "status", "schema": { "enum": [ "active", "disabled" ], "type": "string" } }, { "in": "query", "name": "role", "schema": { "enum": [ "owner", "read_only" ], "type": "string" } }, { "in": "query", "name": "verified", "schema": { "enum": [ "true", "false" ], "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "schema": { "type": "string" } } }, "description": "Anexo CSV" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Exportar usuários registrados filtrados como CSV" } }, "/api/v1/system/users/{id}": { "get": { "description": "Somente sessão de administrador da plataforma. Saldos do workspace, os últimos 20 contratos e totais cumulativos pagos/reembolsados via PayPal são separados por moeda e ambiente.", "operationId": "get__api_v1_system_users__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformUserDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler detalhes do cliente e workspace" }, "patch": { "description": "Somente sessão de administrador da plataforma. Exige motivo da operação e versão otimista. Desativar revoga sessões, chaves e links de login existentes. Restaurar não restaura chaves. Contas de administrador da plataforma são protegidas.", "operationId": "patch__api_v1_system_users__id_", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUserUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformUserDetail" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Atualizar estado do cliente ou nota administrativa privada" } }, "/api/v1/system/users/{id}/data-export": { "post": { "description": "Disponível após o fechamento da conta e após o prazo do cliente. Exige senha do administrador, escopo e motivo operacional auditado. Nenhum registro comercial é apagado.", "operationId": "post__api_v1_system_users__id__data_export", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDataExportInput" } } }, "required": true }, "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Exportar registros de clientes retidos", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/system/users/{id}/revoke-credentials": { "post": { "description": "Somente sessão de administrador da plataforma. Não desativa a conta; o cliente pode entrar novamente. Credenciais de administrador não podem ser revogadas aqui.", "operationId": "post__api_v1_system_users__id__revoke_credentials", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformReason" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformRevocation" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Revogar sessões e chaves API existentes do cliente" } }, "/api/v1/system/waffo": { "get": { "operationId": "get__api_v1_system_waffo", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoSettings" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Ler configurações Waffo sem chave de assinatura", "x-licentivo-access": "platform" }, "patch": { "operationId": "patch__api_v1_system_waffo", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaffoSettingsInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoSettings" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Salvar credenciais Waffo criptografadas", "x-licentivo-access": "platform" } }, "/api/v1/system/waffo/check": { "post": { "operationId": "post__api_v1_system_waffo_check", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoCheck" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Verificar credenciais Waffo e produto único ativo", "x-licentivo-access": "platform" } }, "/api/v1/system/waffo/orders": { "get": { "operationId": "get__api_v1_system_waffo_orders", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoOrderList" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Listar pagamentos de serviços e recargas de carteira Waffo", "x-licentivo-access": "platform" } }, "/api/v1/system/waffo/orders/{id}/reconcile": { "post": { "operationId": "post__api_v1_system_waffo_orders__id__reconcile", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/WaffoOrderResult" }, "request_id": { "description": "Identificador local do pagamento de serviço.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Recuperar e reconciliar pagamento Waffo original", "x-licentivo-access": "platform" } }, "/api/v1/system/workspaces/{id}/status": { "patch": { "description": "Somente sessão de administrador da plataforma. A suspensão bloqueia login, API de gerenciamento e licenciamento online e revoga credenciais. A expiração do contrato continua correndo. Workspaces da plataforma são protegidos; caches offline assinados continuam sujeitos à sua expiração existente.", "operationId": "patch__api_v1_system_workspaces__id__status", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformWorkspaceUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/PlatformWorkspaceStatus" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Inspecione error.code e error.message." } }, "security": [ { "session": [] } ], "summary": "Suspender ou restaurar todo um workspace de cliente" } }, "/api/v1/system/{provider}/orders/{id}/refund": { "post": { "description": "Sessão de administrador da plataforma. Serviço pago exige cancelamento. Pagamento não aplicado é reembolsado sem movimentações na carteira. request_id estável persiste a intenção antes da chamada ao gateway; resultados desconhecidos são consultados e nunca reenviados cegamente.", "operationId": "post__api_v1_system__provider__orders__id__refund", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "provider", "required": true, "schema": { "enum": [ "waffo", "paddle" ], "type": "string" } }, { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OriginalRefundInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/OriginalRefundResult" }, "request_id": { "format": "uuid", "type": "string" } }, "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Erro de validação, titularidade, ambiente, estado do reembolso ou provedor" } }, "security": [ { "session": [] } ], "summary": "Iniciar reembolso pelo canal original para crédito não gasto ou pagamento não aplicado", "x-platform-admin": true, "x-required-role": "owner" } }, "/api/v1/usage": { "get": { "description": "O mês atual informa registros ativos de dispositivos; meses passados mostram o histórico registrado. As cotas de API dos pacotes comprados seguem seus próprios meses de cota. O histórico permanece após a liberação do dispositivo. Ocupação atual e picos de faturamento são medidas distintas.", "operationId": "get_api_v1_usage", "parameters": [ { "description": "Mês civil UTC; padrão é o atual", "in": "query", "name": "month", "schema": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "pattern": "^[0-9]{4}-[0-9]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "active_devices": 0, "api_calls": 0, "api_period": null, "billable_devices": 0, "estimated_total_cents": 0, "estimated_total_micros": 0, "month": "2026-09", "operations": [], "overage_devices": 0, "period": null, "products": [], "purchased": null, "purchased_active_devices": 0, "sandbox": false, "timezone": "UTC", "warning": "normal" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Usage", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "503": { "content": { "application/json": { "example": { "error": { "code": "DEFAULT_PLAN_DISABLED", "message": "The default allowance plan has not been enabled by the administrator" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Franquia padrão desativada (DEFAULT_PLAN_DISABLED)" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Current device occupancy, historical device use and metered API usage", "x-management-reference": { "group": "usage" }, "x-required-scope": "read" } }, "/api/v1/usage/devices": { "get": { "description": "Registros de uso de dispositivos no mês UTC escolhido, conservados após sua liberação. É histórico de atividade, não lista de dispositivos online. Use GET /api/v1/usage para a ocupação atual.", "operationId": "get_api_v1_usage_devices", "parameters": [ { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } }, { "description": "Mês civil UTC; padrão é o atual", "in": "query", "name": "month", "schema": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "pattern": "^[0-9]{4}-[0-9]{2}$", "type": "string" } }, { "in": "query", "name": "product_id", "schema": { "description": "UUID do produto no espaço de trabalho atual.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": [ { "device_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "first_seen_at": "2026-09-01T00:00:00Z", "last_seen_at": "2026-09-30T00:00:00Z", "month": "2026-09", "product_id": "11111111-1111-4111-8111-111111111111" } ], "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/UsageDeviceList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar dispositivos com uso", "x-management-reference": { "group": "usage" }, "x-required-scope": "read" } }, "/api/v1/usage/export.csv": { "get": { "description": "Registros de uso de dispositivos no mês UTC escolhido, conservados após sua liberação. É histórico de atividade, não lista de dispositivos online. Use GET /api/v1/usage para a ocupação atual.", "operationId": "get_api_v1_usage_export_csv", "parameters": [ { "description": "Mês civil UTC; padrão é o atual", "in": "query", "name": "month", "schema": { "description": "Mês UTC YYYY-MM; valores de consulta omitidos usam o mês atual. Tarefas de faturamento exigem um mês encerrado.", "pattern": "^[0-9]{4}-[0-9]{2}$", "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "month,product_id,device_id,first_seen_utc,last_seen_utc\n", "schema": { "type": "string" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Exportar uso", "x-csv-columns": [ "month", "product_id", "device_id", "first_seen_utc", "last_seen_utc" ], "x-management-reference": { "group": "usage" }, "x-required-scope": "read" } }, "/api/v1/validate": { "post": { "description": "Autenticação por product_id + license_key + device_id, sem cookie, CSRF ou chave administrativa do fornecedor. activation_id é obrigatório, exceto em activate. Cada requisição bem-sucedida consome uma chamada de API; replay idempotente e falhas não consomem. Excedentes debitam a carteira atomicamente ou retornam API_QUOTA_EXCEEDED/API_BALANCE_INSUFFICIENT. Recibos de repetição de validação e heartbeat expiram após 3600 segundos. Enquanto a autorização original permanecer válida, requisições correspondentes nessa janela recuperam o resultado sem novo débito. Após a janela, use nova chave; uma chave antiga já usada pode ser tratada como nova requisição. Recibos de ativação, desativação e consumo de funcionalidades permanecem duráveis. A cota de dispositivos acompanha as ativações atuais. Liberar devolve capacidade; expirar um lease flutuante também devolve, mas um registro comum offline continua contado. Só há cobrança de excedente de dispositivos quando o pico do mês da cota cresce além da capacidade já paga; liberar não reembolsa custos incorridos. O uso da API é separado.", "operationId": "post_api_v1_validate", "parameters": [ { "description": "Gere uma nova chave para cada operação; nas tentativas, mantenha chave e corpo iguais. Máximo de 80 caracteres, sem espaços em branco. Opcional para validação e heartbeat.", "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "maxLength": 80, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/RuntimeResult" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Validar em runtime" } }, "/api/v1/webhook-deliveries/{id}/attempts": { "get": { "operationId": "get_api_v1_webhook-deliveries_by_id_attempts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": null }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/AttemptList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar tentativas de entrega", "x-management-reference": { "group": "webhooks" }, "x-required-scope": "read" } }, "/api/v1/webhook-deliveries/{id}/retry": { "post": { "operationId": "post_api_v1_webhook-deliveries_by_id_retry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": {}, "schema": { "$ref": "#/components/schemas/Empty" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ID", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Repetir entrega de webhook", "x-management-reference": { "group": "webhooks" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/webhooks": { "get": { "operationId": "get_api_v1_webhooks", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "data": { "event_types": [], "items": [ { "created_at": "2026-10-18T00:00:00Z", "enabled": true, "events": [], "id": "33333333-3333-4333-8333-333333333333", "name": "Report app", "updated_at": "2026-10-18T00:00:00Z", "url": "https://merchant.example.com/license-events" } ] }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicensingWebhookList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar webhooks", "x-management-reference": { "group": "webhooks" }, "x-required-scope": "read" }, "post": { "operationId": "post_api_v1_webhooks", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "enabled": true, "events": [ "license.created", "license.renewed" ], "name": "Order system", "url": "https://merchant.example.com/license-events" }, "schema": { "$ref": "#/components/schemas/LicensingWebhookInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "data": { "id": "33333333-3333-4333-8333-333333333333", "secret": "whsec_BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicensingWebhookSecret", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Salvar webhook", "x-management-reference": { "group": "webhooks" }, "x-required-role": "owner", "x-required-scope": "write" } }, "/api/v1/webhooks/{id}/deliveries": { "get": { "operationId": "get_api_v1_webhooks_by_id_deliveries", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "ID único deste recurso; use o ID do recurso correspondente no caminho.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "description": "Tamanho da página, padrão 25, intervalo 1–100.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "description": "Registros a ignorar, padrão 0, intervalo 0–100000; some limit para a próxima página.", "maximum": 100000, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": { "items": null, "limit": 25, "offset": 0, "total": 1 }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/DeliveryList", "description": "Resultado de negócio no sucesso; falhas usam error." }, "request_id": { "description": "UUID de rastreamento HTTP no nível superior. Em entradas de lote ou integração, é um UUID de idempotência gerado pelo chamador; as finalidades são distintas.", "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "example": { "error": { "code": "INVALID_INPUT", "message": "Invalid request fields" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "example": { "error": { "code": "UNAUTHENTICATED", "message": "Please sign in again" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "example": { "error": { "code": "FORBIDDEN", "message": "This operation requires an owner account" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "example": { "error": { "code": "NOT_FOUND", "message": "Resource not found" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "example": { "error": { "code": "METHOD_NOT_ALLOWED", "message": "Method not allowed" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "example": { "error": { "code": "CONFLICT", "message": "This value already exists" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "example": { "error": { "code": "JSON_REQUIRED", "message": "Use Content-Type: application/json" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "example": { "error": { "code": "RATE_LIMITED", "message": "Too many attempts; try again later" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "example": { "error": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred" }, "request_id": "55555555-5555-4555-8555-555555555555" }, "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [ { "session": [] }, { "managementKey": [] } ], "summary": "Listar entregas de webhook", "x-management-reference": { "group": "webhooks" }, "x-required-scope": "read" } }, "/healthz": { "get": { "operationId": "get_healthz", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Health" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" } }, "security": [], "summary": "Disponibilidade do processo" } }, "/readyz": { "get": { "operationId": "get_readyz", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/Health" }, "request_id": { "format": "uuid", "type": "string" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Consulte docs/error-codes.md; a aplicabilidade depende do endpoint" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Banco de dados indisponível" } }, "security": [], "summary": "Prontidão do banco de dados" } } }, "servers": [ { "url": "https://www.licentivo.com" } ] }