Mais pesquisados:Customização, Tutorial, Documentação

digital

353 views 1 22/10/2018 Atualizado em 21/10/2024 integrador

2.0info: 16.4.0 digital description: Serviço para gerenciar os tenants e usuários criados automaticamente através dos canais de aquisições digitais (landpages, try & buy, etc…) 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 responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/ticketStatus description: Status 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 in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/ticketStatus description: Status 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: Retorna uma lista com todos os produtos tags: – Queries 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. limit: type: integer format: int64 description: Quantidade de produtos. 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/product minimum: 1 description: Lista contendo os produtos conforme solicitado total: type: integer format: int64 description: Quantidade total de produtos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todos os produtos tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: Índice do primeiro produto. in: query type: integer format: int64 – name: limit description: Quantidade de produtos. 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/product minimum: 1 description: Lista contendo os produtos conforme solicitado total: type: integer format: int64 description: Quantidade total de produtos. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProduct: post: description: Retorna um produto identificado pelo seu id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: uuid do produto responses: 200: description: Ok schema: type: object required: – product properties: product: type: object allOf: – #/definitions/product description: produto contendo as definições do cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna um produto identificado pelo seu id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: uuid do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – product properties: product: type: object allOf: – #/definitions/product description: produto contendo as definições do cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getTour: post: description: Retorna se o usuário que chamou o serviço fez tour, caso não exista nenhuma tour com o nome informado, ela será criada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome que foi dado para a tour no produto, ex: platform-home-tour responses: 200: description: Ok schema: type: object required: – isTourDone properties: isTourDone: type: boolean description: Retorna se tour está feita (true) ou não (false) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se o usuário que chamou o serviço fez tour, caso não exista nenhuma tour com o nome informado, ela será criada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: name description: Nome que foi dado para a tour no produto, ex: platform-home-tour in: query required: true type: string responses: 200: description: Ok schema: type: object required: – isTourDone properties: isTourDone: type: boolean description: Retorna se tour está feita (true) ou não (false) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getDomains: post: description: Retorna todos os domínios 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 domais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os domínios 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 domais 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: Qual página deve ser retornada limit: type: integer format: int64 description: Quantidade de registros por página 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: Total de registros na base customers: type: array items: type: object allOf: – #/definitions/digitalCustomer minimum: 1 description: Cliente de um produto digital 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: Qual página deve ser retornada in: query required: true type: integer format: int64 – name: limit description: Quantidade de registros por página 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: Total de registros na base customers: type: array items: type: object allOf: – #/definitions/digitalCustomer minimum: 1 description: Cliente de um produto digital 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 responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/serviceDef minimum: 1 description: Retorna a lista de serviços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os serviços tags: – Queries x-senior-visibility: PUBLIC parameters: – name: domains description: Domínios in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/serviceDef minimum: 1 description: Retorna a lista de serviços 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: Lista dos serviços responses: 200: description: Ok schema: type: object required: – primitives properties: primitives: type: array items: type: object allOf: – #/definitions/primitiveDef minimum: 1 description: Primitivas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductInvitationRoles: post: description: API DEPRECIADA: null | DATA: 2021-01-21 | Retorna quais papeis estão associados ao 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: UUID do produto responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/digitalRole minimum: 1 description: Identificadores dos papeis que estão associados ao produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: null | DATA: 2021-01-21 | Retorna quais papeis estão associados ao trial do produto tags: – Queries deprecated : true x-senior-visibility: PUBLIC parameters: – name: productAcronym description: UUID 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: Identificadores dos papeis que estão associados ao produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getPlansByProduct: post: description: Retorna todos os planos 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: – plans properties: plans: type: array items: type: object allOf: – #/definitions/planDefinition minimum: 1 description: Planos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os planos 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: – plans properties: plans: type: array items: type: object allOf: – #/definitions/planDefinition minimum: 1 description: Planos 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 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 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/contractInput minimum: 1 description: Retorna uma lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os contratos ativos do tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenantName description: Nome do tenant in: query required: true type: string – name: productAcronyms description: Acrônimo dos produtos in: query type: array items: type: string responses: 200: description: Ok schema: type: object required: – contracts properties: contracts: type: array items: type: object allOf: – #/definitions/contractInput minimum: 1 description: Retorna uma lista de contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionByMetricKey: post: description: Retorna dados de consumo a partir da chave de métrica recebida 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 – planName – activePlan – currentPlan properties: metricOfPlan: type: object allOf: – #/definitions/metric description: Eventos de negócio executados que estão no plano planName: type: string description: Nome do plano activePlan: type: boolean description: Plano ativo currentPlan: type: boolean description: Plano vigente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna dados de consumo a partir da chave de métrica recebida 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 – planName – activePlan – currentPlan properties: metricOfPlan: type: object allOf: – #/definitions/metric description: Eventos de negócio executados que estão no plano planName: type: string description: Nome do plano activePlan: type: boolean description: Plano ativo currentPlan: type: boolean description: Plano vigente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionByMetricKeys: post: description: Retorna dados de consumo a partir das chaves de métricas recebidas 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/metric minimum: 1 description: Eventos de negócio executados que estão no plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna dados de consumo a partir das chaves de métricas recebidas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: metricKeys description: Chaves de identificação dos contadores in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – metricsOfPlan properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados que estão no plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getContract: post: description: Busca um contrato tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: identificador do contrato responses: 200: description: Ok schema: type: object required: – contract properties: contract: type: object allOf: – #/definitions/contractInput description: contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca um contrato tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: identificador do contrato in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contract properties: contract: type: object allOf: – #/definitions/contractInput description: contrato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listContracts: post: description: lista os contratos com paginação tags: – Queries 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. limit: type: integer format: int64 description: Quantidade de produtos. customerFilter: type: string description: Filtrar pelo nome do cliente productFilter: type: string description: Filtrar pelo produto enable: type: boolean description: Filtrar somente contratos ativos default: true responses: 200: description: Ok schema: type: object required: – contracts – total properties: contracts: type: array items: type: object allOf: – #/definitions/contractInput minimum: 1 description: contratos total: type: integer format: int64 description: total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: lista os contratos com paginação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: Índice do primeiro produto. in: query type: integer format: int64 – name: limit description: Quantidade de produtos. in: query type: integer format: int64 – name: customerFilter description: Filtrar pelo nome do cliente in: query type: string – name: productFilter description: Filtrar pelo produto in: query type: string – name: enable description: Filtrar somente contratos ativos in: query type: boolean responses: 200: description: Ok schema: type: object required: – contracts – total properties: contracts: type: array items: type: object allOf: – #/definitions/contractInput minimum: 1 description: contratos total: type: integer format: int64 description: total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listCompany: post: description: Lista as empresas com páginação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: offset limit: type: integer format: int64 description: limit filter: type: string description: filter responses: 200: description: Ok schema: type: object required: – companys – total properties: companys: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: empresas total: type: integer format: int64 description: total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as empresas com páginação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: offset description: offset in: query type: integer format: int64 – name: limit description: limit in: query type: integer format: int64 – name: filter description: filter in: query type: string responses: 200: description: Ok schema: type: object required: – companys – total properties: companys: type: array items: type: object allOf: – #/definitions/company minimum: 1 description: empresas total: type: integer format: int64 description: total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getCompanyByTenant: post: description: API DEPRECIADA: Deprecated. Replaced by `getAccountByTenantName`. | DATA: 2025-02-27 | 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/company description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API DEPRECIADA: Deprecated. Replaced by `getAccountByTenantName`. | DATA: 2025-02-27 | 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/company description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getCompany: post: description: Busca os dados da empresa 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 da empresa responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/company description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os dados da empresa pelo ID tags: – Queries 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/company description: Dados da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getNewCustomersNumber: post: description: Retorna número de clientes ativos por 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: – products properties: products: type: array items: type: object allOf: – #/definitions/customersMonthly minimum: 1 description: Estatísticas de número de clientes por produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna número de clientes ativos por 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: – products properties: products: type: array items: type: object allOf: – #/definitions/customersMonthly minimum: 1 description: Estatísticas de número de clientes por produto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getTotalCustomers: post: description: 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: isNew: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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: isNew: type: integer format: int64 description: 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: Retorna as permissões 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: Retorna as permissões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getPlan: post: description: Retorna a definição do plano tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do plano responses: 200: description: Ok schema: type: object required: – plan properties: plan: type: object allOf: – #/definitions/planDefinition description: Definição do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do plano tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Identificador do plano in: query required: true type: string responses: 200: description: Ok schema: type: object required: – plan properties: plan: type: object allOf: – #/definitions/planDefinition description: Definição do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listMetrics: post: description: Lista todas as métricas 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: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as métricas 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: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listMetricsEnable: post: description: Lista todas as métricas ativas 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: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as métricas ativas 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: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/topConsumptions: post: description: Retorna os clientes que estão extrapolando o consumo definido do plano 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: – customers properties: customers: type: array items: type: object allOf: – #/definitions/customerConsumption minimum: 1 description: Consumo de cada cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os clientes que estão extrapolando o consumo definido do plano 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: – customers properties: customers: type: array items: type: object allOf: – #/definitions/customerConsumption minimum: 1 description: Consumo de cada cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionMetrics: post: description: Retorna o consumo das chamadas do eventos de negócio conforme o plano atribuido do cliente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId – companyId properties: prodId: type: string description: Id do produto companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados que estão no plano metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados fora do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o consumo das chamadas do eventos de negócio conforme o plano atribuido do cliente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: prodId description: Id do produto in: query required: true type: string – name: companyId description: Id da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados que estão no plano metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados fora do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionSixMonth: post: description: Retorna o consumo das chamadas últimos seis meses tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId – companyId properties: prodId: type: string description: Id do produto companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – metrics properties: metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio (Métricas) executados últimos seis meses 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o consumo das chamadas últimos seis meses tags: – Queries x-senior-visibility: PUBLIC parameters: – name: prodId description: Id do produto in: query required: true type: string – name: companyId description: Id da empresa 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: Eventos de negócio (Métricas) executados últimos seis meses 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getConsumptionPrimitives: post: description: Retorna o consumo das chamadas de primitivas conforme o plano atribuido do cliente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId – companyId properties: prodId: type: string description: Id do produto companyId: type: string description: Id da empresa responses: 200: description: Ok schema: type: object required: – primitivesOfPlan – primitivesOutPlan properties: primitivesOfPlan: type: array items: type: object allOf: – #/definitions/primitiveCalls minimum: 1 description: Primitivas executadas definidas no plano primitivesOutPlan: type: array items: type: object allOf: – #/definitions/primitiveCalls minimum: 1 description: Primitivas executadas fora do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o consumo das chamadas de primitivas conforme o plano atribuido do cliente tags: – Queries x-senior-visibility: PUBLIC parameters: – name: prodId description: Id do produto in: query required: true type: string – name: companyId description: Id da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – primitivesOfPlan – primitivesOutPlan properties: primitivesOfPlan: type: array items: type: object allOf: – #/definitions/primitiveCalls minimum: 1 description: Primitivas executadas definidas no plano primitivesOutPlan: type: array items: type: object allOf: – #/definitions/primitiveCalls minimum: 1 description: Primitivas executadas fora do plano 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: maquiná 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: maquiná 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getProductServices: post: description: Retorna os domínios/serviços associados ao produto 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/Serviços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os domínios/serviços associados ao produto 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/Serviços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getServicesByProductId: post: description: Retorna os domínios/serviços associados ao produto 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/Serviços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os domínios/serviços associados ao produto 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/Serviços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getCalls: post: description: 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: period: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/call minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getMyProducts: post: description: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getAlerts: post: description: 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: page: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – data – total properties: data: type: array items: type: object allOf: – #/definitions/alert minimum: 1 description: total: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: limit description: in: query required: true type: integer format: int64 – name: page description: 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: total: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/billingLastUpdate: post: description: tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – update properties: update: type: string format: date-time description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – update properties: update: type: string format: date-time description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/consumption: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – contractId – month properties: contractId: type: string description: month: type: string format: date-time description: responses: 200: description: Ok schema: type: object required: – metricsOfPlan – metricsOutOfPlan – planName properties: metricsOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados que estão no plano metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados fora do plano planName: type: string description: Nome do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: contractId description: in: query required: true type: string – name: month description: 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: Eventos de negócio executados que estão no plano metricsOutOfPlan: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Eventos de negócio executados fora do plano planName: type: string description: Nome do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/listPlansExceedingData: post: description: Lista os planos com mais clientes que excederam o limite contratado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: Identificador do produto responses: 200: description: Ok schema: type: object required: – plansData properties: plansData: type: array items: type: object allOf: – #/definitions/customerConsumptionByPlan minimum: 1 description: Dados de limite excedido dos planos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os planos com mais clientes que excederam o limite contratado tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: Identificador do produto in: query required: true type: string responses: 200: description: Ok schema: type: object required: – plansData properties: plansData: type: array items: type: object allOf: – #/definitions/customerConsumptionByPlan minimum: 1 description: Dados de limite excedido dos planos 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: Identificador 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/company minimum: 1 description: Dados da empresa 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: Identificador 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/company minimum: 1 description: Dados da empresa 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: Identificador 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/company minimum: 1 description: Clientes que já logaram 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: Identificador 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/company minimum: 1 description: Clientes que já logaram 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getDigitalUrl: post: description: Busca a url do projeto digital-frontend tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – digitalUrl properties: digitalUrl: type: string description: Url do digital 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a url do projeto digital-frontend tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – digitalUrl properties: digitalUrl: type: string description: Url do digital 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: Utilizada para executar as migrations e atualizar 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: reason: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Utilizada para executar as migrations e atualizar 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: reason: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/queries/getAccountByTenantName: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: responses: 200: description: Ok schema: type: object required: – id – erpId – identifier – name – status – tenant properties: id: type: string description: erpId: type: string description: identifier: type: string description: name: type: string description: status: type: string description: tenant: type: object allOf: – #/definitions/tenant description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenantName description: 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: erpId: type: string description: identifier: type: string description: name: type: string description: status: type: string description: tenant: type: object allOf: – #/definitions/tenant description: 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: Efetua todo processo de criação de conta e configuração de tenant 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 email 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: null | DATA: 2024-10-11 | Serviço para criar uma conta temporaria até confirmar o email 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 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: Base Url 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: Ok 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/createAccount__14: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – erpId – firstName – lastName – businessEmail – password – companyName – companyPhone – product properties: erpId: type: string description: Id 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: Base Url 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: Ok 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: 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 environments: type: array items: type: object allOf: – #/definitions/environment minimum: 1 description: Ambientes que serão criados (Produção, Desenvolvimento, Homologação) product: type: string description: Sigla do produto digital baseUrl: type: string description: 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 indetificação do cliente. O código é do tipo string devido a possibilidade de integrar 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 message: type: string description: Mensagem que será enviada por email para SeniorTI responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createProduct: post: description: Cria um novo produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name – description – acronym – redirectUrl – active properties: 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 responses: 200: description: Ok schema: type: object required: – idProduct properties: idProduct: type: string description: String com o id do produto incluído 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: Contém a quantidade de dias que o período de avaliação (trial) do produto dura. Se o valor de allowTrial for false, este valor é ignorado responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Booleano com o resultado da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateProduct: post: description: Altera URL e templates de email de ativação de um produto tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – idProduct – name – description – acronym – redirectUrl – active properties: idProduct: type: string description: uuid 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 responses: 200: description: Ok schema: type: object required: – idProduct properties: idProduct: type: string description: String com o id do produto alterado 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: locale desejado acronym: type: string description: chaves responses: 200: description: Ok schema: type: object required: – bundles properties: bundles: type: array items: type: object allOf: – #/definitions/bundle minimum: 1 description: bundle 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 email utilizados na ativação do produto responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 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 email utilizados para convidar usuários para a plataforma responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/restoreDefaultProductEmailTemplates: post: description: Restaura os textos padrões dos templates de email 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: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/restoreDefaultInviteEmailTemplates: post: description: Restaura os textos padrões dos templates de email 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: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/inviteUsers: post: description: Convidar usuários 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: lista novos usuários existingUsers: type: array items: type: string description: Lista de usuário existentes message: type: string description: Mensagem do convite baseUrl: type: string description: Base Url default: https://platform.senior.com.br/login/invite.html?register= responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 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: Booleano indicando o sucesso da operação 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 email 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ário 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 que recebido por email com as informação do usuário e seus papéis responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/activateInvite: post: description: Ativa o convite que foi recebido por email 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: Password do usuário email: type: string description: Email que foi retornado da 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: ok 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 que foi recebido tenantDomain: type: string description: Domínio que foi retornado da primitiva validateInvite tenantName: type: string description: Tenant que foi retornado da primitiva validateInvite email: type: string description: Email que foi retornado da primitiva validateInvite login: type: string description: Username do usuário baseUrl: type: string description: base Url responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setInviteRoleList: post: description: Atribui uma lista de ids de papeis 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: null | 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/newTour: post: description: Cria uma nova tour tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome da nova tour que será criada, ex: cockpit-home-tour responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateTour: post: description: Atualiza o status da tour para feita, para o usuário que fez a requisição tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome da tour que deve ser atualizada responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se a operação foi concluída com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/resetTour: post: description: Muda o status da tour para não feita para todos os usuários da tour informada tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: nome da tour que deve ser resetada responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se a operação foi concluída com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/newPlan: post: description: Cadastrar um novo plano tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId – name – period – vigStart – isEnable – isDefault – metrics properties: id: type: string description: id prodId: type: string description: acronym do produto name: type: string description: nome description: type: string description: descrição period: type: integer format: int64 description: duração do plano vigStart: type: string format: date-time description: data inicial do plano vigEnd: type: string format: date-time description: data final do plano isEnable: type: boolean description: plano ativado ou desativado isDefault: type: boolean description: Define se é um plano padrão metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: metricas primitiveList: type: array items: type: object allOf: – #/definitions/primitiveLimit description: configuração dos limites das primitivas responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateContractInBatch: post: description: 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 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: acronym do produto companies: type: array items: type: string description: lista de identificação de clientes para o plano, caso omitido, todos serã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: identificador do produto planId: type: string description: identificador do plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updatePlan: post: description: Atualizar o plano tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – prodId – name – period – vigStart – isEnable – isDefault – metrics properties: id: type: string description: id prodId: type: string description: acronym do produto name: type: string description: nome description: type: string description: descrição period: type: integer format: int64 description: duração do plano vigStart: type: string format: date-time description: data inicial do plano vigEnd: type: string format: date-time description: data final do plano isEnable: type: boolean description: plano ativado ou desativado isDefault: type: boolean description: Define se é um plano padrão metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: metricas primitiveList: type: array items: type: object allOf: – #/definitions/primitiveLimit description: configuração dos limites das primitivas responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/sendWelcomeEmail: post: description: Envia o email de boas vindas da criação de 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: Tenant para qual o email será enviado (o email será enviado pra quem tentou criar a conta) acronym: type: string description: Cnpj responses: 200: description: Ok schema: type: object required: – sent properties: sent: type: boolean description: Email enviado com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/newContract: post: description: Novo contrato tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – companyId – productId – planId – dateStart – dateEnd – isEnable properties: companyId: type: string description: identificador da empresa productId: type: string description: identificador do produto planId: type: string description: identificador do plano dateStart: type: string format: date-time description: data início do contrato dateEnd: type: string format: date-time description: data final do contrato isEnable: type: boolean description: contrato habilitado responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateContract: post: description: Atualizar contrato tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – companyId – productId – planId – dateStart – dateEnd – isEnable properties: id: type: string description: identificador do contrato companyId: type: string description: identificador da empresa productId: type: string description: identificador do produto planId: type: string description: data final do contrato dateStart: type: string format: date-time description: data início do contrato dateEnd: type: string format: date-time description: data final do contrato isEnable: type: boolean description: contrato habilitado responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/newCompany: post: description: Cadastrar empresa tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – company properties: company: type: object allOf: – #/definitions/company description: Empresa responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/saveProductPermissions: post: description: Salva as permissões do produto 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: Papéis responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/newMetric: post: description: Adicionar uma nova métrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – prodId – name – metrickey – type properties: prodId: type: string description: Id do produto name: type: string description: Nome da métrica description: type: string description: Decrição da métrica metrickey: type: string description: Codigo unico para identificação do contador type: type: integer format: int64 description: Tipo de contagem, periodo ou continuo enable: type: boolean description: Ativo default: true responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/updateMetric: post: description: Atualizar métrica tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – name – type properties: id: type: string description: id da métrica name: type: string description: Nome da métrica description: type: string description: Decrição da métrica type: type: integer format: int64 description: Tipo de contagem, periodo ou continuo enable: type: boolean description: Ativo default: true responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 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/Serviços responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: ok 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: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/attachTenant: post: description: Vincular tenants ao 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 Company domainName: type: string description: Domínio do tenant tenantName: type: string description: Nome do tenant responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna o resultado da operação message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/createTenantAccount: post: description: Cadastrar tenant 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 responses: 200: description: Ok schema: type: object required: – company properties: company: type: object allOf: – #/definitions/company description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/detachTenant: post: description: Desvincular tenants do cliente 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 Company tenantName: type: string description: Lista de tenants responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna o resultado da operação message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/setDefaultPlan: post: description: 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: Retorna o resultado da operação message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/actions/activateDeactivatePlan: post: description: 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: Ativo default: false responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Retorna o resultado da operação message: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/signals/purgeTenant: post: description: Desabilita os tenants que estão sem uso por um determinado período de tempo (atualmente 6 meses) tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: baseUrl: type: string description: Base Url 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 possui 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/billing: post: description: Serviço para Bilhetagem tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – counterKey – numcalls properties: counterKey: type: string description: Chave de identificação que foi cadastrada no contador numcalls: type: integer format: int64 description: Valor da chamada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/billingBatch: post: description: Serviço para Bilhetagem em lote 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: Itens para bilhetagem responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/synchronize: post: description: Sincroniza todos os tenants 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: Sincronizar o tenant 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: Faz refresh na materialized view de billing para o 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/updateMachine: post: description: Atualiza os estados da máquina tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: machines: type: array items: type: string description: Identificação das máquinas de estado que serão reiniciadas 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/task: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idTask – period – productId – conditions properties: idTask: type: string description: period: type: integer format: int64 description: productId: type: string description: conditions: type: array items: type: object allOf: – #/definitions/condition minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/signals/updateAnalytics: post: description: Atualizar analytics tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digital/events/productActivated: post: description: Informa que um produto foi ativado em uma conta digital 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 que foi ativado productRoles: type: array items: type: string minimum: 1 description: Papéis do produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/taskEvent: post: description: 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: tenants: type: array items: type: string minimum: 1 description: productId: type: string description: runDate: type: string format: date-time description: 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: Nome do tenant userName: type: string description: Nome do usuário que ativou o produto productAcronym: type: string description: Sigla do produto que foi ativado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/cantLogin: post: description: Informa que não foi possível fazer o 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 do usuário que ativou o produto productAcronym: type: string description: Sigla do produto que foi ativado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/createdAccount: post: description: Informa que a conta foi criada com sucesso 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 do usuário que ativou o produto productAcronym: type: string description: Sigla do produto que foi ativado 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 que o erro ocorreu 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: Nome do tenant userName: type: string description: Nome completo do usuário usuario@tenant.com.br productAcronym: type: string description: Acrônimo do produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/events/alertUsage: post: description: 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: content: type: string description: tenantName: type: string description: domainName: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /digital/apis/company: post: description: 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: 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: array items: #/definitions/companyFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/company/{id}: get: description: 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: 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: 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: 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: array items: #/definitions/productFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/product/{id}: get: description: 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: 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: Fachada criada para receber os contratos através da integração G5 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: 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: 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: array items: #/definitions/planFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/plan/{id}: get: description: 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: 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: 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 /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: 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: 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: Facahada 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: Facahada 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: array items: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/contact/{id}: get: description: Facahada 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: Facahada 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: Facahada 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: array items: #/definitions/tenantsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digital/apis/tenants/{id}: get: description: Facahada 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 definitions: ticketStatus: description: Status da criação da conta type: string enum: – STARTED – TENANTCREATED – APISIGNED – USERCREATED – FINISHED – USEREXIST – ERROR upDown: description: type: string enum: – UP – DOWN environmentType: description: type: string enum: – PRODUCTION – HOMOLOG – DEMONSTRATION – DEVELOPMENT planPeriod: description: type: string enum: – DIARIO – SEMANAL – MENSAL – ANUAL metricType: description: type: string enum: – PERIOD – CONTINUOUS userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – 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: Produto 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/planPeriod description: Período do plano planActive: type: boolean description: Plano ativo planDefault: type: boolean description: Plano padrao planValidityStart: type: string format: date-time description: Vegencia inicial do plano planValidityEnd: type: string format: date-time description: Vegencia final do plano planMetrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: Métricas do plano no contrato billingItem: description: Representa os dados necessários para efetuar uma bilhetagem type: object required: – counterKey – numcalls properties: counterKey: type: string description: Chave de identificação que foi cadastrada no contador numcalls: type: integer format: int64 description: Valor da chamada 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: Contrato habilitado billingPeriod: type: integer format: int64 description: Período de faturamento 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 type: object required: – erpProductId – isEnable – instanceCount – employeeCount – userCount properties: erpProductId: type: string description: Id do produto no ERP isEnable: type: boolean description: Item habilitado instanceCount: type: integer format: int64 description: Contagem de instâncias employeeCount: type: integer format: int64 description: Contagem de colaboradores userCount: type: integer format: int64 description: Contagem de usuários tenant: description: discriminator: _discriminator type: object required: – envType – name – domainName – _discriminator properties: envType: type: string allOf: – #/definitions/environmentType description: name: type: string description: domainName: type: string description: info: type: string description: _discriminator: type: string description: tenantInfo: description: allOf: – #/definitions/tenant – type: object properties: id: type: string description: admin: type: object allOf: – #/definitions/administrator description: environment: description: type: object required: – type properties: confirmEmail: type: boolean description: default: false type: type: string allOf: – #/definitions/environmentType description: inviteDefinition: description: Representa um tipo de convite para usuários acessarem da plataforma ou de 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: Lista com os ids dos papeis que estão associados a este convite product: description: Representa um produto type: object required: – id – name – description – acronym – redirectUrl – active – allowTrial – trialDays properties: id: type: string description: uuid 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: Contém a quantidade de dias que o período de avaliação (trial) do produto dura. Se o valor de allowTrial for false, este valor é 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(estão sendo utilizados os mesmos nomes dos campos definidos no 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 email 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 email de ativação de produto posActivatedProductEmailTemplate: type: object allOf: – #/definitions/emailTemplate description: Template de email pós-ativação de produto inviteTemplates: description: Representa os templates de email 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 email de convite posInviteEmailTemplate: type: object allOf: – #/definitions/emailTemplate description: Template de email pós convite emailTemplate: description: Representa um template de email type: object required: – subject – body properties: subject: type: string description: Assunto do email body: type: string description: Corpo do email bundle: description: Representa um template de email type: object required: – key – value properties: key: type: string description: Assunto do email value: type: string description: Corpo do email primitiveDef: description: Representa uma primitiva type: object required: – domainName – serviceName – name properties: domainName: type: string description: domínio serviceName: type: string description: serviço name: type: string description: nome da primitiva primitiveCalls: description: type: object required: – domainName – serviceName – primitive – qtdEx properties: domainName: type: string description: domínio serviceName: type: string description: serviço primitive: type: string description: nome da primitiva qtdLimit: type: integer format: int64 description: Quantidade de chamadas permitidas percent: type: integer format: int64 description: Porcentagem qtdEx: type: integer format: int64 description: Quantidade de chamadas serviceDef: description: Representa um serviço type: object required: – domainName – serviceName properties: domainName: type: string description: domínio serviceName: type: string description: 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 companyId: type: string description: identificador da empresa companyName: type: string description: Nome da empresa cnpj: type: string description: cnpj phone: type: string description: telefone productId: type: string description: identificador 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: contrato ativado ou desativado planName: type: string description: Nome do plano planDescription: type: string description: Descrição do plano chargingPrimitive: description: Definição charging 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 destservice: type: string description: serviço sourceDomain: type: string description: domain name sourceService: type: string description: service name primitive: type: string description: primitiva syncdate: type: string format: date-time description: date synchronize numcalls: type: integer format: int64 description: numero de execuções realizadas chargingBusiness: description: chargingBusiness type: object required: – domainName – tenantName – counterkey – numcalls – syncdate – processdate properties: domainName: type: string description: Domínio tenantName: type: string description: Tenant counterkey: type: string description: Chave do contador numcalls: type: integer format: int64 description: Numéro de chamadas syncdate: type: string format: date-time description: Data da sincronização processdate: type: string format: date-time description: Data da 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: permissão ativa digitalCustomer: description: Representa um cliente digital type: object required: – companyId – name – trialStartDate – trial – isNew properties: companyId: type: string description: company Id name: type: string description: Nome do cliente trialStartDate: type: string format: date-time description: Data que o cliente se cadastrou para trial trial: type: boolean description: Se está fazendo um trial isNew: type: boolean description: É um cliente novo percent: type: integer format: int64 description: Porcentagem de consumo totalLimit: type: integer format: int64 description: Total de execuções permitidas totalExecutions: type: integer format: int64 description: Total de execuções limit: type: boolean description: Retorna verdadeiro quando pelo menos uma das métricas adicionadas ao plano do cliente já passou do limite de execução contractId: type: string description: Retorna verdadeiro quando existe um contrato customersMonthly: description: Número de clientes por mês e ano type: object required: – customerNumber – month properties: customerNumber: type: integer format: int64 description: Número de clientes month: type: string format: date-time description: Mês e ano que se cadastraram productPermission: description: Permissão 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: Plano type: object required: – prodId – name – period – vigStart – isEnable – isDefault – metrics – primitiveList properties: id: type: string description: id prodId: type: string description: acronym do produto name: type: string description: nome description: type: string description: descrição period: type: integer format: int64 description: duração do plano vigStart: type: string format: date-time description: data inicial do plano vigEnd: type: string format: date-time description: data final do plano isEnable: type: boolean description: plano ativado ou desativado isDefault: type: boolean description: Define se é um plano padrão metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: metricas primitiveList: type: array items: type: object allOf: – #/definitions/primitiveLimit minimum: 1 description: configurações do limite das primitivas customerConsumption: description: Consumo 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: Contrato id customerId: type: string description: Customer Id 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 chamdas executas percent: type: integer format: int64 description: Porcentagem do totalLimit e totalNumCalls planName: type: string description: Nome do plano planId: type: string description: Id do plano metric: description: Métrica type: object required: – id properties: id: type: string description: id name: type: string description: Nome description: type: string description: Descrição metrickey: type: string description: Chave type: type: integer format: int64 description: Tipo de contagem, período ou continua metricType: type: string allOf: – #/definitions/metricType description: Nome do Tipo de contagem, período ou continua enable: type: boolean description: Ativa qtdEx: type: integer format: int64 description: Quantidade chamadas que foram executadas da métrica qtdLimit: type: integer format: int64 description: Quantidade de chamadas permitidas percent: type: integer format: int64 description: Porcentagem month: type: string format: date-time description: Mês que foi executado as chamadas 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 acronym: type: string description: Acronym do produto dateStart: type: string format: date-time description: Data que inicou a máquina dateUpdate: type: string format: date-time description: Última atualização state: type: string description: Estado atual tenant: type: string description: Nome do tenant tenantDomain: type: string description: Domínio do tenant company: description: Definição da empresa type: object required: – name – cnpj – phone – tenantName – domainName – customers properties: id: type: string description: Id erpid: type: string description: Id no ERP name: type: string description: Nome cnpj: type: string description: CNPJ phone: type: string description: Telefone tenantName: type: string description: Tenant domainName: type: string description: Domínio customers: type: array items: type: object allOf: – #/definitions/customer minimum: 1 description: Customers environment: type: string allOf: – #/definitions/environmentType description: Ambiente accountId: type: string description: Id da conta customer: description: Definição de um customer type: object required: – firstName – lastName – email properties: id: type: string description: Id firstName: type: string description: Primeiro nome lastName: type: string description: Último nome email: type: string description: Email locale: type: string description: Locale 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 primitiveService: type: string description: Serviço primitiveCommand: type: string description: Command executionsLimit: type: integer format: int64 description: limite de execuções da primitiva condition: description: type: object required: – operator – resultValue – name – domainName – serviceName properties: operator: type: string description: resultValue: type: integer format: int64 description: name: type: string description: domainName: type: string description: serviceName: type: string description: productService: description: type: object required: – domainName – serviceName properties: domainName: type: string description: serviceName: type: string description: call: description: type: object required: – endpoint – tenant – numcalls properties: endpoint: type: object allOf: – #/definitions/primitiveDef description: tenant: type: string description: numcalls: type: integer format: int64 description: myProduct: description: type: object required: – productName – contractId – contracted – planName – usage properties: productName: type: string description: contractId: type: string description: contracted: type: string format: date-time description: planName: type: string description: usage: type: integer format: int64 description: alert: description: type: object required: – id – title – content – dateAlert properties: id: type: string description: type: string description: content: type: string description: dateAlert: type: string format: date-time description: customerConsumptionByPlan: description: Consumo dos clientes por planol 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: 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 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: type: object required: – erpId – name – identifier properties: id: type: string format: uuid description: id company erpId: type: string description: id no ERP name: type: string description: Razão Social da empresa domainName: type: string description: Domínio da empresa identifier: type: string description: Identificador da empresa email: type: string description: Email de contato phone: type: string description: Telefone de contato customers: type: array items: type: object allOf: – #/definitions/customer description: Customers da empresa tenants: type: array items: type: object allOf: – #/definitions/tenantInfo description: Tenants da empresa productFacade: description: type: object required: – erpId – family – name properties: id: type: string format: uuid description: Id do produto erpId: type: string description: Id no ERP erpGroupId: type: string description: Código do Agrupador family: type: string description: Familia do produto CDU, SAM, SAAS, etc 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 companyContractsFacade: description: Fachada criada para receber os contratos através da integração G5 type: object required: – erpCompanyId – contracts properties: erpCompanyId: type: string description: Id da Empresa no ERP contracts: type: array items: type: object allOf: – #/definitions/companyContract minimum: 1 description: Contratos da empresa planFacade: description: 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/planPeriod description: Período 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: Status do plano (ativo ou inativo) isDefault: type: boolean description: Define se é um plano padrão metrics: type: array items: type: object allOf: – #/definitions/metric minimum: 1 description: metricas primitiveList: type: array items: type: object allOf: – #/definitions/primitiveLimit description: configuração dos limites das primitivas contracts: type: integer format: int64 description: Quantidade de contratos vinculados 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 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: Contrato 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 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: Contrato 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: – productId – name – key – type properties: id: type: string format: uuid description: Id da métrica productId: type: string format: uuid description: Id da métrica name: type: string description: Nome da métrica 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: Ativo default: true contracts: type: integer format: int64 description: Quantidade de contratos vinculados accountFacade: description: Fachada para gestão de contas type: object required: – erpId – name – identifier properties: id: type: string format: uuid description: id conta erpId: type: integer format: int64 description: id no ERP name: type: string description: Razão Social da empresa domainName: type: string description: Domínio da empresa identifier: type: string description: Identificador da empresa status: type: string description: Status da conta default: A phone: type: string description: Telefone de contato bpoId: type: integer format: int64 description: Id do BPO contactFacade: description: Facahada 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 lastName: type: string description: Sobrenome email: type: string description: Email locale: type: string description: Idioma accountId: type: string description: Id da conta vinculada tenantsFacade: description: Facahada 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 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 tenantName: type: string description: Nome do tenant password: type: string description: Senha genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação