• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/Platforma (platform)/digital
Mais pesquisados:Customização, Tutorial, Documentação

digital

608 views 1 22/10/2018 Atualizado em 09/11/2026 integrador

2.0info: 23.13.0 digital description: O Digital é responsável principalmente pelo controle de contratos e consumo da plataforma. Mantém os contratos dos clientes e seus itens contratados, o vínculo entre produtos, planos e métricas, e a apuração do consumo por métrica, produto e tenant, permitindo comparar o que foi contratado com o que foi consumido, acompanhar a bilhetagem (billing), gerar alertas de consumo e tratar contratos temporários e de avaliação (trial).\nTambém gerencia a criação e a ativação de contas e tenants, incluindo a configuração de ambientes, usuários administradores e autenticação.\nAlém disso, gerencia convites de usuários e a aplicação de papéis, além da configuração de períodos de avaliação, permissões, serviços e templates de e-mail de produtos. x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: digital contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /digital/queries/verifyTicketStatus: post: description: Verifica o status da criação da conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Ticket retornado pela primitiva activateTenant responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/ticketStatus description: Status atual do processo de criação da conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica o status da criação da conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: ticket description: Ticket retornado pela primitiva activateTenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/ticketStatus description: Status atual do processo de criação da conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listInviteDefinitions: post: description: Obtém a lista de definições de convites tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – definitions properties: definitions: type: array items: type: object allOf: – #/definitions/inviteDefinition minimum: 1 description: A lista de definições de convites existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista de definições de convites tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – definitions properties: definitions: type: array items: type: object allOf: – #/definitions/inviteDefinition minimum: 1 description: A lista de definições de convites existentes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getInviteDefinition: post: description: Obtém uma definição de um convite, identificado pela URI passada como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – URIInvite properties: URIInvite: type: string description: URI da definição do convite responses: 200: description: Ok schema: type: object required: – definition properties: definition: type: object allOf: – #/definitions/inviteDefinition description: A definição do convite selecionado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém uma definição de um convite, identificado pela URI passada como parâmetro tags: – Queries x-senior-visibility: PUBLIC parameters: – name: URIInvite description: URI da definição do convite in: query required: true type: string responses: 200: description: Ok schema: type: object required: – definition properties: definition: type: object allOf: – #/definitions/inviteDefinition description: A definição do convite selecionado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listProducts: post: description: API DEPRECIADA: Deprecated. Replaced by `listFacadeProduct`. | DATA: 2025-01-17 | Retorna uma lista com todos os produtos tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Índice do primeiro produto retornado. O padrão é 0 limit: type: integer format: int64 description: Quantidade máxima de produtos retornados. O padrão é 10 filter: type: string description: Lista os produtos que contenham este texto no nome. Se não for informado, lista todos responses: 200: description: Ok schema: type: object required: – products – total properties: products: type: array items: type: object allOf: – #/definitions/productFacade minimum: 1 description: Lista contendo os produtos conforme solicitado total: type: integer format: int64 description: Quantidade total de produtos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Replaced by `listFacadeProduct`. | DATA: 2025-01-17 | Retorna uma lista com todos os produtos tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: offset description: Índice do primeiro produto retornado. O padrão é 0 in: query type: integer format: int64 – name: limit description: Quantidade máxima de produtos retornados. O padrão é 10 in: query type: integer format: int64 – name: filter description: Lista os produtos que contenham este texto no nome. Se não for informado, lista todos in: query type: string responses: 200: description: Ok schema: type: object required: – products – total properties: products: type: array items: type: object allOf: – #/definitions/productFacade minimum: 1 description: Lista contendo os produtos conforme solicitado total: type: integer format: int64 description: Quantidade total de produtos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getDomains: post: description: Retorna os domínios cadastrados no catálogo de serviços tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: Lista de domínios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os domínios cadastrados no catálogo de serviços tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: Lista de domínios 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getActiveCustomerList: post: description: Retorna uma lista com os dados dos clientes digitais tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – page – limit – productAcronym properties: page: type: integer format: int64 description: Número da página que será retornada. O padrão é 0 limit: type: integer format: int64 description: Quantidade máxima de registros por página. O padrão é 10 productAcronym: type: string description: Acrônimo do produto customerName: type: string description: Nome do cliente startDate: type: string format: date-time description: Data em que o cliente se inscreveu para testar um produto digital endDate: type: string format: date-time description: Data de término do período de trial responses: 200: description: Ok schema: type: object required: – totalRecords – customers properties: totalRecords: type: integer format: int64 description: Quantidade total de clientes encontrados customers: type: array items: type: object allOf: – #/definitions/digitalCustomer minimum: 1 description: Clientes do produto digital com seus dados de consumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os dados dos clientes digitais tags: – Queries x-senior-visibility: PUBLIC parameters: – name: page description: Número da página que será retornada. O padrão é 0 in: query required: true type: integer format: int64 – name: limit description: Quantidade máxima de registros por página. O padrão é 10 in: query required: true type: integer format: int64 – name: productAcronym description: Acrônimo do produto in: query required: true type: string – name: customerName description: Nome do cliente in: query type: string – name: startDate description: Data em que o cliente se inscreveu para testar um produto digital in: query type: string format: date-time – name: endDate description: Data de término do período de trial in: query type: string format: date-time responses: 200: description: Ok schema: type: object required: – totalRecords – customers properties: totalRecords: type: integer format: int64 description: Quantidade total de clientes encontrados customers: type: array items: type: object allOf: – #/definitions/digitalCustomer minimum: 1 description: Clientes do produto digital com seus dados de consumo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getServices: post: description: Lista todos os serviços tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – domains properties: domains: type: array items: type: string minimum: 1 description: Domínios cujos serviços serão listados responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/serviceDef minimum: 1 description: Serviços dos domínios informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getPrimitives: post: description: Lista as primitivas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/serviceDef minimum: 1 description: Serviços cujas primitivas serão listadas responses: 200: description: Ok schema: type: object required: – primitives properties: primitives: type: array items: type: object allOf: – #/definitions/primitiveDef minimum: 1 description: Primitivas dos serviços informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductInvitationRoles: post: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2021-01-21 | Retorna os papéis associados ao período de avaliação (trial) do produto tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productAcronym properties: productAcronym: type: string description: Acrônimo do produto responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/digitalRole minimum: 1 description: Papéis associados ao período de avaliação do produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2021-01-21 | Retorna os papéis associados ao período de avaliação (trial) do produto tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: productAcronym description: Acrônimo do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/digitalRole minimum: 1 description: Papéis associados ao período de avaliação do produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getDefaultPlan: post: description: Retorna o plano padrão do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Id do produto responses: 200: description: Ok schema: type: object required: – plan properties: plan: type: object allOf: – #/definitions/planDefinition description: Plano padrão do produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o plano padrão do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – plan properties: plan: type: object allOf: – #/definitions/planDefinition description: Plano padrão do produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getContractsEnable: post: description: Retorna os contratos ativos do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant productAcronyms: type: array items: type: string description: Acrônimo dos produtos responses: 200: description: Ok schema: type: object required: – contracts properties: contracts: type: array items: type: object allOf: – #/definitions/contractWithItems minimum: 1 description: Contratos ativos do tenant com os respectivos itens contratados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionByMetricKey: post: description: API DEPRECIADA: Deprecated. Replaced by `getConsumptionByMetricKey__19`. | DATA: 2026-03-01 | Retorna o consumo da métrica informada para o tenant do contexto da requisição tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metricKey properties: metricKey: type: string description: Chave de identificação que foi cadastrada no contador responses: 200: description: Ok schema: type: object required: – metricOfPlan – planName – activePlan – currentPlan properties: metricOfPlan: type: object allOf: – #/definitions/metric description: Métrica informada com o consumo apurado no período planName: type: string description: Nome do plano activePlan: type: boolean description: Indica se o plano está ativo currentPlan: type: boolean description: Indica se o plano está vigente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Replaced by `getConsumptionByMetricKey__19`. | DATA: 2026-03-01 | Retorna o consumo da métrica informada para o tenant do contexto da requisição tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: metricKey description: Chave de identificação que foi cadastrada no contador in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metricOfPlan – planName – activePlan – currentPlan properties: metricOfPlan: type: object allOf: – #/definitions/metric description: Métrica informada com o consumo apurado no período planName: type: string description: Nome do plano activePlan: type: boolean description: Indica se o plano está ativo currentPlan: type: boolean description: Indica se o plano está vigente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionByMetricKey__19: post: description: Retorna o consumo da métrica informada para o tenant do contexto da requisição, na versão 19 tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metricKey properties: metricKey: type: string description: Chave de identificação que foi cadastrada no contador responses: 200: description: Ok schema: type: object required: – metricOfPlan properties: metricOfPlan: type: object allOf: – #/definitions/metricConsumption description: Métrica informada com o consumo apurado no período 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o consumo da métrica informada para o tenant do contexto da requisição, na versão 19 tags: – Queries x-senior-visibility: PUBLIC parameters: – name: metricKey description: Chave de identificação que foi cadastrada no contador in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metricOfPlan properties: metricOfPlan: type: object allOf: – #/definitions/metricConsumption description: Métrica informada com o consumo apurado no período 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionByMetricKeys: post: description: API DEPRECIADA: Deprecated. Replaced by `getConsumptionByMetricKeys__19`. | DATA: 2026-03-01 | Retorna o consumo das métricas informadas para o tenant do contexto da requisição tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metricKeys properties: metricKeys: type: array items: type: string minimum: 1 description: Chaves de identificação dos contadores responses: 200: description: Ok schema: type: object required: – metricsOfPlan properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas informadas com o consumo apurado no período 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionByMetricKeys__19: post: description: Retorna o consumo das métricas informadas para o tenant do contexto da requisição, na versão 19 tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – metricKeys properties: metricKeys: type: array items: type: string minimum: 1 description: Chaves de identificação dos contadores responses: 200: description: Ok schema: type: object required: – metricsOfPlan properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metricConsumption minimum: 1 description: Métricas informadas com o consumo apurado no período 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getCompanyByTenant: post: description: API DEPRECIADA: Deprecated. Replaced by `getAccountByTenantName`. | DATA: 2024-08-28 | Busca os dados da empresa pelo nome do tenant tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/companyFacade description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Replaced by `getAccountByTenantName`. | DATA: 2024-08-28 | Busca os dados da empresa pelo nome do tenant tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: tenant description: Nome do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/companyFacade description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getCompany: post: description: API DEPRECIADA: Deprecated. Replaced by `retrieveFacadeCompany`. | DATA: 2025-01-17 | Busca os dados da empresa pelo ID tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/companyFacade description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Replaced by `retrieveFacadeCompany`. | DATA: 2025-01-17 | Busca os dados da empresa pelo ID tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: id description: Id da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/companyFacade description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getNewCustomersNumber: post: description: Retorna a quantidade mensal de clientes cadastrados para o produto nos últimos 12 meses tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productAcronym properties: productAcronym: type: string description: Acrônimo do produto responses: 200: description: Ok schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/customersMonthly minimum: 1 description: Quantidade de clientes cadastrados por mês e ano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade mensal de clientes cadastrados para o produto nos últimos 12 meses tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productAcronym description: Acrônimo do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/customersMonthly minimum: 1 description: Quantidade de clientes cadastrados por mês e ano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getTotalCustomers: post: description: Retorna a quantidade de clientes com base no acrônimo do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productAcronym properties: productAcronym: type: string description: Acrônimo do produto responses: 200: description: Ok schema: type: object required: – total – isNew properties: total: type: integer format: int64 description: Quantidade total de clientes que possuem o produto informado isNew: type: integer format: int64 description: Quantidade de clientes cadastrados nos últimos 15 dias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de clientes com base no acrônimo do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productAcronym description: Acrônimo do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – total – isNew properties: total: type: integer format: int64 description: Quantidade total de clientes que possuem o produto informado isNew: type: integer format: int64 description: Quantidade de clientes cadastrados nos últimos 15 dias 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getPermissions: post: description: Busca as permissões de acesso do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId properties: prodId: type: string description: Id do produto responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/productPermission minimum: 1 description: Permissões de acesso configuradas para o produto informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as permissões de acesso do produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: prodId description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/productPermission minimum: 1 description: Permissões de acesso configuradas para o produto informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getCalls: post: description: Retorna a quantidade de chamadas das primitivas informadas, agrupadas por tenant, a partir do período informado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – primitives – period properties: primitives: type: array items: type: object allOf: – #/definitions/primitiveDef minimum: 1 description: Primitivas (domínio, serviço e nome) que serão consultadas period: type: integer format: int64 description: Quantidade de dias anteriores à data atual que define o início do período consultado responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/call minimum: 1 description: Quantidade de chamadas de cada primitiva, agrupada por tenant, registrada no período consultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getMyProducts: post: description: Retorna os produtos com itens contratados ativos vinculados ao tenant do contexto da requisição tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/myProduct minimum: 1 description: Lista dos produtos contratados pelo tenant do contexto da requisição, com os dados do item contratado e do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os produtos com itens contratados ativos vinculados ao tenant do contexto da requisição tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/myProduct minimum: 1 description: Lista dos produtos contratados pelo tenant do contexto da requisição, com os dados do item contratado e do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getAlerts: post: description: Retorna os alertas de consumo do tenant do contexto da requisição, da data mais recente para a mais antiga tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – limit – page properties: limit: type: integer format: int64 description: Quantidade de alertas por página. Quando não informado, são retornados 5 alertas page: type: integer format: int64 description: Número da página a ser retornada, iniciando em 0. Quando não informado, é retornada a primeira página responses: 200: description: Ok schema: type: object required: – data – total properties: data: type: array items: type: object allOf: – #/definitions/alert minimum: 1 description: Alertas de consumo do tenant referentes à página solicitada total: type: integer format: int64 description: Quantidade total de alertas do tenant, considerando todas as páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os alertas de consumo do tenant do contexto da requisição, da data mais recente para a mais antiga tags: – Queries x-senior-visibility: PUBLIC parameters: – name: limit description: Quantidade de alertas por página. Quando não informado, são retornados 5 alertas in: query required: true type: integer format: int64 – name: page description: Número da página a ser retornada, iniciando em 0. Quando não informado, é retornada a primeira página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – data – total properties: data: type: array items: type: object allOf: – #/definitions/alert minimum: 1 description: Alertas de consumo do tenant referentes à página solicitada total: type: integer format: int64 description: Quantidade total de alertas do tenant, considerando todas as páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/billingLastUpdate: post: description: Retorna a data e a hora do último processamento de bilhetagem (billing) do tenant do contexto da requisição tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – update properties: update: type: string format: date-time description: Data e hora do último processamento de bilhetagem do domínio do tenant. Não é retornada quando não existe processamento registrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a data e a hora do último processamento de bilhetagem (billing) do tenant do contexto da requisição tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – update properties: update: type: string format: date-time description: Data e hora do último processamento de bilhetagem do domínio do tenant. Não é retornada quando não existe processamento registrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/consumption__17: post: description: API DEPRECIADA: Deprecated. Replaced by `consumption__23`. | DATA: 2026-10-01 | Retorna o valor consumido e contratado pelo cliente separando em métricas dentro e fora dos planos tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – contractItemId – month properties: contractItemId: type: string description: Id do item contratado month: type: string format: date-time description: Mês de referência utilizado para calcular o consumo responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan – planName properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano com o consumo apurado no período metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas consumidas que não fazem parte do plano planName: type: string description: Nome do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Replaced by `consumption__23`. | DATA: 2026-10-01 | Retorna o valor consumido e contratado pelo cliente separando em métricas dentro e fora dos planos tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: contractItemId description: Id do item contratado in: query required: true type: string – name: month description: Mês de referência utilizado para calcular o consumo in: query required: true type: string format: date-time responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan – planName properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano com o consumo apurado no período metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas consumidas que não fazem parte do plano planName: type: string description: Nome do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/consumption__23: post: description: Retorna o valor consumido e contratado pelo cliente separando em métricas dentro e fora dos planos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId – month properties: productId: type: string description: Id do produto month: type: string format: date-time description: Mês de referência utilizado para calcular o consumo responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan – planName properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano com o consumo apurado no período metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas consumidas que não fazem parte do plano planName: type: string description: Nome do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o valor consumido e contratado pelo cliente separando em métricas dentro e fora dos planos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Id do produto in: query required: true type: string – name: month description: Mês de referência utilizado para calcular o consumo in: query required: true type: string format: date-time responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan – planName properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano com o consumo apurado no período metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas consumidas que não fazem parte do plano planName: type: string description: Nome do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listPendingLoginCustomers: post: description: Lista os tenants que não tiveram nenhum login, por produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Id do produto period: type: integer format: int64 description: Período (em dias) em que os dados serão buscados default: 30 responses: 200: description: Ok schema: type: object required: – company properties: company: type: array items: type: object allOf: – #/definitions/companyFacade minimum: 1 description: Empresas cujos tenants não registraram login no período informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os tenants que não tiveram nenhum login, por produto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Id do produto in: query required: true type: string – name: period description: Período (em dias) em que os dados serão buscados in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – company properties: company: type: array items: type: object allOf: – #/definitions/companyFacade minimum: 1 description: Empresas cujos tenants não registraram login no período informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listLoggedCustomers: post: description: Lista os clientes que já logaram na plataforma tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Id do produto period: type: integer format: int64 description: Período (em dias) em que os dados serão buscados default: 30 responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companyFacade minimum: 1 description: Empresas cujos tenants registraram login no período informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os clientes que já logaram na plataforma tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Id do produto in: query required: true type: string – name: period description: Período (em dias) em que os dados serão buscados in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/companyFacade minimum: 1 description: Empresas cujos tenants registraram login no período informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getDigitalUrl: post: description: Retorna o nome do host que executa o serviço, utilizado em ambiente de desenvolvimento tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – digitalUrl properties: digitalUrl: type: string description: Nome do host que executa o serviço. Em produção é retornado vazio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome do host que executa o serviço, utilizado em ambiente de desenvolvimento tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – digitalUrl properties: digitalUrl: type: string description: Nome do host que executa o serviço. Em produção é retornado vazio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/updateReportDatabase: post: description: Executa as migrations e atualiza o banco de relatórios do digital (billing) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasError properties: hasError: type: boolean description: Indica se ocorreu erro ao atualizar a base de relatórios reason: type: string description: Motivo do erro, retornado somente quando a atualização falha 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Executa as migrations e atualiza o banco de relatórios do digital (billing) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasError properties: hasError: type: boolean description: Indica se ocorreu erro ao atualizar a base de relatórios reason: type: string description: Motivo do erro, retornado somente quando a atualização falha 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getAccountByTenantName: post: description: Retorna os dados da conta (cliente) vinculada ao tenant informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant utilizado na busca responses: 200: description: Ok schema: type: object required: – id – erpId – identifier – name – status – tenant properties: id: type: string description: Id da conta vinculada ao tenant erpId: type: string description: Id da conta no ERP identifier: type: string description: Documento de identificação do cliente (CNPJ/CPF) name: type: string description: Razão social do cliente status: type: string description: Status da conta, por exemplo A para ativa tenant: type: object allOf: – #/definitions/tenant description: Dados do tenant informado: ambiente, nome e domínio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados da conta (cliente) vinculada ao tenant informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenantName description: Nome do tenant utilizado na busca in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – erpId – identifier – name – status – tenant properties: id: type: string description: Id da conta vinculada ao tenant erpId: type: string description: Id da conta no ERP identifier: type: string description: Documento de identificação do cliente (CNPJ/CPF) name: type: string description: Razão social do cliente status: type: string description: Status da conta, por exemplo A para ativa tenant: type: object allOf: – #/definitions/tenant description: Dados do tenant informado: ambiente, nome e domínio 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductServices: post: description: Retorna os domínios e serviços vinculados ao produto informado pela sigla tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym properties: acronym: type: string description: Sigla do produto responses: 200: description: Ok schema: type: object required: – productServices properties: productServices: type: array items: type: object allOf: – #/definitions/productService minimum: 1 description: Domínios e serviços vinculados ao produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os domínios e serviços vinculados ao produto informado pela sigla tags: – Queries x-senior-visibility: PUBLIC parameters: – name: acronym description: Sigla do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – productServices properties: productServices: type: array items: type: object allOf: – #/definitions/productService minimum: 1 description: Domínios e serviços vinculados ao produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getServicesByProductId: post: description: Retorna os domínios e serviços vinculados ao produto informado pelo id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do produto responses: 200: description: Ok schema: type: object required: – productServices properties: productServices: type: array items: type: object allOf: – #/definitions/productService minimum: 1 description: Domínios e serviços vinculados ao produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os domínios e serviços vinculados ao produto informado pelo id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – productServices properties: productServices: type: array items: type: object allOf: – #/definitions/productService minimum: 1 description: Domínios e serviços vinculados ao produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listMachineStates: post: description: Lista os estados da máquina tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: onlyUnfinished: type: boolean description: Listar apenas máquinas que não estão com o status FIM e nem REGISTRADO default: false responses: 200: description: Ok schema: type: object required: – machines properties: machines: type: array items: type: object allOf: – #/definitions/machine minimum: 1 description: Máquinas de estado encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os estados da máquina tags: – Queries x-senior-visibility: PUBLIC parameters: – name: onlyUnfinished description: Listar apenas máquinas que não estão com o status FIM e nem REGISTRADO in: query type: boolean responses: 200: description: Ok schema: type: object required: – machines properties: machines: type: array items: type: object allOf: – #/definitions/machine minimum: 1 description: Máquinas de estado encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/topConsumptions: post: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2025-12-15 | Retorna os clientes que estão extrapolando o consumo definido do plano tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId properties: prodId: type: string description: Id do produto responses: 200: description: Ok schema: type: object required: – customers properties: customers: type: array items: type: object allOf: – #/definitions/customerConsumption minimum: 1 description: Consumo de cada cliente que excedeu o limite do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2025-12-15 | Retorna os clientes que estão extrapolando o consumo definido do plano tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: prodId description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – customers properties: customers: type: array items: type: object allOf: – #/definitions/customerConsumption minimum: 1 description: Consumo de cada cliente que excedeu o limite do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductsConsumption: post: description: Retorna de forma paginada o consumo dos produtos ativos com contrato habilitado e item contratado vigente para o tenant atual. Produtos configurados como Apenas tenants selecionados somente são incluídos quando existe vínculo explícito com o tenant; produtos configurados como Todos os tenants não exigem esse vínculo. A paginação considera somente os produtos visíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getProductConsumption responses: 200: description: Ok schema: type: object allOf: – #/definitions/productConsumption 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada o consumo dos produtos ativos com contrato habilitado e item contratado vigente para o tenant atual. Produtos configurados como Apenas tenants selecionados somente são incluídos quando existe vínculo explícito com o tenant; produtos configurados como Todos os tenants não exigem esse vínculo. A paginação considera somente os produtos visíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string – name: month description: Mês do consumo. Quando não informado, é utilizado o período de faturamento vigente in: query type: string format: date responses: 200: description: Ok schema: type: object allOf: – #/definitions/productConsumption 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductGroup: post: description: Retorna, agrupados por linha de produto, os produtos ativos com contrato habilitado e item contratado vigente para o tenant atual. Produtos configurados como Apenas tenants selecionados somente são retornados quando existe vínculo explícito com o tenant; produtos configurados como Todos os tenants não exigem esse vínculo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/productGroupFacade minimum: 1 description: Linhas de produto e seus produtos ativos, contratados e visíveis para o tenant atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna, agrupados por linha de produto, os produtos ativos com contrato habilitado e item contratado vigente para o tenant atual. Produtos configurados como Apenas tenants selecionados somente são retornados quando existe vínculo explícito com o tenant; produtos configurados como Todos os tenants não exigem esse vínculo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/productGroupFacade minimum: 1 description: Linhas de produto e seus produtos ativos, contratados e visíveis para o tenant atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionAllTenants: post: description: Retorna, de forma paginada, os limites contratados e o consumo das métricas por tenant, cliente e produto no mês de referência. Permite filtrar por nomes de tenants e IDs ERP de clientes e produtos. Quando o mês não é informado, utiliza o mês atual tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getConsumptionAllTenant responses: 200: description: Ok schema: type: object allOf: – #/definitions/consumptionAllTenants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/tenantsAvailableToProduct: post: description: Retorna de forma paginada os tenants com contrato habilitado e item contratado vigente que ainda podem ser vinculados a um produto configurado como Apenas tenants selecionados. Para produtos configurados como Todos os tenants, retorna uma página vazia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getLinkedTenants responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantsByProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada os tenants com contrato habilitado e item contratado vigente que ainda podem ser vinculados a um produto configurado como Apenas tenants selecionados. Para produtos configurados como Todos os tenants, retorna uma página vazia tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string – name: productId description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantsByProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/tenantsAvailableToProducts: post: description: Retorna, para cada produto informado, os tenants com contrato habilitado e item contratado vigente que ainda podem ser vinculados ao produto, quando ele está configurado como Apenas tenants selecionados. Para produtos configurados como Todos os tenants, retorna uma página vazia. A paginação e o filtro informados são aplicados individualmente a cada produto e o campo orderby não é utilizado. Os ids informados que não correspondem a nenhum produto são retornados em notFoundProductIds, sem interromper a consulta dos demais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getLinkedTenantsByProducts responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantsByProducts 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/tenantsLinkedToProduct: post: description: Retorna de forma paginada os tenants explicitamente vinculados a um produto configurado como Apenas tenants selecionados. Para produtos configurados como Todos os tenants, retorna uma página vazia. A consulta representa os vínculos cadastrados e não valida se o tenant possui contrato ativo para o produto. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getLinkedTenants responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantsByProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada os tenants explicitamente vinculados a um produto configurado como Apenas tenants selecionados. Para produtos configurados como Todos os tenants, retorna uma página vazia. A consulta representa os vínculos cadastrados e não valida se o tenant possui contrato ativo para o produto. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string – name: productId description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantsByProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getContractDetails: post: description: Retorna de forma paginada os detalhes consolidados dos contratos para uso da TIC. A página pode conter até 1.000 registros, e a visão materializada é atualizada quando a última atualização ocorreu há seis horas ou mais. Os campos filter e orderby não são utilizados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pageRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/contractDetailsResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada os detalhes consolidados dos contratos para uso da TIC. A página pode conter até 1.000 registros, e a visão materializada é atualizada quando a última atualização ocorreu há seis horas ou mais. Os campos filter e orderby não são utilizados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/contractDetailsResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getMetricsByItem: post: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2026-10-07 | Retorna as métricas vinculadas a um item contratado tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractItemId properties: contractItemId: type: string description: Id do item contratado responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas vinculadas ao item contratado informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2026-10-07 | Retorna as métricas vinculadas a um item contratado tags: – Queries deprecated : true x-senior-visibility: PRIVATE parameters: – name: contractItemId description: Id do item contratado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas vinculadas ao item contratado informado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getContractedMetricsByProduct: post: description: Retorna, sem duplicidade, as métricas vinculadas aos planos dos itens contratados do produto informado para o tenant atual. A consulta não considera a habilitação ou a vigência dos contratos, nem a vigência dos itens contratados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Id do produto responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas contratadas do produto informado para o tenant do contexto da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna, sem duplicidade, as métricas vinculadas aos planos dos itens contratados do produto informado para o tenant atual. A consulta não considera a habilitação ou a vigência dos contratos, nem a vigência dos itens contratados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: productId description: Id do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas contratadas do produto informado para o tenant do contexto da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionAlerts: post: description: Retorna de forma paginada os alertas de consumo cujos produtos estão visíveis para o tenant atual. Produtos configurados como Apenas tenants selecionados exigem vínculo explícito com o tenant; produtos configurados como Todos os tenants não exigem esse vínculo. A paginação considera somente os produtos visíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/pageRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/getConsumptionAlertsResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada os alertas de consumo cujos produtos estão visíveis para o tenant atual. Produtos configurados como Apenas tenants selecionados exigem vínculo explícito com o tenant; produtos configurados como Todos os tenants não exigem esse vínculo. A paginação considera somente os produtos visíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/getConsumptionAlertsResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getGroupsAndContacts: post: description: Retorna de forma paginada os grupos de produtos com seus contatos. Quando o ID do grupo é informado, retorna somente o grupo correspondente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/groupsAndContacts responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: object allOf: – #/definitions/groupsAndContactsResponse description: Resultado paginado dos grupos de produtos e seus contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada os grupos de produtos com seus contatos. Quando o ID do grupo é informado, retorna somente o grupo correspondente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string – name: groupId description: Id do grupo de produtos, no formato UUID. Quando não informado, retorna todos os grupos in: query type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: object allOf: – #/definitions/groupsAndContactsResponse description: Resultado paginado dos grupos de produtos e seus contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductMetricInfoByTenant: post: description: Retorna informações e limite contratado de um produto e métrica do tenant informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productErpId – metricKey – tenant properties: productErpId: type: string description: ErpId do produto metricKey: type: string description: Chave da métrica tenant: type: string description: Nome do tenant cujo limite contratado será consultado responses: 200: description: Ok schema: type: object allOf: – #/definitions/productMetricInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações e limite contratado de um produto e métrica do tenant informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: productErpId description: ErpId do produto in: query required: true type: string – name: metricKey description: Chave da métrica in: query required: true type: string – name: tenant description: Nome do tenant cujo limite contratado será consultado in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/productMetricInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getMetricsToLinkProduct: post: description: Retorna de forma paginada as métricas que ainda não estão vinculadas ao produto, excluindo as métricas padrão do sistema tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/metricsToLinkProduct responses: 200: description: Ok schema: type: object allOf: – #/definitions/metricsToLinkProductResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna de forma paginada as métricas que ainda não estão vinculadas ao produto, excluindo as métricas padrão do sistema tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Índice da página, iniciando em 0 in: query type: integer format: int64 – name: size description: Quantidade de registros retornados por página in: query type: integer format: int64 – name: orderby description: Ordenação aplicada à consulta in: query type: string – name: filter description: Filtro aplicado à consulta in: query type: string – name: productId description: Id do produto ao qual as métricas serão vinculadas in: query required: true type: string – name: metric description: Chave ou parte do nome da métrica utilizada como filtro in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/metricsToLinkProductResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getContractedNamedUsersMetrics: post: description: Retorna os produtos contratados do tenant atual e suas métricas, filtrando apenas aquelas que controlam usuários nomeados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – productWithMetrics properties: productWithMetrics: type: array items: type: object allOf: – #/definitions/productWithMetrics minimum: 1 description: Produtos contratados pelo tenant e suas métricas que controlam usuários nomeados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os produtos contratados do tenant atual e suas métricas, filtrando apenas aquelas que controlam usuários nomeados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – productWithMetrics properties: productWithMetrics: type: array items: type: object allOf: – #/definitions/productWithMetrics minimum: 1 description: Produtos contratados pelo tenant e suas métricas que controlam usuários nomeados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getTenantEnvInfo: post: description: Retorna o ambiente do tenant e seus produtos contratados com métricas de usuários nomeados. O tenant informado deve ser o mesmo do contexto da requisição, exceto quando a consulta é realizada pelo tenant senior tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantEnvInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o ambiente do tenant e seus produtos contratados com métricas de usuários nomeados. O tenant informado deve ser o mesmo do contexto da requisição, exceto quando a consulta é realizada pelo tenant senior tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenantName description: Nome do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantEnvInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/activateTenant: post: description: Inicia a criação da conta e a configuração do tenant a partir do token recebido por e-mail. O processamento segue de forma assíncrona tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – token properties: token: type: string description: Token recebido por e-mail responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket para consultar o status da criação da conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createAccount: post: description: API DEPRECIADA: Deprecated. Replaced by `createAccount__14`. | DATA: 2024-04-11 | Cria uma conta temporária até a confirmação do e-mail tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – firstName – lastName – businessEmail – password – companyName – companyPhone – product properties: erpId: type: string description: Id do cliente no ERP firstName: type: string description: Nome do usuário lastName: type: string description: Sobrenome do usuário businessEmail: type: string description: E-mail corporativo password: type: string description: Senha do usuário companyName: type: string maxLength: 80 description: Nome da empresa companyPhone: type: string maxLength: 25 description: Telefone da empresa cnpj: type: string maxLength: 50 description: Cadastro nacional da pessoa jurídica tenantDomain: type: string maxLength: 32 description: Domínio do tenant que será utilizado, se não for o mesmo que o domínio do e-mail do cadastro, será adicionado o sufixo .seniorx. baseUrl: type: string description: URL base utilizada para montar o link de ativação enviado por e-mail default: https://platform.senior.com.br locale: type: string description: Locale do navegador default: pt-BR product: type: string description: Sigla do produto responses: 200: description: Ok schema: type: object required: – ok – tenantName – tenantDomain properties: ok: type: boolean description: Indica que a conta temporária foi criada tenantName: type: string description: Nome do tenant da empresa tenantDomain: type: string description: Domínio do tenant da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createAccount__14: post: description: Cria uma conta temporária até a confirmação do e-mail, na versão 14 tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – firstName – lastName – businessEmail – password – companyName – companyPhone – product properties: erpId: type: string description: Id do cliente no ERP firstName: type: string description: Nome do usuário lastName: type: string description: Sobrenome do usuário businessEmail: type: string description: E-mail corporativo password: type: string description: Senha do usuário companyName: type: string maxLength: 80 description: Nome da empresa companyPhone: type: string maxLength: 25 description: Telefone da empresa cnpj: type: string maxLength: 50 description: Cadastro nacional da pessoa jurídica tenantDomain: type: string maxLength: 32 description: Domínio do tenant que será utilizado, se não for o mesmo que o domínio do e-mail do cadastro, será adicionado o sufixo .seniorx. baseUrl: type: string description: URL base utilizada para montar o link de ativação enviado por e-mail default: https://platform.senior.com.br locale: type: string description: Locale do navegador default: pt-BR product: type: string description: Sigla do produto responses: 200: description: Ok schema: type: object required: – ok – tenantName – tenantDomain properties: ok: type: boolean description: Indica que a conta temporária foi criada tenantName: type: string description: Nome da empresa tenantDomain: type: string description: Domínio da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createTenant: post: description: Serviço para criar tenants tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name – domain – administrators – environments – product properties: name: type: string maxLength: 80 description: Nome da empresa domain: type: string description: Domínio da empresa administrators: type: array items: type: object allOf: – #/definitions/administrator minimum: 1 description: Administradores responsáveis pelo tenant. Quando o ambiente exige confirmação por e-mail, são necessários no mínimo dois administradores com e-mail do domínio informado environments: type: array items: type: object allOf: – #/definitions/environment minimum: 1 description: Ambientes que serão criados (Produção, Homologação, Demonstração ou Desenvolvimento) product: type: string description: Sigla do produto digital baseUrl: type: string description: URL base utilizada para montar o link de ativação enviado por e-mail default: https://platform.senior.com.br password: type: string description: Senha para o tenant secret: true anyDocument: type: string maxLength: 50 description: Documento de identificação Pessoa Física/Pessoa Jurídica, exemplo: (CPF/CNPJ) e/ou estrangeiras (SSN/NIT/TIN/RFC/Passaporte) etc. integrationCode: type: string maxLength: 100 description: Código de identificação do cliente. O código é do tipo string para permitir a integração com outros sistemas locale: type: string description: Definir o idioma inicial do tenant e dos administradores, se não informado o valor padrão será pt-BR default: pt-BR responses: 200: description: Ok schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Tenants que serão criados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/easyTenant: post: description: Serviço para criar tenants para consultores tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – clientId – companyName – tenantDomain – authType properties: clientId: type: integer format: int64 description: Código do cliente companyName: type: string description: Nome da empresa tenantDomain: type: string description: Domínio da empresa authType: type: integer format: int64 description: Tipo de autenticação: 0 para G7, 1 para nativa G5, 2 para LDAP apenas autenticação, 3 para LDAP com usuários sincronizados e 4 para SAML message: type: string description: Mensagem que será enviada por e-mail para a Senior TI responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o tenant para consultores foi criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setProductTrial: post: description: Configura o período de avaliação de um produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym – allowTrial – trialDays properties: acronym: type: string description: Sigla do produto allowTrial: type: boolean description: Indica se o produto suporta período de avaliação (trial) trialDays: type: integer format: int64 description: Quantidade de dias de duração do período de avaliação (trial) do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o período de avaliação do produto foi configurado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/getBundles: post: description: Retorna os bundles do translationHub tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym properties: locale: type: string description: Idioma dos templates. Quando não existe tradução para o idioma informado, são retornados os templates padrão acronym: type: string description: Sigla do produto responses: 200: description: Ok schema: type: object required: – bundles properties: bundles: type: array items: type: object allOf: – #/definitions/bundle minimum: 1 description: Assuntos e conteúdos dos templates de e-mail do produto no idioma solicitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateProductCreationTemplates: post: description: Altera os convites de ativação de produtos tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productAcronym – templates properties: productAcronym: type: string description: Sigla do produto templates: type: object allOf: – #/definitions/productCreationTemplates description: Templates de e-mail utilizados na ativação do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os templates de ativação do produto foram atualizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateInviteTemplates: post: description: Altera os convites de novos usuários tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productAcronym – templates properties: productAcronym: type: string description: Sigla do produto templates: type: object allOf: – #/definitions/inviteTemplates description: Templates de e-mail utilizados para convidar usuários para a plataforma responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os templates de convite foram atualizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/restoreDefaultProductEmailTemplates: post: description: Restaura os textos padrão dos templates de e-mail utilizados na ativação de um produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym properties: acronym: type: string description: Sigla do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os templates de ativação do produto foram restaurados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/restoreDefaultInviteEmailTemplates: post: description: Restaura os textos padrão dos templates de e-mail utilizados nos convites de usuários tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym properties: acronym: type: string description: Sigla do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os templates de convite foram restaurados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/inviteUsers: post: description: Convida usuários para a plataforma ou para um produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – URIInvite properties: URIInvite: type: string description: URI do convite newUsers: type: array items: type: string description: E-mails dos usuários que ainda não possuem conta na plataforma. Informe esta lista ou existingUsers existingUsers: type: array items: type: string description: E-mails dos usuários que já possuem conta na plataforma. Informe esta lista ou newUsers message: type: string description: Mensagem do convite baseUrl: type: string description: URL base utilizada para montar o link do convite enviado por e-mail default: https://platform.senior.com.br/login/invite.html?register= responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os convites foram enviados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/refreshInviteDefinitions: post: description: Atualiza a lista de definições dos convites tags: – Actions x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que as definições de convite foram atualizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/validateInvite: post: description: Verifica se o convite é válido tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – token properties: token: type: string description: Token recebido por e-mail responses: 200: description: Ok schema: type: object required: – tenantDomain – tenantName – suggestedUser – emailInvite properties: tenantDomain: type: string description: Domínio associado ao token tenantName: type: string description: Tenant associado ao token suggestedUser: type: string description: Nome do username sugerido pelo serviço de usuários emailInvite: type: string description: E-mail que recebeu o convite 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setUserRole: post: description: Aplica os papéis aos usuários que já possuem conta na plataforma tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – token properties: token: type: string description: Token recebido por e-mail com as informações do usuário e seus papéis responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os papéis foram aplicados ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/activateInvite: post: description: Ativa o convite recebido por e-mail tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – token – name – tenantDomain – tenantName – password – email – login properties: token: type: string description: Token que foi recebido name: type: string description: Nome completo do usuário tenantDomain: type: string description: Domínio que foi retornado da primitiva validateInvite tenantName: type: string description: Tenant que foi retornado da primitiva validateInvite password: type: string description: Senha do usuário email: type: string description: E-mail retornado pela primitiva validateInvite login: type: string description: Username que foi sugerido pelo serviço de usuário responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o convite foi ativado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/applyInvite: post: description: Aplica o convite para o usuário existente na base tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – token – tenantDomain – tenantName – email – login – baseUrl properties: token: type: string description: Token recebido tenantDomain: type: string description: Domínio retornado pela primitiva validateInvite tenantName: type: string description: Tenant retornado pela primitiva validateInvite email: type: string description: E-mail retornado pela primitiva validateInvite login: type: string description: Username do usuário baseUrl: type: string description: URL base utilizada para montar o link do convite enviado por e-mail responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o convite foi aplicado ao usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setInviteRoleList: post: description: Atribui uma lista de ids de papéis a uma definição de convite. Todo usuário que aceitar este convite receberá todos os papéis da lista no seu perfil tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – URIInvite – roles properties: URIInvite: type: string description: URI do convite que receberá a lista roles: type: array items: type: string minimum: 1 description: Lista de ids dos papéis responses: 200: description: Ok schema: type: object required: – idInviteDef properties: idInviteDef: type: string description: Identificador da definição de convite que foi alterada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateProductInvitationRoles: post: description: API DEPRECIADA: Deprecated. Operação descontinuada. | DATA: 2021-01-21 | Atualiza os papéis que estão associados ao trial do produto tags: – Actions deprecated : true x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productAcronym properties: productAcronym: type: string description: Acrônimo do produto roles: type: array items: type: object allOf: – #/definitions/digitalRole description: Papéis que serão relacionados ao trial do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorno caso a operação seja concluída com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateContractInBatch: post: description: API DEPRECIADA: Deprecated. Replaced by the companyContracts facade | DATA: 2026-04-30 | Atualizar lista de clientes de um plano, um cliente só pode ter um contrato que vincule o mesmo plano e produto, sobrescrevendo o contrato anterior tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – productId – dateEnd properties: id: type: string description: Id do plano productId: type: string description: Id do produto companies: type: array items: type: string description: Lista de identificação dos clientes do plano. Se omitida, todos os clientes são migrados dateEnd: type: string format: date-time description: Data final do contrato responses: 200: description: Ok schema: type: object required: – productId – planId properties: productId: type: string description: Id do produto planId: type: string description: Id do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/sendWelcomeEmail: post: description: Envia o e-mail de boas-vindas da criação da conta digital tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – email – acronym properties: email: type: string description: E-mail do responsável pela criação da conta, que receberá a mensagem acronym: type: string description: Sigla do produto domainName: type: string description: Domínio do tenant responses: 200: description: Ok schema: type: object required: – sent properties: sent: type: boolean description: Indica que a solicitação de envio do e-mail foi processada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/saveProductPermissions: post: description: Substitui as permissões do produto pelas permissões informadas tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId properties: prodId: type: string description: Id do produto permissions: type: array items: type: object allOf: – #/definitions/productPermission description: Permissões que substituirão as permissões atuais do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que as permissões do produto foram substituídas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/saveProductServices: post: description: Salva os domínios/serviços associados ao produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – acronym properties: acronym: type: string description: Sigla do produto productServices: type: array items: type: object allOf: – #/definitions/productService description: Domínios e serviços que serão vinculados ao produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que os domínios e serviços do produto foram atualizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica que a migração da base do tenant foi executada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/attachTenant: post: description: Vincula um tenant à conta do cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accountId – companyId – domainName – tenantName properties: accountId: type: string description: Id da conta companyId: type: string description: Id da empresa domainName: type: string description: Domínio do tenant tenantName: type: string description: Nome do tenant environment: type: string allOf: – #/definitions/environmentType description: Ambiente do tenant. Quando não informado, é obtido a partir do domínio responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o tenant foi vinculado à conta message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createTenantAccount: post: description: Cria ou atualiza o vínculo de um tenant com a conta do cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accountId – domainName – tenantName – environment properties: accountId: type: string description: Id da conta domainName: type: string description: Domínio do tenant tenantName: type: string description: Nome do tenant environment: type: string allOf: – #/definitions/environmentType description: Ambiente do tenant responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/companyFacade description: Dados do tenant vinculado à conta, criado ou atualizado pela operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/detachTenant: post: description: Desvincula o tenant da empresa e associa a empresa à conta de avaliação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – tenantName properties: companyId: type: string description: Id da empresa tenantName: type: string description: Nome do tenant que será desvinculado responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o tenant foi desvinculado da empresa message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setDefaultPlan: post: description: Define um plano como padrão do produto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – planId properties: planId: type: string description: Id do plano responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o plano foi definido como padrão message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/activateDeactivatePlan: post: description: Ativa ou desativa um plano tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – planId properties: planId: type: string description: Id do plano activated: type: boolean description: Indica se o plano será ativado ou desativado default: false responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o plano foi ativado ou desativado message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/linkCompanyToContract: post: description: Vincula um tenant a um contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contractId – companyId properties: contractId: type: string description: Id do contrato companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o tenant foi vinculado ao contrato message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/changeProductVisibility: post: description: Altera a visibilidade do produto. Não é permitido informar a visibilidade já configurada. Ao alterar de Apenas tenants selecionados para Todos os tenants, os vínculos específicos do produto com os tenants são removidos. Ao alterar para Apenas tenants selecionados, os tenants autorizados devem ser vinculados explicitamente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productId – visibilityType properties: productId: type: string description: ID do produto visibilityType: type: string allOf: – #/definitions/productVisibility description: Visibilidade que será aplicada ao produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica se a visibilidade do produto foi alterada message: type: string description: Mensagem sobre o resultado da alteração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/assignProductTenants: post: description: Adiciona ou remove os tenants autorizados a visualizar um produto configurado como Apenas tenants selecionados. A operação não é permitida para produtos configurados como Todos os tenants tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: ID do produto configurado como Apenas tenants selecionados tenantsToAdd: type: array items: type: string description: Tenants que passarão a ter acesso ao produto. Tenants em branco e vínculos existentes são ignorados tenantsToRemove: type: array items: type: string description: Tenants que deixarão de ter acesso ao produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica se algum vínculo entre produto e tenant foi alterado message: type: string description: Mensagem sobre o resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/linkProductToGroup: post: description: Vincula um produto a um grupo/linha de produto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – groupId – productId properties: groupId: type: string description: Id do grupo productId: type: string description: Id do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o produto foi vinculado ao grupo message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/deleteStateMachine: post: description: Exclui uma máquina de estado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID da máquina de estado responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que a máquina de estado foi excluída message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setTenantEnvironment: post: description: Configura o ambiente do tenant tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – environment properties: id: type: string description: Id da company environment: type: string allOf: – #/definitions/environmentType description: Ambiente que será definido para o tenant responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenantInfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateProductMetricUrl: post: description: Atualiza a URL de detalhamento de consumo da métrica do produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId – metricId – urlDetail properties: productId: type: string description: Id do produto metricId: type: string description: Id da métrica urlDetail: type: string maxLength: 255 description: URL de detalhamento responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que a URL de detalhamento foi atualizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/linkMetricsToProduct: post: description: Enfileira o vínculo de métricas a um produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId – metricsToLink properties: productId: type: string description: Id do produto metricsToLink: type: array items: type: string minimum: 1 description: Ids das métricas que serão vinculadas ao produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que a solicitação de vínculo das métricas foi enfileirada message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/unlinkMetricToProduct: post: description: Enfileira o desvínculo de uma métrica de um produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId – metricToUnLink properties: productId: type: string description: Id do produto metricToUnLink: type: string description: Id da métrica que será desvinculada do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que a solicitação de desvínculo da métrica foi enfileirada message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createTemporaryContract: post: description: Cria ou atualiza o contrato temporário do cliente para o produto informado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – companyErpId – productErpId – instanceCount – employeeCount – userCount – dateEnd properties: companyErpId: type: string description: Id do cliente no ERP productErpId: type: string description: Id do produto no ERP instanceCount: type: integer format: int64 description: Quantidade de licenças do tipo instância employeeCount: type: integer format: int64 description: Quantidade de licenças do tipo colaborador userCount: type: integer format: int64 description: Quantidade de licenças do tipo usuário dateEnd: type: string format: date description: Data de término da validade do contrato trial: type: boolean description: Indica se o contrato é de avaliação (trial). Quando verdadeiro, o evento temporaryContract é publicado default: false responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que o contrato temporário foi criado ou atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateProductMetric: post: description: Atualiza o tipo de faturamento do produto e métrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId – metricId properties: productId: type: string description: Id do produto metricId: type: string description: Id da métrica urlDetail: type: string maxLength: 255 description: URL de detalhamento billingPeriod: type: string allOf: – #/definitions/period description: Período de faturamento da métrica. Não pode ser alterado quando a métrica é do tipo contínua responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que a configuração da métrica do produto foi atualizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateContractItemBillingDate: post: description: Atualiza a data do billing do item contratado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do item contratado billingInitialDate: type: string format: date description: Data de início do faturamento do item contratado. Informe nulo para remover a data responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica que a data de início do faturamento foi atualizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/billingSync: post: description: Registra de forma síncrona a bilhetagem de chamadas de uma métrica para o tenant do contexto da requisição tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – counterKey – numcalls properties: counterKey: type: string description: Chave da métrica cadastrada no contador, de 1 a 20 caracteres e diferente das métricas padrão do sistema numcalls: type: integer format: int64 description: Quantidade de chamadas que será registrada. Deve ser diferente de zero e estar entre -1.000.000 e 1.000.000 minimum: -1000000 maximum: 1000000 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Dados de bilhetagem inválidos: counterKey deve conter de 1 a 20 caracteres e não pode identificar uma métrica padrão; numcalls deve ser diferente de zero e estar entre -1.000.000 e 1.000.000, inclusive; o tenant do contexto deve ser válido. 404: description: Tenant do contexto da requisição não encontrado. default: description: Error response schema: #/definitions/genericError /digital/signals/billing: post: description: Registra a bilhetagem de chamadas de uma métrica para o tenant do contexto da requisição tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – counterKey – numcalls properties: counterKey: type: string description: Chave da métrica cadastrada no contador, de 1 a 20 caracteres e diferente das métricas padrão do sistema numcalls: type: integer format: int64 description: Quantidade de chamadas que será registrada. Deve ser diferente de zero e estar entre -1.000.000 e 1.000.000 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/billingBatch: post: description: Registra em lote a bilhetagem de chamadas para o tenant atual. Itens com quantidade zero são descartados, e a sincronização do tenant é agendada somente quando ao menos um item é registrado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – billingItems properties: billingItems: type: array items: type: object allOf: – #/definitions/billingItem minimum: 1 description: Chamadas que serão registradas na bilhetagem. Itens com quantidade zero são descartados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/synchronize: post: description: Enfileira a sincronização dos tenants com registros de bilhetagem no dia atual ou anterior. Só pode ser executado no tenant senior tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/athenaReplicator: post: description: Replica os dados do athena para a base do digital tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/synchronizeTenant: post: description: Sincroniza os registros de bilhetagem do tenant informado e enfileira a avaliação dos alertas de consumo configurados. A sincronização não é executada entre 23h e 5h55 UTC tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenantName – domainName properties: tenantName: type: string description: Nome do tenant domainName: type: string description: Domínio do tenant responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/refreshBillingSenior: post: description: Atualiza a visão materializada de billing do tenant senior tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/refreshContractAggregation: post: description: Atualiza a visão materializada de contratos e itens contratados tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/updateMachine: post: description: Executa a etapa correspondente ao estado atual das máquinas de estado informadas. Se nenhuma identificação for informada, processa todas as máquinas não finalizadas tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: machines: type: array items: type: string description: IDs das máquinas de estado que serão processadas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/removeAllTerminated: post: description: Remove todos os estados já finalizados tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/purgeTenant: post: description: Notifica os administradores dos tenants sem login há mais de seis meses e desabilita o tenant uma semana após a notificação tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: baseUrl: type: string description: URL base utilizada no link do e-mail de aviso de desativação default: https://platform.senior.com.br responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/setDefaultContract: post: description: Aplica um contrato padrão para todos os clientes que não possuem contrato tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/task: post: description: Avalia as condições de consumo das primitivas informadas e publica o evento taskEvent para os tenants que atendem a todas as condições tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idTask – period – productId – conditions properties: idTask: type: string description: Id da tarefa, propagado no evento taskEvent period: type: integer format: int64 description: Quantidade de dias anteriores à data atual que define o início do período avaliado productId: type: string description: Id do produto, propagado no evento taskEvent conditions: type: array items: type: object allOf: – #/definitions/condition minimum: 1 description: Condições de quantidade de chamadas que o tenant deve atender para que o evento seja publicado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/updateAnalytics: post: description: Cria ou atualiza, no tenant senior, os analíticos padrão de billing mensal, consumo dos últimos 12 meses e limites contratados tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/sendConsumptionNotification: post: description: Enfileira a avaliação do consumo do mês corrente do tenant e notifica os papéis configurados em cada alerta cujo percentual for atingido ou excedido. Cada alerta é notificado uma vez por mês tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant cujo consumo será avaliado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/sendProductMetricsDefaultEmail: post: description: Envia um e-mail por linha de produto, para os contatos do grupo e os contatos globais, relacionando os produtos informados que possuem métricas padrão vinculadas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – productToNotify properties: productToNotify: type: array items: type: string minimum: 1 description: Ids dos produtos verificados. Somente os produtos com métricas padrão vinculadas entram no e-mail responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/sendInvalidBillingEmail: post: description: Envia um e-mail por grupo de produto, para os contatos do grupo e os contatos globais, relacionando os produtos vinculados à métrica de uma tentativa de billing inválida. Não envia quando a métrica não existe ou não está vinculada a produtos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – counterKey – numcalls – tenantName – source – occurrenceDate properties: counterKey: type: string description: Métrica utilizada na tentativa rejeitada numcalls: type: integer format: int64 description: Quantidade de chamadas informada na tentativa rejeitada tenantName: type: string description: Tenant em que a tentativa ocorreu source: type: string description: Domínio e serviço de origem da tentativa de billing. Ex.: platform/bridge occurrenceDate: type: string format: date-time description: Data e hora da ocorrência errorType: type: string allOf: – #/definitions/invalidBillingErrorType description: Motivo da rejeição. Quando não informado, considera valor de billing inválido responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/events/productActivated: post: description: Informa que um produto foi ativado para um usuário durante a ativação da conta, o aceite de convite ou o primeiro login pendente x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – productAcronym – productRoles properties: tenantName: type: string description: Nome do tenant userName: type: string description: Nome do usuário que ativou o produto productAcronym: type: string description: Sigla do produto ativado, em letras maiúsculas productRoles: type: array items: type: string minimum: 1 description: Papéis do produto aplicados ao usuário responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/taskEvent: post: description: Informa que uma tarefa foi executada e quais tenants atenderam às condições avaliadas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idtask – tenants – productId – runDate properties: idtask: type: string description: Id da tarefa executada tenants: type: array items: type: string minimum: 1 description: Tenants que atenderam a todas as condições avaliadas na tarefa productId: type: string description: Id do produto informado na execução da tarefa runDate: type: string format: date-time description: Data e hora em que a tarefa foi executada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/accountConfirmed: post: description: Informa que a criação de uma conta digital foi confirmada pelo cliente x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – productAcronym properties: tenantName: type: string description: Domínio do tenant userName: type: string description: Nome do usuário, podendo conter o domínio productAcronym: type: string description: Sigla do produto associado à conta confirmada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/cantLogin: post: description: Informa que o usuário não está apto a realizar login ou que a conta não pertence à Senior x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – productAcronym properties: tenantName: type: string description: Domínio do tenant userName: type: string description: Nome de usuário no formato usuario@domínio productAcronym: type: string description: Sigla do produto associado à tentativa de login responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/createdAccount: post: description: Informa que uma conta Senior foi criada com um usuário apto a realizar login x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – productAcronym properties: tenantName: type: string description: Nome do tenant userName: type: string description: Nome de usuário no formato usuario@domínio productAcronym: type: string description: Sigla do produto associado à conta criada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/tenantCreationError: post: description: Informa que ocorreu algum erro ao criar o tenant x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – productAcronym – exactTime properties: tenantName: type: string description: Nome do tenant userName: type: string description: Nome do usuário productAcronym: type: string description: Sigla do produto que tentou criar o tenant exactTime: type: string description: Hora em que o erro ocorreu, quando informada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/firstLogin: post: description: Informa a primeira vez que o usuário fez login x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenantName – userName – productAcronym properties: tenantName: type: string description: Domínio do tenant userName: type: string description: Nome de usuário no formato usuario@domínio productAcronym: type: string description: Acrônimo do produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/alertUsage: post: description: Notifica e registra um alerta de consumo para o tenant informado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – title – content – tenantName – domainName properties: type: string description: Título do alerta de consumo content: type: string description: Conteúdo do alerta de consumo tenantName: type: string description: Nome do tenant que receberá o alerta domainName: type: string description: Domínio do tenant que receberá o alerta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/changedContract: post: description: Informa que os contratos de um tenant foram alterados x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenant – accountErpId – contracts properties: tenant: type: string description: Nome do tenant que teve os contratos alterados accountErpId: type: string description: Id da conta do cliente no ERP contracts: type: array items: type: object allOf: – #/definitions/basicContractedProduct minimum: 1 description: Produtos contratados pelo tenant e suas métricas após a alteração responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/temporaryContract: post: description: Informa que um produto foi contratado temporariamente por um tenant x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tenant – productErpId – endDate properties: tenant: type: string description: Nome do tenant do contrato temporário productErpId: type: string description: Id do produto contratado temporariamente no ERP endDate: type: string format: date description: Data de término do contrato temporário responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/apis/company: post: description: Fachada para gestão de companys tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/companyFacade responses: 200: description: Ok schema: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de companys tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/company/{id}: get: description: Fachada para gestão de companys tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de companys tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/product: post: description: Fachada para gestão de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/productFacade responses: 200: description: Ok schema: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/product/{id}: get: description: Fachada para gestão de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/companyContracts: post: description: Recebe a carga completa de contratos da empresa por meio da integração G5. Contratos e itens ativos ausentes na carga são desativados tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/companyContractsFacade responses: 200: description: Ok schema: #/definitions/companyContractsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/plan: post: description: Fachada para gestão de planos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/planFacade responses: 200: description: Ok schema: #/definitions/planFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de planos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/planFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/plan/{id}: get: description: Fachada para gestão de planos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/planFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de planos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/contract: get: description: Fachada para gestão de contratos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contractFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/contract/{id}: get: description: Fachada para gestão de contratos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contractFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de contratos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/metrics: post: description: Fachada para gestão de métricas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/metricsFacade responses: 200: description: Ok schema: #/definitions/metricsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de métricas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/metricsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/metrics/{id}: get: description: Fachada para gestão de métricas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/metricsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de métricas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/account: post: description: Fachada para gestão de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountFacade responses: 200: description: Ok schema: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/account/{id}: get: description: Fachada para gestão de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/contact: post: description: Fachada para gestão de contatos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/contactFacade responses: 200: description: Ok schema: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de contatos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/contact/{id}: get: description: Fachada para gestão de contatos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de contatos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/tenants: get: description: Fachada para gestão de tenants tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tenantsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/tenants/{id}: get: description: Fachada para gestão de tenants tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tenantsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/contractItems/{id}: delete: description: Fachada para gestão de itens contratados tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/planMetric: post: description: Fachada para gestão de vínculos entre planos e métricas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/planMetricFacade responses: 200: description: Ok schema: #/definitions/planMetricFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/productGroup: post: description: Fachada para gestão de grupos dos produtos (linhas de produto) tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/productGroupFacade responses: 200: description: Ok schema: #/definitions/productGroupFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de grupos dos produtos (linhas de produto) tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/productGroupFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/productGroup/{id}: put: description: Fachada para gestão de grupos dos produtos (linhas de produto) tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/productGroupFacade responses: 200: description: Ok schema: #/definitions/productGroupFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de grupos dos produtos (linhas de produto) tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/alertConsumption: post: description: Fachada para gestão de alertas de consumo de produtos disponíveis ao tenant atual tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/alertConsumptionFacadeInput responses: 200: description: Ok schema: #/definitions/alertDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/alertConsumption/{id}: delete: description: Fachada para gestão de alertas de consumo de produtos disponíveis ao tenant atual tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/alertMessage: post: description: Fachada para gestão de mensagens a serem enviadas nos alertas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/alertMessageFacade responses: 200: description: Ok schema: #/definitions/alertMessageFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para gestão de mensagens a serem enviadas nos alertas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/alertMessageFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/alertMessage/{id}: get: description: Fachada para gestão de mensagens a serem enviadas nos alertas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/alertMessageFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Fachada para gestão de mensagens a serem enviadas nos alertas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/alertMessageFacade responses: 200: description: Ok schema: #/definitions/alertMessageFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão de mensagens a serem enviadas nos alertas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/productGroupContact: post: description: Fachada para gestão dos e-mails de contato dos grupos de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/productGroupContactFacade responses: 200: description: Ok schema: #/definitions/productGroupContactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/productGroupContact/{id}: put: description: Fachada para gestão dos e-mails de contato dos grupos de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/productGroupContactFacade responses: 200: description: Ok schema: #/definitions/productGroupContactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para gestão dos e-mails de contato dos grupos de produtos tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: ticketStatus: type: string enum: – STARTED – TENANTCREATED – APISIGNED – USERCREATED – FINISHED – USEREXIST – ERROR description: Status da criação da conta: * `STARTED` – Iniciou o processo de criação de conta * `TENANTCREATED` – Tenant foi criado * `APISIGNED` – Assinatura da API no WSO2 realizada * `USERCREATED` – Usuário criado * `FINISHED` – Terminou a criação da conta * `USEREXIST` – Usuário já existente * `ERROR` – Ticket com erro upDown: type: string enum: – UP – DOWN description: Define o status de disponibilidade do serviço: * `UP` – Serviço disponível * `DOWN` – Serviço indisponível environmentType: type: string enum: – PRODUCTION – HOMOLOG – DEMONSTRATION – DEVELOPMENT description: Define o tipo de ambiente do tenant: * `PRODUCTION` – Ambiente de produção * `HOMOLOG` – Ambiente de homologação. O tenant recebe o sufixo -homolog no domínio, por exemplo nomedominio-homolog.com.br * `DEMONSTRATION` – Ambiente de demonstração. O tenant recebe o sufixo -demo no domínio, por exemplo nomedominio-demo.com.br * `DEVELOPMENT` – Ambiente de desenvolvimento. O tenant recebe o sufixo -dev no domínio, por exemplo nomedominio-dev.com.br period: type: string enum: – DIARIO – SEMANAL – MENSAL – ANUAL description: Define a periodicidade de faturamento: * `DIARIO` – Período diário * `SEMANAL` – Período semanal * `MENSAL` – Período mensal * `ANUAL` – Período anual metricType: type: string enum: – PERIOD – CONTINUOUS description: Define o tipo de contagem da métrica: * `PERIOD` – Observa o período de faturamento * `CONTINUOUS` – Não observa o período de faturamento metricField: type: string enum: – USERS – EMPLOYEE – INSTANCE description: Define a dimensão controlada pela métrica: * `USERS` – Métrica para a quantidade de usuários * `EMPLOYEE` – Métrica para a quantidade de colaboradores * `INSTANCE` – Métrica para a quantidade de instâncias productVisibility: type: string enum: – SELECTED_TENANTS – ALL_TENANTS description: Define como a disponibilidade do produto é controlada para os tenants: * `SELECTED_TENANTS` – Produto disponível somente para tenants explicitamente vinculados por meio de ProductTenant * `ALL_TENANTS` – Produto disponível para todos os tenants, sem necessidade de vínculo específico em ProductTenant notificationType: type: string enum: – EMAIL – SENIOR_X description: Define o tipo de notificação a ser enviada: * `EMAIL` – Tipo de notificação por e-mail * `SENIOR_X` – Tipo de notificação SeniorX invalidBillingErrorType: type: string enum: – INVALID_VALUE – DEFAULT_METRIC description: Define o motivo da rejeição da tentativa de billing: * `INVALID_VALUE` – Tentativa rejeitada por valor de billing inválido * `DEFAULT_METRIC` – Tentativa rejeitada por uso de métrica padrão do sistema contentType: type: string enum: – HTML – TEXT description: Define o tipo do corpo da mensagem a ser enviada na notificação: * `HTML` – Tipo HTML * `TEXT` – Tipo texto metricActionType: type: string enum: – LINK – UNLINK description: Define o tipo de ação para vincular ou desvincular métricas: * `LINK` – Ação para vincular métricas ao produto * `UNLINK` – Ação para desvincular métrica do produto userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fullContractItem: description: Representa um item completo de contrato type: object required: – erpProductId – erpGroupId – planId – planMetrics properties: productId: type: string description: Id do produto erpProductId: type: string description: Id do produto no ERP erpGroupId: type: string description: Id do grupo do produto productName: type: string description: Nome do produto productAcronym: type: string description: Acrônimo do produto productFamily: type: string description: Família do produto productDescription: type: string description: Descrição do produto productActive: type: boolean description: Indica se o produto está ativo planId: type: string description: Id do plano planName: type: string description: Nome do plano planDescription: type: string description: Descrição do plano planBillingPeriod: type: string allOf: – #/definitions/period description: Periodicidade de faturamento do plano planActive: type: boolean description: Indica se o plano está ativo planDefault: type: boolean description: Indica se o plano é o padrão do produto planValidityStart: type: string format: date-time description: Vigência inicial do plano planValidityEnd: type: string format: date-time description: Vigência final do plano planMetrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano no contrato validityStart: type: string format: date-time description: Data inicial da validade do item de contrato validityEnd: type: string format: date-time description: Data final da validade do item de contrato billingItem: description: Representa os dados necessários para efetuar uma bilhetagem type: object required: – counterKey – numcalls properties: counterKey: type: string description: Chave da métrica cadastrada no contador, de 1 a 20 caracteres e diferente das métricas padrão do sistema numcalls: type: integer format: int64 description: Quantidade de chamadas que será registrada companyContract: description: Representa um contrato na integração com o ERP type: object required: – erpOurCompanyId – erpFilialId – erpContractId – contractType – dateStart – isEnable – contractItems properties: erpOurCompanyId: type: string description: Id da empresa no ERP erpFilialId: type: string description: Id da filial no ERP erpContractId: type: string description: Id do contrato no ERP contractType: type: integer format: int64 description: Tipo do contrato (1-habilitação, 2-mensalidade) dateStart: type: string format: date-time description: Data inicial do contrato dateEnd: type: string format: date-time description: Data final do contrato isEnable: type: boolean description: Indica se o contrato está habilitado billingPeriod: type: integer format: int64 description: Período de faturamento do contrato contractItems: type: array items: type: object allOf: – #/definitions/contractItem minimum: 1 description: Itens do contrato contractItem: description: Representa um item de contrato na integração com o ERP. As quantidades são associadas às métricas pelo campo field, e não pela chave da métrica type: object required: – erpProductId – isEnable – instanceCount – employeeCount – userCount properties: erpProductId: type: string description: Id do produto no ERP isEnable: type: boolean description: Indica se o item do contrato está habilitado instanceCount: type: integer format: int64 description: Quantidade contratada aplicada às métricas com field INSTANCE employeeCount: type: integer format: int64 description: Quantidade contratada aplicada às métricas com field EMPLOYEE userCount: type: integer format: int64 description: Quantidade contratada aplicada às métricas com field USERS billingInitialDate: type: string format: date description: Data de início do faturamento do item contratado tenant: description: Representa os dados básicos de um tenant discriminator: _discriminator type: object required: – envType – name – domainName – _discriminator properties: envType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente do tenant name: type: string description: Nome do tenant domainName: type: string description: Domínio do tenant info: type: string description: Mensagem informativa sobre o tenant. Recebe tenant_not_found quando o tenant não é encontrado no gerenciamento de tenants _discriminator: type: string description: tenantInfo: description: Representa os dados de um tenant, incluindo seu identificador e administrador allOf: – #/definitions/tenant – type: object properties: id: type: string description: Id da company que representa o tenant admin: type: object allOf: – #/definitions/administrator description: Administrador responsável pelo tenant environment: description: Representa a configuração de criação de um ambiente de tenant type: object required: – type properties: confirmEmail: type: boolean description: Indica se a criação exige confirmação por e-mail. O padrão é false default: false type: type: string allOf: – #/definitions/environmentType description: Tipo do ambiente que será criado (produção, homologação, demonstração ou desenvolvimento) inviteDefinition: description: Representa um tipo de convite para usuários acessarem a plataforma ou algum produto type: object required: – URIInvite – productAcronym – inviteDescription – roles properties: URIInvite: type: string description: URI do convite productAcronym: type: string description: Sigla do produto associado ao convite inviteDescription: type: string description: Descrição do convite roles: type: array items: type: object allOf: – #/definitions/role minimum: 1 description: Papéis associados ao convite product: description: Representa um produto type: object required: – id – name – description – acronym – redirectUrl – active – allowTrial – trialDays properties: id: type: string description: Id do produto name: type: string description: Nome do produto description: type: string description: Descrição do produto acronym: type: string description: Sigla do produto. Por exemplo: BPM, SAM-P, SAM-I, FLX-CXA redirectUrl: type: string description: URL para a qual o usuário é redirecionado após efetuar o login active: type: boolean description: Indica se o produto está ativo allowTrial: type: boolean description: Indica se o produto suporta período de avaliação (trial) trialDays: type: integer format: int64 description: Quantidade de dias de duração do período de avaliação (trial) do produto. Caso o valor de allowTrial seja false este campo é ignorado. papel: description: Representa um papel (estão sendo utilizados os mesmos nomes dos campos definidos no serviço de usuários) type: object required: – idPapel – nomePapel – descricaoPapel properties: idPapel: type: string description: Identificador do papel nomePapel: type: string description: Nome do papel descricaoPapel: type: string description: Descrição do papel role: description: Representa um papel, com os mesmos nomes de campos definidos no serviço authorization type: object required: – name properties: name: type: string description: Nome do papel description: type: string description: Descrição do papel productCreationTemplates: description: Representa os templates de e-mail utilizados na ativação de um produto type: object required: – locale – productActivateEmailTemplate – posActivatedProductEmailTemplate properties: locale: type: string description: Idioma dos templates productActivateEmailTemplate: type: object allOf: – #/definitions/emailTemplate description: Template de e-mail de ativação do produto posActivatedProductEmailTemplate: type: object allOf: – #/definitions/emailTemplate description: Template de e-mail pós-ativação do produto inviteTemplates: description: Representa os templates de e-mail utilizados nos convites de usuários type: object required: – locale – inviteEmailTemplate – posInviteEmailTemplate properties: locale: type: string description: Idioma dos templates inviteEmailTemplate: type: object allOf: – #/definitions/emailTemplate description: Template de e-mail de convite posInviteEmailTemplate: type: object allOf: – #/definitions/emailTemplate description: Template de e-mail pós-convite emailTemplate: description: Representa um template de e-mail type: object required: – subject – body properties: subject: type: string description: Assunto do e-mail body: type: string description: Corpo do e-mail bundle: description: Representa um recurso dos templates de e-mail do produto, no formato chave e valor type: object required: – key – value properties: key: type: string description: Chave do recurso: invite_template_subject, invite_template_content, pos_invite_template_subject, pos_invite_template_content, product_activate_subject, product_activate_body, pos_product_activate_subject ou pos_product_activate_body value: type: string description: Assunto ou conteúdo do template, conforme a chave informada primitiveDef: description: Representa uma primitiva type: object required: – domainName – serviceName – name properties: domainName: type: string description: Domínio da primitiva serviceName: type: string description: Serviço da primitiva name: type: string description: Nome da primitiva primitiveCalls: description: Representa as chamadas de uma primitiva e o limite de consumo configurado type: object required: – domainName – serviceName – primitive – qtdEx properties: domainName: type: string description: Domínio da primitiva serviceName: type: string description: Serviço da primitiva primitive: type: string description: Nome da primitiva qtdLimit: type: integer format: int64 description: Quantidade de chamadas permitidas percent: type: integer format: int64 description: Percentual de consumo em relação ao limite de chamadas qtdEx: type: integer format: int64 description: Quantidade de chamadas executadas serviceDef: description: Representa um serviço type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio do serviço serviceName: type: string description: Nome do serviço contract: description: Definição de um contrato type: object required: – id – companyId – companyName – cnpj – phone – productId – productName – planId – dateStart – dateEnd – isEnable properties: id: type: string description: Id do contrato companyId: type: string description: Id da empresa companyName: type: string description: Nome da empresa cnpj: type: string description: CNPJ da empresa phone: type: string description: Telefone da empresa productId: type: string description: Id do produto productName: type: string description: Nome do produto productAcronym: type: string description: Acrônimo do produto planId: type: string description: Id do plano dateStart: type: string format: date-time description: Data inicial do contrato dateEnd: type: string format: date-time description: Data final do contrato isEnable: type: boolean description: Indica se o contrato está ativo planName: type: string description: Nome do plano planDescription: type: string description: Descrição do plano chargingPrimitive: description: Representa as chamadas de uma primitiva registradas na bilhetagem type: object required: – tenant – destdomain – destservice – sourceDomain – sourceService – primitive – syncdate – numcalls properties: tenant: type: string description: Nome do tenant destdomain: type: string description: Domínio de destino da chamada destservice: type: string description: Serviço de destino da chamada sourceDomain: type: string description: Domínio de origem da chamada sourceService: type: string description: Serviço de origem da chamada primitive: type: string description: Nome da primitiva syncdate: type: string format: date-time description: Data da sincronização numcalls: type: integer format: int64 description: Número de execuções realizadas chargingBusiness: description: Representa o consumo de uma métrica de negócio registrado na bilhetagem type: object required: – domainName – tenantName – counterkey – numcalls – syncdate – processdate properties: domainName: type: string description: Domínio do tenant tenantName: type: string description: Nome do tenant counterkey: type: string description: Chave da métrica cadastrada no contador numcalls: type: integer format: int64 description: Número de chamadas syncdate: type: string format: date-time description: Data da sincronização processdate: type: string format: date-time description: Data do processamento digitalRole: description: Representa um papel de um produto digital, utilizado no convite de usuários type: object required: – name – description – active properties: name: type: string description: Nome do papel description: type: string description: Descrição do papel active: type: boolean description: Indica se o papel está ativo digitalCustomer: description: Representa um cliente digital type: object required: – companyId – name – trialStartDate – trial – isNew properties: companyId: type: string description: Id da company name: type: string description: Nome do cliente trialStartDate: type: string format: date-time description: Data em que o cliente se cadastrou para o período de avaliação trial: type: boolean description: Indica se o cliente está em período de avaliação isNew: type: boolean description: Indica se o cliente é novo percent: type: integer format: int64 description: Percentual de execuções realizadas em relação ao limite total totalLimit: type: integer format: int64 description: Total de execuções permitidas totalExecutions: type: integer format: int64 description: Total de execuções realizadas limit: type: boolean description: Indica se ao menos uma métrica do plano do cliente atingiu ou excedeu o limite de execuções contractId: type: string description: Id do contrato do cliente customersMonthly: description: Número de clientes por mês e ano type: object required: – customerNumber – month properties: customerNumber: type: integer format: int64 description: Quantidade de clientes cadastrados no mês month: type: string format: date-time description: Mês e ano do cadastro productPermission: description: Representa uma permissão de acesso do produto type: object required: – roleName properties: roleName: type: string description: Nome do papel cadastrado na plataforma roleDescription: type: string description: Descrição do papel planDefinition: description: Representa a definição de um plano do produto type: object required: – prodId – name – period – vigStart – isEnable – isDefault – metrics – primitiveList properties: id: type: string description: Id do plano prodId: type: string description: Id do produto name: type: string description: Nome do plano description: type: string description: Descrição do plano period: type: integer format: int64 description: Periodicidade de faturamento do plano: 0 para diário, 1 para semanal, 2 para mensal e 3 para anual vigStart: type: string format: date-time description: Data inicial de vigência do plano vigEnd: type: string format: date-time description: Data final de vigência do plano isEnable: type: boolean description: Indica se o plano está ativo isDefault: type: boolean description: Indica se o plano é o padrão do produto generated: type: boolean description: Indica se o plano foi gerado pela integração metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas vinculadas ao plano primitiveList: type: array items: type: object allOf: – #/definitions/primitiveLimit minimum: 1 description: Limites de execução configurados para as primitivas customerConsumption: description: Representa o consumo de um cliente em relação ao limite do plano type: object required: – name – companyId – contractId – customerId – productId – totalLimit – totalNumcalls – percent – planName – planId properties: name: type: string description: Nome da empresa companyId: type: string description: Id da empresa contractId: type: string description: Id do contrato customerId: type: string description: Id do customer productId: type: string description: Id do produto totalLimit: type: integer format: int64 description: Total de chamadas permitidas no plano totalNumcalls: type: integer format: int64 description: Total de chamadas executadas percent: type: integer format: int64 description: Percentual de chamadas executadas em relação ao limite do plano planName: type: string description: Nome do plano planId: type: string description: Id do plano metric: description: Representa uma métrica com seu limite e consumo type: object required: – id properties: id: type: string description: Id da métrica name: type: string description: Nome da métrica description: type: string description: Descrição da métrica field: type: string allOf: – #/definitions/metricField description: Campo utilizado no mapeamento das métricas padrão (USERS, EMPLOYEE e INSTANCE) metrickey: type: string description: Chave da métrica cadastrada no contador type: type: integer format: int64 description: Tipo de contagem da métrica: 0 para periódica e 1 para contínua metricType: type: string allOf: – #/definitions/metricType description: Nome do tipo de contagem da métrica enable: type: boolean description: Indica se a métrica está ativa qtdEx: type: integer format: int64 description: Quantidade de chamadas executadas da métrica qtdLimit: type: integer format: int64 description: Quantidade de chamadas permitidas percent: type: integer format: int64 description: Percentual de consumo em relação ao limite contratado month: type: string format: date-time description: Mês em que as chamadas foram executadas lastSynchronize: type: string format: date-time description: Data da última sincronização totalRemaining: type: integer format: int64 description: Quantidade restante até atingir o limite contratado totalExceeded: type: integer format: int64 description: Quantidade excedida em relação ao limite contratado allowExceed: type: boolean description: Informa se a métrica permite o cadastro de excedentes para usuários nomeados urlDetail: type: string maxLength: 255 description: URL de detalhamento do consumo da métrica billingPeriod: type: string allOf: – #/definitions/period description: Período de faturamento (anual, mensal, semanal, diário) billingPeriodRestartDate: type: string format: date-time description: Data de início do período de faturamento vigente billingPeriodEndDate: type: string format: date-time description: Data de fim do período de faturamento vigente machine: description: Definição da máquina de estado type: object required: – id – customer – acronym – dateStart – dateUpdate – state – tenant – tenantDomain properties: id: type: string description: Identificação da máquina de estado customer: type: string description: Customer associado à máquina de estado acronym: type: string description: Sigla do produto dateStart: type: string format: date-time description: Data de início da máquina de estado dateUpdate: type: string format: date-time description: Data da última atualização da máquina de estado state: type: string description: Estado atual da máquina tenant: type: string description: Nome do tenant tenantDomain: type: string description: Domínio do tenant company: description: Definição de um tenant type: object required: – name – cnpj – phone – tenantName – domainName – customers properties: id: type: string description: Id da company erpid: type: string description: Id do cliente no ERP name: type: string description: Nome do cliente cnpj: type: string description: CNPJ do cliente phone: type: string description: Telefone do cliente tenantName: type: string description: Nome do tenant domainName: type: string description: Domínio do tenant customers: type: array items: type: object allOf: – #/definitions/customer minimum: 1 description: Contatos/usuários do cliente vinculados ao tenant environment: type: string allOf: – #/definitions/environmentType description: Ambiente do tenant accountId: type: string description: Id da conta do cliente vinculada ao tenant customer: description: Definição de um customer type: object required: – firstName – lastName – email properties: id: type: string description: Id do customer firstName: type: string description: Primeiro nome do customer lastName: type: string description: Sobrenome do customer email: type: string description: E-mail do customer locale: type: string description: Idioma do customer primitiveLimit: description: Representa o limite de execuções de uma primitiva type: object required: – primitiveDomain – primitiveService – primitiveCommand – executionsLimit properties: primitiveDomain: type: string description: Domínio da primitiva primitiveService: type: string description: Serviço da primitiva primitiveCommand: type: string description: Nome da primitiva executionsLimit: type: integer format: int64 description: Limite de execuções da primitiva condition: description: Representa uma condição de consumo de uma primitiva avaliada na tarefa type: object required: – operator – resultValue – name – domainName – serviceName properties: operator: type: string description: Operador de comparação aplicado à quantidade de chamadas. Valores aceitos: , =, , =, == e !== resultValue: type: integer format: int64 description: Quantidade de chamadas usada como referência na comparação name: type: string description: Nome da primitiva avaliada domainName: type: string description: Domínio da primitiva avaliada serviceName: type: string description: Serviço da primitiva avaliada productService: description: Representa um serviço associado a um produto type: object required: – domainName – serviceName properties: domainName: type: string description: Domínio do serviço vinculado ao produto serviceName: type: string description: Nome do serviço vinculado ao produto call: description: Representa a quantidade de chamadas de uma primitiva por tenant type: object required: – endpoint – tenant – numcalls properties: endpoint: type: object allOf: – #/definitions/primitiveDef description: Primitiva (domínio, serviço e nome) a que as chamadas se referem tenant: type: string description: Tenant que realizou as chamadas numcalls: type: integer format: int64 description: Quantidade de chamadas realizadas pelo tenant no período consultado myProduct: description: Representa um produto contratado pelo tenant e os dados do item contratado type: object required: – productId – erpProductId – erpGroupId – productName – productAcronym – productFamily – productDescription – productActive – contractId – contracted – planName – usage properties: productId: type: string description: Id do produto erpProductId: type: string description: Id do produto no ERP erpGroupId: type: string description: Id da linha de produto no ERP productName: type: string description: Nome do produto productAcronym: type: string description: Sigla do produto productFamily: type: string description: Família do produto productDescription: type: string description: Descrição do produto productActive: type: boolean description: Indica se o produto está ativo contractId: type: string description: Id do contrato do produto contracted: type: string format: date-time description: Data de início do período de faturamento vigente, calculada a partir da periodicidade do plano e da data de início do contrato planName: type: string description: Nome do plano exibido para o produto, composto pelo prefixo Plano e o nome do produto usage: type: integer format: int64 description: Quantidade de uso do produto. Não é preenchida por esta consulta alert: description: Representa um alerta de consumo registrado para o tenant type: object required: – id – title – content – dateAlert properties: id: type: string description: Id do alerta type: string description: Título do alerta content: type: string description: Conteúdo do alerta dateAlert: type: string format: date-time description: Data e hora em que o alerta foi registrado customerConsumptionByPlan: description: Consumo dos clientes por plano type: object required: – planId – planName – customers properties: planId: type: string description: Id do plano planName: type: string description: Nome do plano customers: type: array items: type: object allOf: – #/definitions/customerConsumption minimum: 1 description: Clientes que excederam o limite checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck administrator: description: Representa um administrador de tenant type: object required: – firstName – lastName – email properties: firstName: type: string description: Nome do administrador lastName: type: string description: Sobrenome do administrador email: type: string description: E-mail do administrador contractWithItems: description: Definição de um contrato com itens type: object required: – id – companyId – companyName – cnpj – phone – dateStart – dateEnd – isEnable – items properties: id: type: string description: Id do contrato companyId: type: string description: Id da empresa companyName: type: string description: Nome da empresa cnpj: type: string description: CNPJ da empresa phone: type: string description: Telefone da empresa dateStart: type: string format: date-time description: Data inicial do contrato dateEnd: type: string format: date-time description: Data final do contrato isEnable: type: boolean description: Indica se o contrato está ativo items: type: array items: type: object allOf: – #/definitions/item minimum: 1 description: Itens contratados que compõem o contrato item: description: Definição de um item de contrato type: object required: – planName – planDescription – planId – productId – productName properties: planName: type: string description: Nome do plano planDescription: type: string description: Descrição do plano planId: type: string description: Id do plano productId: type: string description: Id do produto productName: type: string description: Nome do produto contractedItemsConsumption: description: Produtos contratados com consumo type: object required: – productId – erpProductId – productName – productGroupDescription – contractItemId – planName – metricsOfPlan properties: productId: type: string description: Id do produto erpProductId: type: string description: Id do produto no ERP productName: type: string description: Nome do produto productGroupDescription: type: string description: Descrição da linha de produto contractItemId: type: string description: Id do item contratado planName: type: string description: Nome do plano metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano com o consumo apurado no período pageRequest: description: Representa os parâmetros utilizados para paginação discriminator: _discriminator type: object required: – _discriminator properties: offset: type: integer format: int64 description: Índice da página, iniciando em 0 default: 0 size: type: integer format: int64 description: Quantidade de registros retornados por página default: 10 orderby: type: string description: Ordenação aplicada à consulta filter: type: string description: Filtro aplicado à consulta _discriminator: type: string description: pagedResults: description: Representa os resultados da paginação discriminator: _discriminator type: object required: – totalPages – totalElements – _discriminator properties: totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade total de elementos _discriminator: type: string description: productConsumption: description: Representa o retorno dos produtos e consumos paginados allOf: – #/definitions/pagedResults – type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/contractedItemsConsumption minimum: 1 description: Produtos contratados com consumo getProductConsumption: description: Representa o mês de consulta para produtos e consumos paginados allOf: – #/definitions/pageRequest – type: object properties: month: type: string format: date description: Mês do consumo. Quando não informado, é utilizado o período de faturamento vigente productGroup: description: Representa uma linha de produto e seus produtos vinculados type: object required: – productGroupId – productGroupDescription – products properties: productGroupId: type: string description: Id da linha de produto productGroupDescription: type: string description: Descrição da linha de produto products: type: array items: type: object allOf: – #/definitions/productDetails minimum: 1 description: Produtos vinculados ao grupo productDetails: description: Representa os dados de um produto associado a uma linha de produto type: object required: – productId – erpProductId – productName properties: contractItemId: type: string description: Id do item contratado productId: type: string description: Id do produto erpProductId: type: string description: Id do produto no ERP productName: type: string description: Nome do produto tenantsByProduct: description: Representa os tenants que estão vinculados aos produtos allOf: – #/definitions/pagedResults – type: object required: – contents properties: contents: type: array items: type: string minimum: 1 description: Nomes dos tenants que possuem o produto contratado productTenants: description: Representa um produto e a página de tenants retornada para ele allOf: – #/definitions/pagedResults – type: object required: – productId – erpProductId – productName – tenants properties: productId: type: string description: Id do produto erpProductId: type: string description: Id do produto no ERP productName: type: string description: Nome do produto tenants: type: array items: type: string minimum: 1 description: Nomes dos tenants retornados para o produto tenantsByProducts: description: Representa os tenants agrupados por produto e os ids de produtos que não foram encontrados type: object required: – contents – notFoundProductIds properties: contents: type: array items: type: object allOf: – #/definitions/productTenants minimum: 1 description: Produtos encontrados e seus tenants notFoundProductIds: type: array items: type: string minimum: 1 description: Ids de produtos informados que não foram encontrados. Vazio quando todos os produtos existem getLinkedTenants: description: Representa o produto a ser filtrado para mostrar os tenants vinculados allOf: – #/definitions/pageRequest – type: object required: – productId properties: productId: type: string description: Id do produto getLinkedTenantsByProducts: description: Representa os produtos a serem filtrados para mostrar os tenants vinculados allOf: – #/definitions/pageRequest – type: object required: – productIds properties: productIds: type: array items: type: string minimum: 1 description: Ids dos produtos getConsumptionAllTenant: description: Representa os filtros e a paginação da consulta de consumo dos produtos por tenant allOf: – #/definitions/pageRequest – type: object properties: tenantsName: type: array items: type: string description: Lista com o nome dos tenants erpAccountIds: type: array items: type: integer format: int64 description: Lista com o código ERP dos clientes erpProductIds: type: array items: type: string description: Lista com o código ERP dos produtos referencePeriod: type: string description: Mês de referência do consumo, no formato yyyy-MM. Quando não informado, é utilizado o mês atual consumptionAllTenants: description: Representa o resultado paginado dos limites contratados e do consumo das métricas por tenant allOf: – #/definitions/pagedResults – type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/consumptionAllTenantsItem minimum: 1 description: Registros de consumo e limite contratado encontrados para os filtros e a página solicitada consumptionAllTenantsItem: description: Representa o cliente junto com o produto e o seu consumo type: object required: – tenantName – erpAccountId – accountName – erpProductId – productName – metricPeriod – referencePeriod – metricName – qtdLimit – qtdEx properties: tenantName: type: string description: Nome do tenant vinculado ao cliente erpAccountId: type: integer format: int64 description: Código ERP do cliente accountName: type: string description: Razão social do cliente erpProductId: type: string description: Código ERP do produto productName: type: string description: Nome do produto metricPeriod: type: string description: Periodicidade contratada (diário, semanal, mensal ou anual) referencePeriod: type: string description: Mês de referência do consumo metricName: type: string description: Nome da métrica qtdLimit: type: integer format: int64 description: Quantidade contratada qtdEx: type: integer format: int64 description: Quantidade de chamadas executadas da métrica contractDetailsResponse: description: Representa o retorno dos contratos junto com seus detalhes allOf: – #/definitions/pagedResults – type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/contractDetailsItem minimum: 1 description: Lista com detalhes sobre os contratos contractDetailsItem: description: Representa os valores retornados da visão dinâmica contract_details type: object required: – clientId – contractId – branchId – companyCode – metricPeriod – dateStart – dateEnd – isContractEnabled – billingPeriod – productCode – isContractItemEnabled – userContractedValue – employeeContractedValue – instanceContractedValue – anotherContractedValue properties: clientId: type: string description: Código do cliente contractId: type: string description: Código do contrato branchId: type: string description: Código da branch e representa o erpourcompanyId companyCode: type: string description: Código da companhia metricPeriod: type: integer format: int64 description: Tipo de contagem da métrica: 0 para periódica e 1 para contínua dateStart: type: string format: date description: Data de início do contrato dateEnd: type: string format: date description: Data de fim do contrato isContractEnabled: type: string description: Informa se o contrato está ativo A ou inativo I billingPeriod: type: integer format: int64 description: Periodicidade contratada: 0 para diário, 1 para semanal, 2 para mensal e 3 para anual productCode: type: string description: Código do produto isContractItemEnabled: type: string description: Informa se o item do contrato está ativo A ou inativo I userContractedValue: type: integer format: int64 description: Quantidade contratada de usuários employeeContractedValue: type: integer format: int64 description: Quantidade contratada de colaboradores instanceContractedValue: type: integer format: int64 description: Quantidade contratada de instâncias anotherContractedValue: type: integer format: int64 description: Quantidade contratada que seja diferente de usuários, colaboradores e instâncias alertDetails: description: Representa um alerta de consumo com detalhes de produto type: object required: – id – metricId – metricName – metricKey – percentage – roles properties: id: type: string description: Id do alerta productId: type: string description: Id do produto productName: type: string description: Nome do produto metricId: type: string description: Id da métrica metricName: type: string description: Nome da métrica metricKey: type: string description: Chave da métrica percentage: type: integer format: int64 description: Percentual de consumo que dispara a notificação roles: type: array items: type: string minimum: 1 description: Nomes dos papéis notificados quando o consumo atinge o percentual informado getConsumptionAlertsResponse: description: Representa o retorno dos alertas paginados allOf: – #/definitions/pagedResults – type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/alertsByProduct minimum: 1 description: Alertas agrupados por produto alertsByProduct: description: Representa os alertas de consumo agrupados por produto type: object required: – productId – erpProductId – productName – productGroupDescription – alerts properties: productId: type: string description: Id do produto erpProductId: type: string description: Id do produto no ERP productName: type: string description: Nome do produto productGroupDescription: type: string description: Descrição da linha de produto alerts: type: array items: type: object allOf: – #/definitions/alertDetails minimum: 1 description: Lista de alertas de consumo productInfo: description: Representa as informações resumidas de um produto type: object required: – id – name – erpId – acronym – urlDetail – billingPeriod properties: id: type: string description: Id do produto name: type: string description: Nome do produto erpId: type: string description: Id do produto no ERP acronym: type: string description: Acrônimo do produto urlDetail: type: string maxLength: 255 description: URL de detalhamento billingPeriod: type: string allOf: – #/definitions/period description: Período de faturamento da métrica no produto groupContact: description: Representa o contato do grupo de produtos type: object required: – id – groupId – email – isDefault properties: id: type: string description: Id do contato groupId: type: string description: Id do grupo de produtos email: type: string description: E-mail do grupo de produtos isDefault: type: boolean description: Informa se o contato é default, o qual receberá todos os e-mails referentes a todos os grupos de produtos groupAndContacts: description: Representa um grupo de produtos e seus contatos type: object required: – groupId – groupDescription – contacts properties: groupId: type: string description: Id do grupo de produtos groupDescription: type: string description: Descrição do grupo de produtos contacts: type: array items: type: object allOf: – #/definitions/groupContact minimum: 1 description: Lista de contatos do grupo de produtos groupsAndContactsResponse: description: Representa o retorno dos grupos de produtos e seus contatos allOf: – #/definitions/pagedResults – type: object required: – listOfGroups properties: listOfGroups: type: array items: type: object allOf: – #/definitions/groupAndContacts minimum: 1 description: Lista os grupos de produtos e seus contatos groupsAndContacts: description: Representa os parâmetros utilizados para paginação dos grupos de produtos e seus contatos allOf: – #/definitions/pageRequest – type: object properties: groupId: type: string description: Id do grupo de produtos, no formato UUID. Quando não informado, retorna todos os grupos metricConsumption: description: Informações de consumo da métrica type: object required: – id – name – metricKey – type properties: id: type: string description: Id da métrica name: type: string description: Nome da métrica description: type: string description: Descrição da métrica metricKey: type: string description: Chave da métrica type: type: integer format: int64 description: Tipo de contagem da métrica: 0 para periódica e 1 para contínua products: type: array items: type: object allOf: – #/definitions/productInfoConsumption description: Produtos vinculados à métrica, com o limite contratado productInfoConsumption: description: Informações de consumo do produto type: object required: – productId – productErpId – acronym – qtdEx properties: productId: type: string description: Id do produto productErpId: type: string description: Id do produto no ERP acronym: type: string description: Acrônimo do produto qtdEx: type: integer format: int64 description: Quantidade de chamadas executadas qtdLimit: type: integer format: int64 description: Quantidade de chamadas permitidas percent: type: integer format: int64 description: Percentual de consumo em relação ao limite contratado planName: type: string description: Nome do plano activePlan: type: boolean description: Indica se o plano está ativo currentPlan: type: boolean description: Indica se o plano está vigente lastSynchronize: type: string format: date-time description: Data da última sincronização billingPeriodRestartDate: type: string format: date-time description: Data de início do período de faturamento vigente billingPeriodEndDate: type: string format: date-time description: Data de fim do período de faturamento vigente metricsToLinkProduct: description: Representa os parâmetros para listar as métricas que podem ser vinculadas a um produto allOf: – #/definitions/pageRequest – type: object required: – productId properties: productId: type: string description: Id do produto ao qual as métricas serão vinculadas metric: type: string description: Chave ou parte do nome da métrica utilizada como filtro metricsToLinkProductResponse: description: Retorna as métricas que podem ser vinculadas a um produto allOf: – #/definitions/pagedResults – type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/metricToLink minimum: 1 description: Métricas que podem ser vinculadas ao produto metricToLink: description: Representa uma métrica que ainda não está vinculada ao produto e pode ser vinculada a ele type: object required: – id – name – description – field – key – type properties: id: type: string description: Id da métrica name: type: string description: Nome da métrica description: type: string description: Descrição da métrica field: type: string allOf: – #/definitions/metricField description: Campo utilizado no mapeamento do tipo da métrica para consumo (USERS, EMPLOYEE e INSTANCE) key: type: string description: Chave da métrica type: type: string allOf: – #/definitions/metricType description: Tipo de contagem da métrica productMetricInfo: description: Retorna as informações do produto, métrica e quantidade contratada type: object required: – productId – productName – productErpId – metricId – metricName – metricKey – namedUser – allowExceed – limitCalls properties: productId: type: string description: Id do produto productName: type: string description: Nome do produto productErpId: type: string description: ErpId do produto metricId: type: string description: Id da métrica metricName: type: string description: Nome da métrica metricKey: type: string description: Chave da métrica namedUser: type: boolean description: Indica se a métrica controla usuários nomeados allowExceed: type: boolean description: Informa se a métrica permite o cadastro de excedentes para usuários nomeados limitCalls: type: integer format: int64 description: Quantidade de chamadas contratada para o produto e métrica no tenant informado productWithMetrics: description: Retorna as informações básicas do produto com as métricas vinculadas type: object required: – productId – productName – erpProductId – metrics properties: productId: type: string description: Id do produto productName: type: string description: Nome do produto erpProductId: type: string description: ErpId do produto metrics: type: array items: type: object allOf: – #/definitions/basicMetric minimum: 1 description: Lista de métricas vinculadas ao produto basicMetric: description: Define as informações básicas da métrica type: object required: – id – name – key – allowExceed – limitCalls properties: id: type: string description: Id da métrica name: type: string description: Nome da métrica key: type: string description: Chave da métrica allowExceed: type: boolean description: Informa se a métrica permite o cadastro de excedentes para usuários nomeados limitCalls: type: integer format: int64 description: Limite contratado para a métrica basicContractedProduct: description: Representa dados básicos de um produto contratado e suas métricas type: object required: – erpContractId – erpProductId – productName – productAcronym – productFamily – erpProductGroupId – metrics properties: erpContractId: type: string description: Código do contrato no ERP erpProductId: type: string description: Código do produto no ERP productName: type: string description: Nome do produto productAcronym: type: string description: Acrônimo do produto productFamily: type: string description: Família do produto, por exemplo CDU, SAM, SAAS ou MANUT erpProductGroupId: type: string description: Código agrupador do produto metrics: type: array items: type: object allOf: – #/definitions/basicMetric minimum: 1 description: Métricas vinculadas ao produto e contrato tenantEnvInfo: description: Informações do tenant, ambiente e produtos contratados com suas métricas de usuários nomeados type: object required: – tenantName – tenantDomain – envType – contractedProducts properties: tenantName: type: string description: Nome do tenant tenantDomain: type: string description: Domínio do tenant envType: type: string allOf: – #/definitions/environmentType description: Tipo do ambiente do tenant (PRODUCTION, HOMOLOG, DEMONSTRATION ou DEVELOPMENT) contractedProducts: type: array items: type: object allOf: – #/definitions/contractedProduct minimum: 1 description: Produtos com contrato ativo do tenant e suas métricas de usuários nomeados contractedProduct: description: Produtos contratados com suas métricas de usuários nomeados type: object required: – productName – erpProductId – userNamedMetrics properties: productName: type: string description: Nome do produto erpProductId: type: string description: Id do produto no ERP userNamedMetrics: type: array items: type: string minimum: 1 description: Chaves das métricas de usuários nomeados vinculadas ao produto notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service companyFacade: description: Fachada para gestão de companys type: object required: – erpId – name – identifier properties: id: type: string format: uuid description: Id da company erpId: type: string description: Id da empresa no ERP name: type: string description: Razão social da empresa domainName: type: string description: Domínio da empresa identifier: type: string description: Documento de identificação da empresa (CNPJ/CPF) email: type: string description: E-mail de contato phone: type: string description: Telefone de contato customers: type: array items: type: object allOf: – #/definitions/customer description: Contatos e usuários vinculados à empresa tenants: type: array items: type: object allOf: – #/definitions/tenantInfo description: Tenants da empresa productFacade: description: Fachada para gestão de produtos type: object required: – erpId – family – name properties: id: type: string format: uuid description: Id do produto erpId: type: string description: Id do produto no ERP erpGroupId: type: string description: Código do agrupador do produto no ERP family: type: string description: Família do produto, por exemplo CDU, SAM ou SAAS name: type: string description: Nome do produto description: type: string description: Descrição do produto acronym: type: string description: Acrônimo do produto redirectUrl: type: string description: URL para a qual o usuário é redirecionado após efetuar o login active: type: boolean description: Indica se o produto está ativo default: true allowTrial: type: boolean description: Indica se o produto suporta período de avaliação (trial) default: false trialDays: type: integer format: int64 description: Contém a quantidade de dias que o período de avaliação (trial) do produto dura default: 0 visibilityType: type: string allOf: – #/definitions/productVisibility description: Visibilidade do produto. Quando não informada na criação, o produto é configurado como Apenas tenants selecionados. Para alterar a visibilidade de um produto existente, utilize changeProductVisibility productGroupCode: type: integer format: int64 description: Indica o código do grupo/linha de produto productGroupDescription: type: string description: Descrição do grupo/linha de produto companyContractsFacade: description: Recebe a carga completa de contratos da empresa por meio da integração G5. Contratos e itens ativos ausentes na carga são desativados type: object required: – erpCompanyId properties: erpCompanyId: type: string description: Id da empresa no ERP contracts: type: array items: type: object allOf: – #/definitions/companyContract description: Carga completa dos contratos da empresa planFacade: description: Fachada para gestão de planos type: object required: – productId – name – period – validityStart – isEnable – isDefault – metrics properties: id: type: string format: uuid description: Id do plano productId: type: string format: uuid description: Id do produto name: type: string description: Nome do plano description: type: string description: Descrição do plano period: type: string allOf: – #/definitions/period description: Periodicidade de faturamento do plano validityStart: type: string format: date-time description: Data inicial do plano validityEnd: type: string format: date-time description: Data final do plano isEnable: type: boolean description: Indica se o plano está ativo isDefault: type: boolean description: Indica se o plano é o padrão do produto. Quando o produto possui um único plano, ele é sempre padrão e ativo generated: type: boolean description: Indica se o plano foi gerado pela integração default: true metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas vinculadas ao plano com os respectivos limites de chamadas primitiveList: type: array items: type: object allOf: – #/definitions/primitiveLimit description: Limites de execução configurados por domínio, serviço e primitiva contracts: type: integer format: int64 description: Quantidade de contratos ativos vinculados ao plano contractFacadeInput: description: Fachada para gestão de contratos type: object required: – erpContractId – erpOurCompanyId – contractType – dateStart – isEnable – contractItems properties: contractId: type: string format: uuid description: Id do contrato erpContractId: type: string description: Id do contrato no ERP erpOurCompanyId: type: string description: Id da empresa contratante no ERP contractType: type: integer format: int64 description: Tipo do contrato (1-habilitação, 2-mensalidade) companyId: type: string format: uuid description: Id do cliente erpCompanyId: type: string description: Id do cliente no ERP tenantName: type: string description: Tenant ao qual o contrato está vinculado dateStart: type: string format: date-time description: Data de início do contrato dateEnd: type: string format: date-time description: Data de término do contrato isEnable: type: boolean description: Indica se o contrato está habilitado contractItems: type: array items: type: object allOf: – #/definitions/fullContractItem minimum: 1 description: Lista de itens do contrato contractFacadeOutput: description: Fachada para gestão de contratos type: object required: – contractId – erpContractId – erpOurCompanyId – contractType – companyId – erpCompanyId – companyName – erpFilialId – identifier – phone – dateStart – isEnable – contractItems properties: contractId: type: string description: Id do contrato erpContractId: type: string description: Id do contrato no ERP erpOurCompanyId: type: string description: Id da empresa contratante no ERP ourCompanyName: type: string description: Nome da empresa contratante contractType: type: integer format: int64 description: Tipo do contrato (1-habilitação, 2-mensalidade) companyId: type: string description: Id do cliente erpCompanyId: type: string description: Id do cliente no ERP companyName: type: string description: Nome do cliente erpFilialId: type: string description: Id da filial do cliente no ERP domainName: type: string description: Domínio do cliente tenantName: type: string description: Tenant ao qual o contrato está vinculado identifier: type: string description: CPF/CNPJ do cliente phone: type: string description: Telefone do cliente dateStart: type: string format: date-time description: Data de início do contrato dateEnd: type: string format: date-time description: Data de término do contrato isEnable: type: boolean description: Indica se o contrato está habilitado contractItems: type: array items: type: object allOf: – #/definitions/fullContractItem minimum: 1 description: Lista de itens do contrato metricsFacade: description: Fachada para gestão de métricas type: object required: – name – key – type properties: id: type: string format: uuid description: Id da métrica productId: type: string format: uuid description: Id do produto name: type: string description: Nome da métrica field: type: string allOf: – #/definitions/metricField description: Campo utilizado para mapeamento da chave das métricas (USERS, EMPLOYEE e INSTANCE) description: type: string description: Descrição da métrica key: type: string description: Código único para identificação do contador type: type: string allOf: – #/definitions/metricType description: Tipo de contagem: periódica ou contínua enable: type: boolean description: Indica se a métrica está ativa default: true contracts: type: integer format: int64 description: Quantidade de contratos vinculados à métrica namedUser: type: boolean description: Informa se a métrica controla usuários nomeados default: false allowExceed: type: boolean description: Informa se a métrica permite o cadastro de excedentes para usuários nomeados default: false linkedProducts: type: array items: type: object allOf: – #/definitions/productInfo description: Produtos vinculados à métrica accountFacade: description: Fachada para gestão de contas type: object required: – erpId – name – identifier properties: id: type: string format: uuid description: Id da conta erpId: type: integer format: int64 description: Id da conta no ERP name: type: string description: Razão social do cliente domainName: type: string description: Domínio da empresa identifier: type: string description: Documento de identificação do cliente (CNPJ/CPF) status: type: string description: Status da conta. O padrão é A para conta ativa default: A phone: type: string description: Telefone de contato bpoId: type: integer format: int64 description: Id do BPO tenants: type: array items: type: object allOf: – #/definitions/tenantsFacade description: Tenants vinculados à conta contactFacade: description: Fachada para gestão de contatos type: object required: – firstName – lastName – email – locale – accountId properties: id: type: string format: uuid description: Id do contato firstName: type: string description: Primeiro nome do contato lastName: type: string description: Sobrenome do contato email: type: string description: E-mail do contato locale: type: string description: Idioma do contato accountId: type: string description: Id da conta vinculada tenantsFacade: description: Fachada para gestão de tenants type: object required: – erpId – accountId – domainName – environment – tenantName – password properties: id: type: string format: uuid description: Id do tenant erpId: type: integer format: int64 description: Id do tenant no ERP accountId: type: string description: Id da conta domainName: type: string description: Domínio do tenant environment: type: string allOf: – #/definitions/environmentType description: Ambiente do tenant tenantName: type: string description: Nome do tenant password: type: string description: Senha do tenant contractItemsFacade: description: Fachada para gestão de itens contratados type: object required: – contractId – planId properties: id: type: string format: uuid description: Id do item contratado contractId: type: string description: Id do contrato planId: type: string description: Id do plano validityStart: type: string format: date-time description: Data inicial da validade do item de contrato validityEnd: type: string format: date-time description: Data final da validade do item de contrato isEnable: type: boolean description: Indica se o item contratado está ativo default: true planMetricFacade: description: Fachada para gestão de vínculos entre planos e métricas type: object required: – metricId – planId – qtdLimit properties: id: type: string format: uuid description: Id do vínculo entre plano e métrica metricId: type: string description: Id da métrica planId: type: string description: Id do plano qtdLimit: type: integer format: int64 description: Quantidade de chamadas permitidas, maior que zero productGroupFacade: description: Fachada para gestão de grupos dos produtos (linhas de produto) type: object required: – productGroupCode – productGroupDescription properties: id: type: string format: uuid description: Id da linha de produto productGroupCode: type: integer format: int64 description: Código da linha de produto vindo da TIC productGroupDescription: type: string description: Descrição da linha de produto alertConsumptionFacadeInput: description: Fachada para gestão de alertas de consumo de produtos disponíveis ao tenant atual type: object required: – metricId – percentage – roles – productId properties: id: type: string format: uuid description: Id do alerta metricId: type: string description: Id da métrica, que deve estar vinculada ao produto percentage: type: integer format: int64 description: Percentual de consumo que dispara a notificação, entre 50 e 100 minimum: 50 maximum: 100 roles: type: array items: type: string minimum: 1 description: Nomes dos papéis existentes que serão notificados quando o consumo atingir o percentual informado productId: type: string description: ID do produto. Produtos configurados como Apenas tenants selecionados exigem vínculo explícito entre o produto e o tenant atual; produtos configurados como Todos os tenants não exigem esse vínculo alertMessageFacade: description: Fachada para gestão de mensagens a serem enviadas nos alertas type: object required: – subject – content – contentType – notificationType properties: id: type: string description: Id da mensagem subject: type: string maxLength: 255 description: Assunto da mensagem content: type: string description: Conteúdo da mensagem, com suporte a variáveis de produto, métrica e percentuais de consumo e do alerta contentType: type: string allOf: – #/definitions/contentType description: Tipo do conteúdo da mensagem notificationType: type: string allOf: – #/definitions/notificationType description: Tipo da notificação a ser enviada isDefault: type: boolean description: Indica se a mensagem é a padrão global ou customizada por produto default: false productId: type: string description: Id do produto da mensagem customizada. Obrigatório quando isDefault é false productName: type: string description: Nome do produto utilizado para mensagens customizadas productErpId: type: string description: ErpId do produto utilizado para mensagens customizadas productGroupContactFacade: description: Fachada para gestão dos e-mails de contato dos grupos de produtos type: object required: – groupId – email properties: id: type: string format: uuid description: Id do contato groupId: type: string format: uuid description: Id do grupo de produtos email: type: string description: E-mail do grupo de produtos isDefault: type: boolean description: Define o contato como default, passando a receber os e-mails de todos os grupos de produtos. default: false genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

1 Sim  1 Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação