openapi: 3.0.0
paths:
  /api/auth:
    post:
      operationId: ApisAuthController_auth
      summary: Autenticação
      description: >-
        Utiliza seu email e senha para autenticar na API e garantir seu token de
        autorização para navegar na API
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
        '404':
          description: Não encontrado
      tags:
        - Autenticação
  /api/info:
    get:
      operationId: ApisAuthController_get
      summary: Informações do Canal
      description: Recupera as informações do canal autenticado
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
        '404':
          description: Não encontrado
      tags:
        - Info
      security:
        - bearer: []
  /contact/pager:
    get:
      operationId: ApisContactController_getPager
      summary: Lista de Contatos da Empresa
      description: Recupera os contatos da empresa paginados e por filtros
      parameters:
        - name: page
          required: true
          in: query
          schema:
            type: number
        - name: perPage
          required: true
          in: query
          schema:
            type: number
        - name: search
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContactResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Contatos
      security:
        - bearer: []
  /contact/{id}:
    get:
      operationId: ApisContactController_getById
      summary: Consulta por ID
      description: Recupera um contato pelo identificador
      parameters:
        - name: id
          required: true
          in: path
          description: Identificador
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
        '404':
          description: Não encontrado
      tags:
        - Contatos
      security:
        - bearer: []
  /contact/create:
    post:
      operationId: ApisContactController_create
      summary: Cria um novo Contato
      description: Realiza a criação de um novo Contato
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Contatos
      security:
        - bearer: []
  /contact/update:
    put:
      operationId: ApisContactController_update
      summary: Atualiza dados de um Contato
      description: Realiza a atualização dos dados de um Contato
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Contatos
      security:
        - bearer: []
  /tag/list:
    get:
      operationId: ApisTagController_getList
      summary: Lista de Etiquetas
      description: Recupera a lista de todas as etiquetas da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TagResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Etiquetas
      security:
        - bearer: []
  /tag/{id}:
    get:
      operationId: ApisTagController_getById
      summary: Consulta por ID
      description: Recupera um canal pelo identificador
      parameters:
        - name: id
          required: true
          in: path
          description: Identificador
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Etiquetas
      security:
        - bearer: []
  /tag/create:
    post:
      operationId: ApisTagController_create
      summary: Cria uma nova Etiqueta
      description: Realiza a criação de uma nova Etiqueta
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Etiquetas
      security:
        - bearer: []
  /tag/update:
    put:
      operationId: ApisTagController_update
      summary: Atualiza dados de uma Etiqueta
      description: Realiza a atualização dos dados de uma etiqueta
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Etiquetas
      security:
        - bearer: []
  /department/list:
    get:
      operationId: ApisDepartmentController_getList
      summary: Lista de Canais da Empresa
      description: Recupera a lista de todos os canais da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DepartmentResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Departamentos
      security:
        - bearer: []
  /department/{id}:
    get:
      operationId: ApisDepartmentController_getById
      summary: Consulta por ID
      description: Recupera um contato pelo identificador
      parameters:
        - name: id
          required: true
          in: path
          description: Identificador
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
        '404':
          description: Não encontrado
      tags:
        - Departamentos
      security:
        - bearer: []
  /user/list:
    get:
      operationId: ApisUserController_getList
      summary: Lista de Usuários
      description: Recupera a lista de todos os usuários da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Usuários
      security:
        - bearer: []
  /user/{id}:
    get:
      operationId: ApisUserController_getById
      summary: Consulta por ID
      description: Recupera um contato pelo identificador
      parameters:
        - name: id
          required: true
          in: path
          description: Identificador
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Usuários
      security:
        - bearer: []
  /attendance/pager:
    get:
      operationId: ApisAttendanceController_getPager
      summary: Lista de Atendimentos da Empresa
      description: Recupera os atendimentos do canal paginados
      parameters:
        - name: page
          required: true
          in: query
          schema:
            type: number
        - name: perPage
          required: true
          in: query
          schema:
            type: number
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AttendanceResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Atendimentos
      security:
        - bearer: []
  /attendance/pager/status:
    get:
      operationId: ApisAttendanceController_getPagerByStatus
      summary: Lista de Atendimentos por Situação (Status)
      description: >-
        Recupera os atendimentos da empresa paginados e pelas situações: "Fora
        de horário", "Aguardando", "Em andamento", "Em pausa" e "Encerrados"
      parameters:
        - name: page
          required: true
          in: query
          schema:
            type: number
        - name: perPage
          required: true
          in: query
          schema:
            type: number
        - name: status
          required: true
          in: query
          schema:
            enum:
              - OVERTIME
              - PENDING
              - IN_PROGRESS
              - PAUSED
              - CLOSED
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AttendanceResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Atendimentos
      security:
        - bearer: []
  /attendance/{id}:
    get:
      operationId: ApisAttendanceController_getById
      summary: Consulta por ID
      description: Recupera um atendimento pelo identificador
      parameters:
        - name: id
          required: true
          in: path
          description: Identificador
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
        '404':
          description: Não encontrado
      tags:
        - Atendimentos
      security:
        - bearer: []
  /message/pager:
    get:
      operationId: ApisMessageController_getPager
      summary: Lista Mensagens do Canal
      description: >-
        Recupera mensagens paginadas, das mais recentes para as mais antigas
        (pela data de criação; mensagens com a mesma data não têm ordem
        garantida entre si). Informe ao menos um dos filtros idAttendance,
        idContact ou phone; os filtros informados são combinados (E). O filtro
        phone traz apenas as mensagens cujo remetente é aquele número. O filtro
        status considera o status atual do atendimento da mensagem e não pode
        ser usado sozinho: exige ao menos um dos outros filtros. Sem
        idAttendance, o resultado fica restrito ao canal do token; com
        idAttendance, vale o atendimento informado. Uma página menor que perPage
        é a última; perPage aceita de 1 a 100 registros.
      parameters:
        - name: page
          required: false
          in: query
          description: 'Página de resultados, a partir de 1. Padrão: 1.'
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: perPage
          required: false
          in: query
          description: >-
            Registros por página. Padrão: 20. Máximo: 100 (acima disso a
            requisição é recusada).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: idAttendance
          required: false
          in: query
          description: Identificador do atendimento.
          schema:
            type: string
        - name: idContact
          required: false
          in: query
          description: >-
            Identificador do contato. Traz as mensagens do contato; sem
            idAttendance, apenas as do canal do token.
          schema:
            type: string
        - name: phone
          required: false
          in: query
          description: >-
            Telefone em formato internacional, com DDI e DDD (ex.:
            5511999998888); sem o DDI nada é encontrado. Traz as mensagens cujo
            remetente (from) é esse número (sem idAttendance, apenas no canal do
            token); o nono dígito é opcional. Usado sozinho, considera os
            contatos que hoje possuem o número.
          schema:
            type: string
        - name: status
          required: false
          in: query
          style: form
          explode: false
          description: >-
            Status do atendimento ao qual a mensagem pertence. Aceita vários
            valores separados por vírgula. Exige idAttendance, idContact ou
            phone.
          schema:
            type: array
            items:
              type: string
              enum:
                - OVERTIME
                - PENDING
                - IN_PROGRESS
                - PAUSED
                - CLOSED
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageResponseModel'
        '400':
          description: >-
            Parâmetro inválido ou nenhum filtro informado. O corpo traz a
            mensagem e o campo key que identifica a recusa (ex.:
            errors.apis.invalidPerPage).
        '401':
          description: >-
            Token sem empresa ou sem canal válido (key
            errors.auth.unauthenticated).
        '504':
          description: >-
            A consulta excedeu o tempo limite (key errors.apis.queryTimeout).
            Refine os filtros.
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /message/{id}:
    get:
      operationId: ApisMessageController_getById
      summary: Consulta por ID
      description: Recupera uma mensagem pelo identificador
      parameters:
        - name: id
          required: true
          in: path
          description: Identificador
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /message/sendMessage:
    post:
      operationId: ApisMessageController_sendMessage
      summary: Enviar mensagem para um Atendimento
      description: Envia mensagem para um atendimento
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /message/sendReplyButtonMessage:
    post:
      operationId: ApisMessageController_sendReplyButtonMessage
      summary: Enviar mensagem para um Atendimento
      description: Envia mensagem para um atendimento
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplyButtonMessageRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /message/getMessageStatus/{messageId}:
    get:
      operationId: ApisMessageController_getMessageStatus
      summary: Busca o status de uma mensagem enviada
      description: Busca o status de uma mensagem enviada pelo ID da mensagem
      parameters:
        - name: messageId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageInfo'
        '404':
          description: Não encontrado
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /message/list/templates:
    get:
      operationId: ApisMessageController_getListTempalates
      summary: Lista de Templates (Somente Canal Oficial)
      description: Recupera templates de mensagens de um canal oficial
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
        '404':
          description: Não encontrado
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /message/sendTemplateMessage:
    post:
      operationId: ApisMessageController_sendTemplateMessage
      summary: Enviar Mensagem de Template para um Atendimento (Somente Canal Oficial)
      description: Envia mensagem de template para um atendimento
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageTemplateRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - Mensagens para Atendimentos do Canal
      security:
        - bearer: []
  /crm/funnel/list:
    get:
      operationId: CrmFunnelController_getList
      summary: Lista de Funis da Empresa
      description: Recupera os funis da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmFunnelResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/funnel/create:
    post:
      operationId: CrmFunnelController_create
      summary: Cria um novo Funil
      description: Realiza a criação de um novo Funil
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmFunnelRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmFunnelResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/funnel/update:
    put:
      operationId: CrmFunnelController_update
      summary: Atualiza dados de um Funil
      description: Realiza a atualização dos dados de um funil existente
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCrmFunnelRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmFunnelResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/stage/list/{idFunnel}:
    get:
      operationId: CrmStageController_getList
      summary: Lista de Etapas do Funil informado
      description: Recupera as etapas do funil informado
      parameters:
        - name: idFunnel
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmStageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/stage/create/{idFunnel}:
    post:
      operationId: CrmStageController_create
      summary: Cria uma nova etapa para o funil informado
      description: Realiza a criação de uma nova etapa para o funil informado
      parameters:
        - name: idFunnel
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmStageRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmStageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/stage/update:
    put:
      operationId: CrmStageController_update
      summary: Atualiza dados de uma Etapa existente
      description: Realiza a atualização dos dados de uma etapa existente
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCrmStageRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmStageResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/product/list:
    get:
      operationId: CrmProductController_getList
      summary: Lista de Produtos da Empresa
      description: Recupera os produtos da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmProductResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/product/create:
    post:
      operationId: CrmProductController_create
      summary: Cria um novo Produto
      description: Realiza a criação de um novo Produto
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmProductRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmProductResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/product/update:
    put:
      operationId: CrmProductController_update
      summary: Atualiza dados de um Produto
      description: Realiza a atualização dos dados de um produto existente
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCrmProductRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmProductResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/customer/list:
    get:
      operationId: CrmCustomerController_getList
      summary: Lista de Clientes da Empresa
      description: Recupera os clientes da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmCustomerResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/customer/create:
    post:
      operationId: CrmCustomerController_create
      summary: Cria um novo Cliente
      description: >-
        Realiza a criação de um novo Cliente. A pessoa é encontrada pelo
        telefone (ou criada como contato, quando nenhum contato o tem) e passa a
        ser o contato principal do cliente.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmCustomerRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmCustomerResponseModel'
        '400':
          description: >-
            Telefone ausente, ou inscrição estadual fora do formato (apenas
            dígitos ou ISENTO)
        '404':
          description: Não encontrado
        '409':
          description: >-
            O contato do telefone já é o contato principal de outro cliente, ou
            o CPF/CNPJ já pertence a outro cliente da empresa
      tags:
        - CRM
      security:
        - bearer: []
  /crm/customer/update:
    put:
      operationId: CrmCustomerController_update
      summary: Atualiza dados de um Cliente
      description: >-
        Realiza a atualização dos dados de um cliente existente. Telefone,
        e-mail e contato seguem o contato principal e não mudam por aqui:
        altere-os pelo contato (PUT /contact/update). Reenviar os valores atuais
        é aceito.
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCrmCustomerRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmCustomerResponseModel'
        '400':
          description: >-
            O corpo tenta mudar telefone, e-mail ou contato, ou a inscrição
            estadual está fora do formato
        '404':
          description: Não encontrado
        '409':
          description: O CPF/CNPJ já pertence a outro cliente da empresa
      tags:
        - CRM
      security:
        - bearer: []
  /crm/loss-reason/list:
    get:
      operationId: CrmLossReasonController_getList
      summary: Lista de Motivos de Perda da Empresa
      description: Recupera os motivos de perda da empresa
      parameters: []
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmLossReasonResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/loss-reason/create:
    post:
      operationId: CrmLossReasonController_create
      summary: Cria um novo Motivo de Perda
      description: Realiza a criação de um novo Motivo de Perda
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmLossReasonRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmLossReasonResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/loss-reason/update:
    put:
      operationId: CrmLossReasonController_update
      summary: Atualiza dados de um Motivo de Perda
      description: Realiza a atualização dos dados de um motivo de perda existente
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCrmLossReasonRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmLossReasonResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM
      security:
        - bearer: []
  /crm/card/list/{idFunnel}:
    get:
      operationId: CrmCardController_getListByFunnel
      summary: Lista de Oportunidades da Empresa usando o ID de um funil
      description: Recupera as oportunidades da empresa
      parameters:
        - name: idFunnel
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmCardResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM - Oportunidade
      security:
        - bearer: []
  /crm/card/create/{idFunnel}/{idStage}:
    post:
      operationId: CrmCardController_create
      summary: Cria uma nova Oportunidade para o funil e etapa informados
      description: Cria uma nova oportunidade para o funil e etapa informados
      parameters:
        - name: idFunnel
          required: true
          in: path
          schema:
            type: string
        - name: idStage
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrmCardRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrmCardResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM - Oportunidade
      security:
        - bearer: []
  /crm/card/update:
    put:
      operationId: CrmCardController_update
      summary: Atualiza dados de uma Oportunidade
      description: Realiza a atualização dos dados de uma Oportunidade
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCardRequestModel'
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmCardResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM - Oportunidade
      security:
        - bearer: []
  /crm/card/update/{idCard}/stage:
    put:
      operationId: CrmCardController_updateCardStage
      summary: Mover uma oportunidade para uma nova etapa
      description: >-
        Atualiza a etapa de uma oportunidade. Quando a etapa destino for de
        perda, o Motivo da Perda se torna obrigatório.
      parameters:
        - name: idCard
          required: true
          in: path
          schema:
            type: string
        - name: idNewStage
          required: true
          in: query
          schema:
            type: string
        - name: idLossReason
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Operação bem sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrmCardResponseModel'
        '404':
          description: Não encontrado
      tags:
        - CRM - Oportunidade
      security:
        - bearer: []
info:
  title: Trendmulti API
  description: https://apis.trendmulti.com.br
  version: 2.23.3
  contact:
    name: Trendmulti
    url: https://trendmulti.com.br
    email: contato@trendmulti.com.br
tags: []
servers:
  - url: https://apis.trendmulti.com.br
    description: Trendmulti API
components:
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
  schemas:
    AuthRequestModel:
      type: object
      properties:
        uuid:
          type: string
          nullable: false
        token:
          type: string
          nullable: false
      required:
        - uuid
        - token
    Pager:
      type: object
      properties: {}
    UpdateContactRequestModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        phone:
          type: string
        email:
          type: string
        image:
          type: string
        tags:
          type: array
          items:
            type: string
      required:
        - id
    ContactRequestModel:
      type: object
      properties:
        name:
          type: string
        phone:
          type: string
        email:
          type: string
        image:
          type: string
        tags:
          type: array
          items:
            type: string
      required:
        - name
        - phone
    ChannelResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        type:
          type: string
        identifier:
          type: string
        lastSyncDate:
          format: date-time
          type: string
        activated:
          type: boolean
        connected:
          type: boolean
        apis:
          type: object
        company:
          type: object
      required:
        - name
        - description
        - type
        - identifier
        - lastSyncDate
        - activated
        - connected
        - apis
        - company
    ContactResponseModel:
      type: object
      properties:
        name:
          type: string
        image:
          type: string
        email:
          type: string
        phone:
          type: string
        instagram:
          type: object
        tags:
          type: array
          items:
            type: string
      required:
        - name
        - image
        - email
        - phone
        - instagram
        - tags
    TagResponseModel:
      type: object
      properties:
        keyword:
          type: array
          items:
            type: string
        title:
          type: string
        bgColor:
          type: string
        fontColor:
          type: string
      required:
        - keyword
        - title
        - bgColor
        - fontColor
    TagRequestModel:
      type: object
      properties:
        title:
          type: string
      required:
        - title
    DepartmentResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        image:
          type: string
        channel:
          type: object
        schedules:
          type: object
      required:
        - name
        - description
        - image
        - channel
        - schedules
    UserResponseModel:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        image:
          type: string
      required:
        - name
        - email
        - image
    AttendanceResponseModel:
      type: object
      properties:
        protocol:
          type: string
        contact:
          type: object
        channel:
          type: object
        user:
          type: object
        lastMessage:
          type: object
        department:
          type: object
        status:
          type: string
        subStatus:
          type: string
        tags:
          type: array
          items:
            type: string
        inConversation:
          type: boolean
        expiredAt:
          format: date-time
          type: string
        countUnreadMessages:
          type: number
        isDirectedByCustomerPortfolio:
          type: boolean
        kpis:
          type: object
        closedAt:
          format: date-time
          type: string
      required:
        - protocol
        - contact
        - channel
        - user
        - lastMessage
        - department
        - status
        - subStatus
        - tags
        - inConversation
        - expiredAt
        - countUnreadMessages
        - isDirectedByCustomerPortfolio
        - kpis
        - closedAt
    MessageTypeEnum:
      type: string
      description: Type of the message
      enum:
        - text
        - audio
        - contacts
        - document
        - image
        - reaction
        - interactive
        - location
        - sticker
        - template
        - video
        - button
        - call
    MessageRequestModel:
      type: object
      properties:
        idContact:
          type: string
        idDepartment:
          type: string
        idUser:
          type: string
        type:
          $ref: '#/components/schemas/MessageTypeEnum'
        content:
          type: string
        contentType:
          type: string
          description: Should be use for types image, video, audio or document
        caption:
          type: string
          description: Should be use for types image, video, audio or document
        automated:
          type: boolean
          description: Indicates if the message is automated
      required:
        - idContact
        - type
        - content
        - automated
    MessageResponseModel:
      type: object
      properties:
        messageId:
          type: string
        from:
          type: string
        to:
          type: string
        content:
          type: string
        contentType:
          type: string
        caption:
          type: string
        read:
          type: boolean
        delay:
          type: number
        vcardContact:
          type: array
          items:
            type: string
        contact:
          type: object
        channel:
          type: object
        attendance:
          type: object
        user:
          type: object
        reply:
          type: object
        reactions:
          type: array
          items:
            type: string
        type:
          type: object
        automated:
          type: boolean
        echoed:
          type: boolean
        payload:
          type: object
        sent:
          type: boolean
        delivered:
          type: boolean
        referral:
          type: object
      required:
        - messageId
        - from
        - to
        - content
        - contentType
        - caption
        - read
        - delay
        - vcardContact
        - contact
        - channel
        - attendance
        - user
        - reply
        - reactions
        - type
        - automated
        - echoed
        - payload
        - sent
        - delivered
        - referral
    HeaderTypeEnum:
      type: string
      description: Header type. text | video | image | document
      enum:
        - text
        - video
        - image
        - document
    MediaObjectModel:
      type: object
      properties:
        id:
          type: string
          description: Media identifier (if applicable)
        link:
          type: string
          description: Public URL (if applicable)
    HeaderObjectModel:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/HeaderTypeEnum'
        document:
          description: Required when type = document
          allOf:
            - $ref: '#/components/schemas/MediaObjectModel'
        image:
          description: Required when type = image
          allOf:
            - $ref: '#/components/schemas/MediaObjectModel'
        text:
          type: string
          description: >-
            Required when type = text. Max length: 60. Emojis allowed, no
            markdown.
          maxLength: 60
        video:
          description: Required when type = video
          allOf:
            - $ref: '#/components/schemas/MediaObjectModel'
      required:
        - type
    BodyObjectModel:
      type: object
      properties:
        text:
          type: string
          description: 'Text content. Max length: 1024. Emojis and markdown supported.'
          maxLength: 1024
      required:
        - text
    FooterObjectModel:
      type: object
      properties:
        text:
          type: string
          description: 'Text content. Max length: 1024. Emojis and markdown supported.'
          maxLength: 1024
      required:
        - text
    ButtonReplyModel:
      type: object
      properties:
        title:
          type: string
          description: 'Title of the reply button. Max length: 20.'
          maxLength: 20
        id:
          type: string
          description: 'Unique identifier for the button. Max length: 256.'
          maxLength: 256
      required:
        - title
        - id
    ButtonObjectModel:
      type: object
      properties:
        type:
          type: string
          description: Button parameter type
        reply:
          $ref: '#/components/schemas/ButtonReplyModel'
      required:
        - type
        - reply
    ReplyButtonMessageRequestModel:
      type: object
      properties:
        idContact:
          type: string
        idDepartment:
          type: string
        idUser:
          type: string
        header:
          description: Header of the message
          allOf:
            - $ref: '#/components/schemas/HeaderObjectModel'
        body:
          description: Body of the message
          allOf:
            - $ref: '#/components/schemas/BodyObjectModel'
        footer:
          description: Footer of the message
          allOf:
            - $ref: '#/components/schemas/FooterObjectModel'
        buttons:
          description: Array of reply buttons
          type: array
          items:
            $ref: '#/components/schemas/ButtonObjectModel'
        automated:
          type: boolean
          description: Indicates if the message is automated
      required:
        - idContact
        - body
        - buttons
        - automated
    MessageInfo:
      type: object
      properties: {}
    MessageTemplateRequestModel:
      type: object
      properties:
        idContact:
          type: string
        idDepartment:
          type: string
        idUser:
          type: string
        template:
          type: string
        headerParams:
          type: array
          items:
            type: string
        bodyParams:
          type: array
          items:
            type: string
      required:
        - idContact
        - idDepartment
        - idUser
        - template
        - headerParams
        - bodyParams
    FunnelCategory:
      type: object
      properties: {}
    CrmFunnelResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        category:
          $ref: '#/components/schemas/FunnelCategory'
      required:
        - name
        - description
        - category
    CrmFunnelRequestModel:
      type: object
      properties:
        name:
          type: string
      required:
        - name
    UpdateCrmFunnelRequestModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        category:
          $ref: '#/components/schemas/FunnelCategory'
      required:
        - id
        - name
    CrmStageResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        order:
          type: number
        bgColor:
          type: string
        lostDeal:
          type: boolean
        wonDeal:
          type: boolean
        funnel:
          type: object
      required:
        - name
        - description
        - order
        - bgColor
        - lostDeal
        - wonDeal
        - funnel
    CrmStageRequestModel:
      type: object
      properties:
        name:
          type: string
      required:
        - name
    UpdateCrmStageRequestModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        order:
          type: number
        bgColor:
          type: string
        lostDeal:
          type: boolean
        wonDeal:
          type: boolean
      required:
        - id
    CrmProductResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        code:
          type: string
        images:
          type: array
          items:
            type: string
        actived:
          type: boolean
        price:
          type: number
      required:
        - name
        - description
        - code
        - images
        - actived
        - price
    CrmProductRequestModel:
      type: object
      properties:
        name:
          type: string
        price:
          type: number
      required:
        - name
        - price
    UpdateCrmProductRequestModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        code:
          type: string
        price:
          type: number
      required:
        - id
    CrmCustomerResponseModel:
      type: object
      properties:
        name:
          type: string
        phone:
          type: string
        email:
          type: string
        contact:
          type: object
        code:
          type: string
          description: The customer's code in the company's ERP
        tin:
          type: string
          description: CPF or CNPJ, digits only
        legalName:
          type: string
        tradeName:
          type: string
        stateRegistration:
          type: string
          description: Digits or ISENTO
        website:
          type: string
        instagram:
          type: string
        segment:
          type: string
        employeeBand:
          type: string
        address:
          type: object
      required:
        - name
        - phone
    CrmCustomerRequestModel:
      type: object
      properties:
        name:
          type: string
        phone:
          type: string
        email:
          type: string
        code:
          type: string
          description: >-
            The customer's code in the company's ERP, when it came from one;
            stored as given
        legalName:
          type: string
        tradeName:
          type: string
        tin:
          type: string
          description: >-
            CPF or CNPJ; digits only are stored, never validated, unique per
            company
        stateRegistration:
          type: string
          description: Digits or ISENTO
        website:
          type: string
        instagram:
          type: string
        segment:
          type: string
        employeeBand:
          type: string
        address:
          type: object
          description: zip, street, number, complement, neighborhood, city, state
      required:
        - name
        - phone
    UpdateCrmCustomerRequestModel:
      type: object
      properties:
        name:
          type: string
        code:
          type: string
          description: >-
            The customer's code in the company's ERP, when it came from one;
            stored as given
        legalName:
          type: string
        tradeName:
          type: string
        tin:
          type: string
          description: >-
            CPF or CNPJ; digits only are stored, never validated, unique per
            company
        stateRegistration:
          type: string
          description: Digits or ISENTO
        website:
          type: string
        instagram:
          type: string
        segment:
          type: string
        employeeBand:
          type: string
        address:
          type: object
          description: zip, street, number, complement, neighborhood, city, state
        id:
          type: string
      required:
        - id
    CrmLossReasonResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
      required:
        - name
        - description
    CrmLossReasonRequestModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
      required:
        - name
    UpdateCrmLossReasonRequestModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
      required:
        - id
    CrmCardResponseModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        priority:
          type: object
        temperature:
          type: object
        order:
          type: number
        budget:
          type: number
        won:
          type: boolean
        deadlineAt:
          format: date-time
          type: string
        isPrivate:
          type: boolean
        customer:
          type: object
        product:
          type: object
        user:
          type: object
        attendance:
          type: object
        lossReason:
          type: object
        funnel:
          type: object
        stage:
          type: object
        attachments:
          type: array
          items:
            type: string
        closedAt:
          format: date-time
          type: string
        winDate:
          format: date-time
          type: string
        lostDate:
          format: date-time
          type: string
      required:
        - name
        - description
        - priority
        - temperature
        - order
        - budget
        - won
        - deadlineAt
        - isPrivate
        - customer
        - product
        - user
        - attendance
        - lossReason
        - funnel
        - stage
        - attachments
        - closedAt
        - winDate
        - lostDate
    CardPriorityEnum:
      type: string
      description: >-
        Priority level of the opportunity. NO PRIORITY | LOW | MEDIUM | HIGH |
        URGENT | CRITICAL
      enum:
        - NO PRIORITY
        - LOW
        - MEDIUM
        - HIGH
        - URGENT
        - CRITICAL
    CardTemperatureEnum:
      type: string
      description: Temperature level of the opportunity. COLD | WARM | HOT
      enum:
        - COLD
        - WARM
        - HOT
    AttachmentsObjectModel:
      type: object
      properties:
        filename:
          type: string
        contentType:
          type: string
        size:
          type: number
        url:
          type: string
      required:
        - filename
        - contentType
        - size
        - url
    CrmCardRequestModel:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        priority:
          $ref: '#/components/schemas/CardPriorityEnum'
        temperature:
          $ref: '#/components/schemas/CardTemperatureEnum'
        order:
          type: number
          default: 0
        budget:
          type: number
        customer:
          type: object
        product:
          type: object
        user:
          type: object
        attendance:
          type: object
        lossReason:
          type: object
        funnel:
          type: object
        stage:
          type: object
        won:
          type: boolean
        deadlineAt:
          format: date-time
          type: string
        isPrivate:
          type: boolean
        closedAt:
          format: date-time
          type: string
        winDate:
          format: date-time
          type: string
        lostDate:
          format: date-time
          type: string
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/AttachmentsObjectModel'
      required:
        - name
        - order
    UpdateCardRequestModel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        budget:
          type: number
        customer:
          type: object
        product:
          type: object
        user:
          type: object
        lossReason:
          type: object
        isPrivate:
          type: boolean
        closedAt:
          format: date-time
          type: string
        winDate:
          format: date-time
          type: string
        lostDate:
          format: date-time
          type: string
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/AttachmentsObjectModel'
      required:
        - id
        - name
externalDocs:
  description: API Reference
  url: https://developer.trendmulti.com.br
