@magnetcustomer/sdk 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -3
- package/dist/client.d.ts +6 -1
- package/dist/client.js +5 -0
- package/dist/generated/api/contacts-api.d.ts +24 -24
- package/dist/generated/api/contacts-api.js +24 -24
- package/dist/generated/api/custom-fields-api.d.ts +1 -43
- package/dist/generated/api/custom-fields-api.js +1 -67
- package/dist/generated/api/customers-api.d.ts +4 -4
- package/dist/generated/api/customers-api.js +4 -4
- package/dist/generated/api/deals-api.d.ts +27 -27
- package/dist/generated/api/deals-api.js +27 -27
- package/dist/generated/api/journeys-api.d.ts +232 -0
- package/dist/generated/api/journeys-api.js +315 -0
- package/dist/generated/api/leads-api.d.ts +4 -4
- package/dist/generated/api/leads-api.js +4 -4
- package/dist/generated/api/meetings-api.d.ts +123 -27
- package/dist/generated/api/meetings-api.js +169 -27
- package/dist/generated/api/observations-api.d.ts +8 -8
- package/dist/generated/api/observations-api.js +8 -8
- package/dist/generated/api/organizations-api.d.ts +24 -24
- package/dist/generated/api/organizations-api.js +24 -24
- package/dist/generated/api/pipelines-api.d.ts +49 -1
- package/dist/generated/api/pipelines-api.js +72 -1
- package/dist/generated/api/prospects-api.d.ts +4 -4
- package/dist/generated/api/prospects-api.js +4 -4
- package/dist/generated/api/staffs-api.d.ts +1 -1
- package/dist/generated/api/staffs-api.js +1 -1
- package/dist/generated/api/task-types-api.d.ts +5 -5
- package/dist/generated/api/task-types-api.js +5 -5
- package/dist/generated/api/tasks-api.d.ts +32 -32
- package/dist/generated/api/tasks-api.js +32 -32
- package/dist/generated/api/teams-api.d.ts +130 -0
- package/dist/generated/api/teams-api.js +199 -0
- package/dist/generated/api/tickets-api.d.ts +610 -0
- package/dist/generated/api/tickets-api.js +860 -0
- package/dist/generated/api/treatments-api.d.ts +379 -0
- package/dist/generated/api/treatments-api.js +539 -0
- package/dist/generated/api/webhooks-api.d.ts +63 -0
- package/dist/generated/api/webhooks-api.js +116 -0
- package/dist/generated/api.d.ts +6 -1
- package/dist/generated/api.js +6 -1
- package/dist/generated/base.d.ts +1 -1
- package/dist/generated/base.js +1 -1
- package/dist/generated/common.d.ts +1 -1
- package/dist/generated/common.js +1 -1
- package/dist/generated/configuration.d.ts +1 -1
- package/dist/generated/configuration.js +1 -1
- package/dist/generated/index.d.ts +1 -1
- package/dist/generated/index.js +1 -1
- package/dist/generated/models/close-deal-request.d.ts +2 -2
- package/dist/generated/models/close-deal-request.js +1 -1
- package/dist/generated/models/contact-input-phones-inner.d.ts +1 -1
- package/dist/generated/models/contact-input-phones-inner.js +1 -1
- package/dist/generated/models/contact-input.d.ts +1 -1
- package/dist/generated/models/contact-input.js +1 -1
- package/dist/generated/models/contact-summary.d.ts +1 -1
- package/dist/generated/models/contact-summary.js +1 -1
- package/dist/generated/models/contact.d.ts +1 -1
- package/dist/generated/models/contact.js +1 -1
- package/dist/generated/models/create-observation-request.d.ts +1 -1
- package/dist/generated/models/create-observation-request.js +1 -1
- package/dist/generated/models/create-task-type-request.d.ts +1 -1
- package/dist/generated/models/create-task-type-request.js +1 -1
- package/dist/generated/models/create-ticket-message-request.d.ts +29 -0
- package/dist/generated/models/create-ticket-message-request.js +19 -0
- package/dist/generated/models/custom-field-settings.d.ts +1 -1
- package/dist/generated/models/custom-field-settings.js +1 -1
- package/dist/generated/models/custom-field-value.d.ts +1 -1
- package/dist/generated/models/custom-field-value.js +1 -1
- package/dist/generated/models/custom-field.d.ts +1 -1
- package/dist/generated/models/custom-field.js +1 -1
- package/dist/generated/models/deal-create.d.ts +1 -1
- package/dist/generated/models/deal-create.js +1 -1
- package/dist/generated/models/deal-input.d.ts +1 -1
- package/dist/generated/models/deal-input.js +1 -1
- package/dist/generated/models/deal-labels-inner.d.ts +1 -1
- package/dist/generated/models/deal-labels-inner.js +1 -1
- package/dist/generated/models/deal-organization.d.ts +1 -1
- package/dist/generated/models/deal-organization.js +1 -1
- package/dist/generated/models/deal-pipeline-one-of.d.ts +1 -1
- package/dist/generated/models/deal-pipeline-one-of.js +1 -1
- package/dist/generated/models/deal-pipeline.d.ts +1 -1
- package/dist/generated/models/deal-pipeline.js +1 -1
- package/dist/generated/models/deal-stage.d.ts +1 -1
- package/dist/generated/models/deal-stage.js +1 -1
- package/dist/generated/models/deal.d.ts +1 -1
- package/dist/generated/models/deal.js +1 -1
- package/dist/generated/models/delete-meetings-request.d.ts +1 -1
- package/dist/generated/models/delete-meetings-request.js +1 -1
- package/dist/generated/models/delete-meetings200-response.d.ts +1 -1
- package/dist/generated/models/delete-meetings200-response.js +1 -1
- package/dist/generated/models/delete-observations-request.d.ts +1 -1
- package/dist/generated/models/delete-observations-request.js +1 -1
- package/dist/generated/models/error-errors-inner.d.ts +1 -1
- package/dist/generated/models/error-errors-inner.js +1 -1
- package/dist/generated/models/finish-meeting-request.d.ts +1 -1
- package/dist/generated/models/finish-meeting-request.js +1 -1
- package/dist/generated/models/finish-tasks-request.d.ts +1 -1
- package/dist/generated/models/finish-tasks-request.js +1 -1
- package/dist/generated/models/get-deal-stage-history200-response-history-inner-stage.d.ts +1 -1
- package/dist/generated/models/get-deal-stage-history200-response-history-inner-stage.js +1 -1
- package/dist/generated/models/get-deal-stage-history200-response-history-inner.d.ts +1 -1
- package/dist/generated/models/get-deal-stage-history200-response-history-inner.js +1 -1
- package/dist/generated/models/get-deal-stage-history200-response-totals.d.ts +1 -1
- package/dist/generated/models/get-deal-stage-history200-response-totals.js +1 -1
- package/dist/generated/models/get-deal-stage-history200-response.d.ts +1 -1
- package/dist/generated/models/get-deal-stage-history200-response.js +1 -1
- package/dist/generated/models/get-journey-health-score200-response.d.ts +34 -0
- package/dist/generated/models/get-journey-health-score200-response.js +20 -0
- package/dist/generated/models/index.d.ts +27 -0
- package/dist/generated/models/index.js +27 -0
- package/dist/generated/models/journey.d.ts +111 -0
- package/dist/generated/models/journey.js +32 -0
- package/dist/generated/models/list-contacts200-response.d.ts +1 -1
- package/dist/generated/models/list-contacts200-response.js +1 -1
- package/dist/generated/models/list-custom-fields200-response.d.ts +1 -1
- package/dist/generated/models/list-custom-fields200-response.js +1 -1
- package/dist/generated/models/list-deals200-response.d.ts +1 -1
- package/dist/generated/models/list-deals200-response.js +1 -1
- package/dist/generated/models/list-deals401-response.d.ts +1 -1
- package/dist/generated/models/list-deals401-response.js +1 -1
- package/dist/generated/models/list-deals403-response.d.ts +1 -1
- package/dist/generated/models/list-deals403-response.js +1 -1
- package/dist/generated/models/list-journeys200-response.d.ts +16 -0
- package/dist/generated/models/list-journeys200-response.js +15 -0
- package/dist/generated/models/list-lost-reasons200-response.d.ts +16 -0
- package/dist/generated/models/list-lost-reasons200-response.js +15 -0
- package/dist/generated/models/list-meeting-rooms200-response.d.ts +16 -0
- package/dist/generated/models/list-meeting-rooms200-response.js +15 -0
- package/dist/generated/models/list-meeting-types200-response.d.ts +16 -0
- package/dist/generated/models/list-meeting-types200-response.js +15 -0
- package/dist/generated/models/list-meetings200-response.d.ts +1 -1
- package/dist/generated/models/list-meetings200-response.js +1 -1
- package/dist/generated/models/list-observations200-response.d.ts +1 -1
- package/dist/generated/models/list-observations200-response.js +1 -1
- package/dist/generated/models/list-organizations200-response.d.ts +1 -1
- package/dist/generated/models/list-organizations200-response.js +1 -1
- package/dist/generated/models/list-pipelines200-response.d.ts +1 -1
- package/dist/generated/models/list-pipelines200-response.js +1 -1
- package/dist/generated/models/list-staffs200-response.d.ts +1 -1
- package/dist/generated/models/list-staffs200-response.js +1 -1
- package/dist/generated/models/list-task-types200-response-one-of.d.ts +1 -1
- package/dist/generated/models/list-task-types200-response-one-of.js +1 -1
- package/dist/generated/models/list-task-types200-response.d.ts +1 -1
- package/dist/generated/models/list-task-types200-response.js +1 -1
- package/dist/generated/models/list-tasks200-response.d.ts +1 -1
- package/dist/generated/models/list-tasks200-response.js +1 -1
- package/dist/generated/models/list-teams200-response.d.ts +16 -0
- package/dist/generated/models/list-teams200-response.js +15 -0
- package/dist/generated/models/list-ticket-statuses200-response.d.ts +16 -0
- package/dist/generated/models/list-ticket-statuses200-response.js +15 -0
- package/dist/generated/models/list-tickets200-response.d.ts +16 -0
- package/dist/generated/models/list-tickets200-response.js +15 -0
- package/dist/generated/models/list-treatment-types200-response.d.ts +16 -0
- package/dist/generated/models/list-treatment-types200-response.js +15 -0
- package/dist/generated/models/list-treatments200-response.d.ts +16 -0
- package/dist/generated/models/list-treatments200-response.js +15 -0
- package/dist/generated/models/list-workspaces200-response.d.ts +16 -0
- package/dist/generated/models/list-workspaces200-response.js +15 -0
- package/dist/generated/models/lost-reason.d.ts +32 -0
- package/dist/generated/models/lost-reason.js +15 -0
- package/dist/generated/models/meeting-create.d.ts +1 -1
- package/dist/generated/models/meeting-create.js +1 -1
- package/dist/generated/models/meeting-deal.d.ts +1 -1
- package/dist/generated/models/meeting-deal.js +1 -1
- package/dist/generated/models/meeting-input.d.ts +1 -1
- package/dist/generated/models/meeting-input.js +1 -1
- package/dist/generated/models/meeting-room.d.ts +1 -1
- package/dist/generated/models/meeting-room.js +1 -1
- package/dist/generated/models/meeting-type.d.ts +1 -1
- package/dist/generated/models/meeting-type.js +1 -1
- package/dist/generated/models/meeting.d.ts +1 -1
- package/dist/generated/models/meeting.js +1 -1
- package/dist/generated/models/model-error.d.ts +1 -1
- package/dist/generated/models/model-error.js +1 -1
- package/dist/generated/models/move-deal-stage-request.d.ts +1 -1
- package/dist/generated/models/move-deal-stage-request.js +1 -1
- package/dist/generated/models/move-deal-stage200-response.d.ts +1 -1
- package/dist/generated/models/move-deal-stage200-response.js +1 -1
- package/dist/generated/models/observation-deal.d.ts +1 -1
- package/dist/generated/models/observation-deal.js +1 -1
- package/dist/generated/models/observation-input.d.ts +1 -1
- package/dist/generated/models/observation-input.js +1 -1
- package/dist/generated/models/observation-organization.d.ts +1 -1
- package/dist/generated/models/observation-organization.js +1 -1
- package/dist/generated/models/observation.d.ts +1 -1
- package/dist/generated/models/observation.js +1 -1
- package/dist/generated/models/organization-input.d.ts +1 -1
- package/dist/generated/models/organization-input.js +1 -1
- package/dist/generated/models/organization.d.ts +1 -1
- package/dist/generated/models/organization.js +1 -1
- package/dist/generated/models/page.d.ts +1 -1
- package/dist/generated/models/page.js +1 -1
- package/dist/generated/models/pipeline.d.ts +1 -1
- package/dist/generated/models/pipeline.js +1 -1
- package/dist/generated/models/reopen-deal-request.d.ts +1 -1
- package/dist/generated/models/reopen-deal-request.js +1 -1
- package/dist/generated/models/staff-summary.d.ts +1 -1
- package/dist/generated/models/staff-summary.js +1 -1
- package/dist/generated/models/staff.d.ts +1 -1
- package/dist/generated/models/staff.js +1 -1
- package/dist/generated/models/stage.d.ts +1 -1
- package/dist/generated/models/stage.js +1 -1
- package/dist/generated/models/task-create.d.ts +1 -1
- package/dist/generated/models/task-create.js +1 -1
- package/dist/generated/models/task-deal.d.ts +1 -1
- package/dist/generated/models/task-deal.js +1 -1
- package/dist/generated/models/task-input.d.ts +1 -1
- package/dist/generated/models/task-input.js +1 -1
- package/dist/generated/models/task-type.d.ts +1 -1
- package/dist/generated/models/task-type.js +1 -1
- package/dist/generated/models/task.d.ts +1 -1
- package/dist/generated/models/task.js +1 -1
- package/dist/generated/models/team.d.ts +27 -0
- package/dist/generated/models/team.js +15 -0
- package/dist/generated/models/ticket-create.d.ts +16 -0
- package/dist/generated/models/ticket-create.js +15 -0
- package/dist/generated/models/ticket-input.d.ts +77 -0
- package/dist/generated/models/ticket-input.js +22 -0
- package/dist/generated/models/ticket-message.d.ts +33 -0
- package/dist/generated/models/ticket-message.js +15 -0
- package/dist/generated/models/ticket-status-workspace.d.ts +18 -0
- package/dist/generated/models/ticket-status-workspace.js +15 -0
- package/dist/generated/models/ticket-status.d.ts +37 -0
- package/dist/generated/models/ticket-status.js +15 -0
- package/dist/generated/models/ticket.d.ts +87 -0
- package/dist/generated/models/ticket.js +22 -0
- package/dist/generated/models/treatment-input.d.ts +58 -0
- package/dist/generated/models/treatment-input.js +15 -0
- package/dist/generated/models/treatment-type.d.ts +43 -0
- package/dist/generated/models/treatment-type.js +15 -0
- package/dist/generated/models/treatment.d.ts +64 -0
- package/dist/generated/models/treatment.js +15 -0
- package/dist/generated/models/update-task-type-request.d.ts +1 -1
- package/dist/generated/models/update-task-type-request.js +1 -1
- package/dist/generated/models/validate-deal200-response-required-actions-pending.d.ts +1 -1
- package/dist/generated/models/validate-deal200-response-required-actions-pending.js +1 -1
- package/dist/generated/models/validate-deal200-response-required-field-pending.d.ts +1 -1
- package/dist/generated/models/validate-deal200-response-required-field-pending.js +1 -1
- package/dist/generated/models/validate-deal200-response.d.ts +1 -1
- package/dist/generated/models/validate-deal200-response.js +1 -1
- package/dist/generated/models/webhook-trigger-group-triggers-inner.d.ts +29 -0
- package/dist/generated/models/webhook-trigger-group-triggers-inner.js +15 -0
- package/dist/generated/models/webhook-trigger-group.d.ts +22 -0
- package/dist/generated/models/webhook-trigger-group.js +15 -0
- package/dist/generated/models/workspace.d.ts +23 -0
- package/dist/generated/models/workspace.js +15 -0
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* API da Magnet Customer
|
|
3
|
-
* A API REST da Magnet Customer permite ler e gravar os registros do CRM a partir dos seus sistemas. # Comece aqui ## 1. Crie um Service Account No CRM, abra **Configurações › Service Accounts** (apenas administradores), clique em **Novo service account**, escolha a validade e as permissões, e copie o **Client ID** e o **Client Secret**. O secret aparece uma única vez. ## 2. Solicite um token ```bash curl -X POST https://magnetcustomer.net/realms/platform/protocol/openid-connect/token \\ -H \"Content-Type: application/x-www-form-urlencoded\" \\ -d \"grant_type=client_credentials\" \\ -d \"client_id=SEU_CLIENT_ID\" \\ -d \"client_secret=SEU_CLIENT_SECRET\" ``` ```json { \"access_token\": \"eyJhbGciOiJSUzI1NiIs...\", \"expires_in\": 900, \"token_type\": \"Bearer\" } ``` O token vale 15 minutos e este fluxo não tem refresh token: quando vencer, ou ao receber `401`, repita o pedido. ## 3. Chame a API Cada conta tem o seu endereço. Troque `sua-conta` pelo subdomínio que você usa para abrir o CRM: ```bash curl \"https://sua-conta.platform-api.magnetcustomer.com/api/deals?page=1&limit=15\" \\ -H \"Authorization: Bearer SEU_TOKEN\" ``` Requisições com corpo levam também `Content-Type: application/json`. # Convenções ## Paginação Envie sempre `page`. Com ele, toda listagem devolve o mesmo envelope: ```json { \"docs\": [], \"total\": 132, \"pages\": 9, \"page\": 1, \"limit\": 15 } ``` | Parâmetro | Padrão | Descrição | |---|---|---| | `page` | — | Página, a partir de 1. **Obrigatório na prática** | | `limit` | 15 | Registros por página. Máximo 100: acima disso a API usa 100 | | `sortBy` | varia por recurso | Campo de ordenação | | `sortType` | `desc` | `asc` ou `desc` | | `search` | — | Busca textual, quando o recurso aceita | Sem `page`,
|
|
3
|
+
* A API REST da Magnet Customer permite ler e gravar os registros do CRM a partir dos seus sistemas. # Comece aqui ## 1. Crie um Service Account No CRM, abra **Configurações › Service Accounts** (apenas administradores), clique em **Novo service account**, escolha a validade e as permissões, e copie o **Client ID** e o **Client Secret**. O secret aparece uma única vez. ## 2. Solicite um token ```bash curl -X POST https://magnetcustomer.net/realms/platform/protocol/openid-connect/token \\ -H \"Content-Type: application/x-www-form-urlencoded\" \\ -d \"grant_type=client_credentials\" \\ -d \"client_id=SEU_CLIENT_ID\" \\ -d \"client_secret=SEU_CLIENT_SECRET\" ``` ```json { \"access_token\": \"eyJhbGciOiJSUzI1NiIs...\", \"expires_in\": 900, \"token_type\": \"Bearer\" } ``` O token vale 15 minutos e este fluxo não tem refresh token: quando vencer, ou ao receber `401`, repita o pedido. ## 3. Chame a API Cada conta tem o seu endereço. Troque `sua-conta` pelo subdomínio que você usa para abrir o CRM: ```bash curl \"https://sua-conta.platform-api.magnetcustomer.com/api/deals?page=1&limit=15\" \\ -H \"Authorization: Bearer SEU_TOKEN\" ``` Requisições com corpo levam também `Content-Type: application/json`. # Convenções ## Paginação Envie sempre `page`. Com ele, toda listagem devolve o mesmo envelope: ```json { \"docs\": [], \"total\": 132, \"pages\": 9, \"page\": 1, \"limit\": 15 } ``` | Parâmetro | Padrão | Descrição | |---|---|---| | `page` | — | Página, a partir de 1. **Obrigatório na prática** | | `limit` | 15 | Registros por página. Máximo 100: acima disso a API usa 100 | | `sortBy` | varia por recurso | Campo de ordenação | | `sortType` | `desc` | `asc` ou `desc` | | `search` | — | Busca textual, quando o recurso aceita | Sem `page`, algumas listagens (Contatos, Pipelines, Campos personalizados e os cadastros de apoio, como tipos e situações) devolvem uma lista simples (`[...]`), sem o envelope, e ignoram `limit`. Para percorrer tudo, peça `page=1` e avance até `page` ser igual a `pages`. Uma página além do fim devolve `docs` vazio. O tamanho de página padrão é 15, com duas exceções: 25 em Leads, Prospects e Clientes, e 100 em Usuários. Um `limit` inválido cai no padrão. ## Identificadores e datas Todo ID é um texto de 24 caracteres hexadecimais, como `507f1f77bcf86cd799439011`. Ao gravar, envie a referência como **ID em texto** — nunca o objeto. Um ID fora desse formato hoje é respondido com `500`, não `400`: valide o formato antes de enviar. No corpo e nas respostas, datas são ISO 8601 em UTC, como `2026-05-15T10:00:00Z`. Nos filtros de data da URL (`minDate`, `createdAt_minDate`, `dateOfExpires_minDate`...), envie um **timestamp em milissegundos**, como `1798761600000`. ## Listas na URL Filtros que aceitam vários valores levam colchetes no nome, mesmo quando o valor é um só: ``` /api/contacts?page=1&staffs[]=507f191e810c19729de860eb&staffs[]=507f191e810c19729de860ec ``` Sem colchetes, um valor único é recusado com erro em parte das listagens. ## Campos ausentes Campo sem valor costuma vir **ausente** da resposta, não como `null`. Trate a falta da chave como vazio. ## Campos personalizados Os campos criados pelo administrador da conta vão na lista `customFields`: ```json { \"customFields\": [ { \"customField\": \"507f1f77bcf86cd799439014\", \"k\": \"segmento\", \"v\": \"Tecnologia\" } ] } ``` O valor vai em **`v`**. Um item com `value` é aceito sem erro, mas o campo fica vazio. Descubra os campos e os IDs com `GET /api/customfields?page=1&feature=deal` (troque `deal` por `meeting`, `task`, `contact`...). Com `&required=true` vêm só os obrigatórios da conta. ## Erros ```json { \"reason\": \"Missing required parameters\", \"message\": \"Missing required parameters\", \"code\": \"VALIDATION_ERROR\", \"errors\": [ { \"field\": \"title\", \"message\": \"must NOT have fewer than 1 characters\", \"keyword\": \"minLength\" } ] } ``` | Status | Quando | |---|---| | `400` | Corpo inválido: campo obrigatório ausente, tipo errado, valor fora da lista | | `401` | Token ausente, inválido ou vencido. Corpo: `{\"reason\": \"Access Denied\"}` | | `403` | O Service Account não tem a permissão da rota (`type: SA_PERMISSION_DENIED`, com `requiredPermission`) | | `404` | Registro não encontrado | | `409` | O registro não está no estado que a operação exige | | `429` | Limite de requisições excedido. Espere o tempo de `Retry-After` | ## Permissões Um Service Account só chama as rotas que as permissões dele liberam. Cada operação desta referência informa a permissão exigida, quando há uma: marque-a ao criar o Service Account. Uma chamada sem a permissão devolve `403` com o nome dela em `requiredPermission`. Rotas de administração da conta (usuários, perfis, criação de webhooks, configurações) exigem um usuário administrador e não estão disponíveis para Service Accounts; por isso não aparecem aqui. ## Limite de requisições Os limites são aplicados por conta. Ao receber `429`, espere os segundos indicados em `Retry-After` e tente de novo com intervalo crescente. ## Área de trabalho Em contas com áreas de trabalho, a API define a área do registro pela credencial ou pelo registro pai. Não envie `workspace`. # Webhooks Para ser avisado quando algo muda no CRM, em vez de consultar a API de tempos em tempos, use webhooks. Um administrador cria o webhook no CRM, em **Integrações › Webhooks**, informando a URL do seu sistema e os eventos. A lista de eventos está em `GET /api/webhooks/triggers`; o formato da entrega, a assinatura e os reenvios estão na seção Webhooks do portal. # Cobertura Esta referência cobre Contatos (leads, prospects e clientes), Empresas, Oportunidades, Pipelines, etapas e motivos de perda, Jornadas, Reuniões, Tarefas, Observações, Tickets, Atendimentos, Usuários, Equipes, Áreas de trabalho, Campos personalizados e os eventos de webhook.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 2026-11
|
|
6
6
|
* Contact: suporte@magnetcustomer.com
|
|
@@ -15,6 +15,8 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
15
15
|
import type { DeleteMeetings200Response } from '../models';
|
|
16
16
|
import type { DeleteMeetingsRequest } from '../models';
|
|
17
17
|
import type { FinishMeetingRequest } from '../models';
|
|
18
|
+
import type { ListMeetingRooms200Response } from '../models';
|
|
19
|
+
import type { ListMeetingTypes200Response } from '../models';
|
|
18
20
|
import type { ListMeetings200Response } from '../models';
|
|
19
21
|
import type { Meeting } from '../models';
|
|
20
22
|
import type { MeetingCreate } from '../models';
|
|
@@ -24,7 +26,7 @@ import type { MeetingInput } from '../models';
|
|
|
24
26
|
*/
|
|
25
27
|
export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
28
|
/**
|
|
27
|
-
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
|
|
29
|
+
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`. **Permissão do Service Account:** `meetings.create`
|
|
28
30
|
* @summary Criar reunião
|
|
29
31
|
* @param {MeetingCreate} meetingCreate
|
|
30
32
|
* @param {*} [options] Override http request option.
|
|
@@ -32,7 +34,7 @@ export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32
34
|
*/
|
|
33
35
|
createMeeting: (meetingCreate: MeetingCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
36
|
/**
|
|
35
|
-
*
|
|
37
|
+
* **Permissão do Service Account:** `meetings.delete`
|
|
36
38
|
* @summary Excluir reunião
|
|
37
39
|
* @param {string} id ID do registro.
|
|
38
40
|
* @param {*} [options] Override http request option.
|
|
@@ -57,7 +59,7 @@ export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
57
59
|
*/
|
|
58
60
|
finishMeeting: (id: string, finishMeetingRequest?: FinishMeetingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
61
|
/**
|
|
60
|
-
*
|
|
62
|
+
* **Permissão do Service Account:** `meetings.read`
|
|
61
63
|
* @summary Obter reunião
|
|
62
64
|
* @param {string} id ID do registro.
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
@@ -65,14 +67,32 @@ export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
65
67
|
*/
|
|
66
68
|
getMeeting: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
69
|
/**
|
|
68
|
-
*
|
|
70
|
+
* Use para descobrir o `room` de uma reunião.
|
|
71
|
+
* @summary Listar salas de reunião
|
|
72
|
+
* @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
73
|
+
* @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
listMeetingRooms: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
78
|
+
/**
|
|
79
|
+
* Use para descobrir o `type` de uma reunião.
|
|
80
|
+
* @summary Listar tipos de reunião
|
|
81
|
+
* @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
82
|
+
* @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
listMeetingTypes: (page?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
87
|
+
/**
|
|
88
|
+
* Ordenação padrão: `start` decrescente. **Permissão do Service Account:** `meetings.list`
|
|
69
89
|
* @summary Listar reuniões
|
|
70
90
|
* @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
71
91
|
* @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
72
92
|
* @param {string} [sortBy] Campo de ordenação. O padrão varia por recurso.
|
|
73
93
|
* @param {ListMeetingsSortTypeEnum} [sortType] Direção da ordenação.
|
|
74
94
|
* @param {string} [staff] ID do organizador.
|
|
75
|
-
* @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores.
|
|
95
|
+
* @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (`?staffs[]=id1&staffs[]=id2`).
|
|
76
96
|
* @param {string} [type] ID do tipo de reunião.
|
|
77
97
|
* @param {string} [room] ID da sala.
|
|
78
98
|
* @param {string} [contact] ID do contato.
|
|
@@ -80,7 +100,7 @@ export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
80
100
|
* @param {string} [organization] ID da empresa.
|
|
81
101
|
* @param {ListMeetingsPriorityEnum} [priority] Prioridade.
|
|
82
102
|
* @param {ListMeetingsStatusEnum} [status] Situação.
|
|
83
|
-
* @param {Array<string>} [labels] Etiquetas.
|
|
103
|
+
* @param {Array<string>} [labels] Etiquetas. Lista de IDs: envie com colchetes, mesmo para um só valor (`?labels[]=id1&labels[]=id2`).
|
|
84
104
|
* @param {string} [startMinDate] Início a partir de (timestamp em ms ou data ISO).
|
|
85
105
|
* @param {string} [startMaxDate] Início até (timestamp em ms ou data ISO).
|
|
86
106
|
* @param {number} [createdAtMinDate] Criada a partir de (timestamp em milissegundos).
|
|
@@ -92,7 +112,7 @@ export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
92
112
|
*/
|
|
93
113
|
listMeetings: (page?: number, limit?: number, sortBy?: string, sortType?: ListMeetingsSortTypeEnum, staff?: string, staffs?: Array<string>, type?: string, room?: string, contact?: string, deal?: string, organization?: string, priority?: ListMeetingsPriorityEnum, status?: ListMeetingsStatusEnum, labels?: Array<string>, startMinDate?: string, startMaxDate?: string, createdAtMinDate?: number, createdAtMaxDate?: number, visualization?: ListMeetingsVisualizationEnum, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
114
|
/**
|
|
95
|
-
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
|
|
115
|
+
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`. **Permissão do Service Account:** `meetings.update`
|
|
96
116
|
* @summary Substituir reunião
|
|
97
117
|
* @param {string} id ID do registro.
|
|
98
118
|
* @param {MeetingCreate} meetingCreate
|
|
@@ -115,7 +135,7 @@ export declare const MeetingsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
115
135
|
*/
|
|
116
136
|
export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
117
137
|
/**
|
|
118
|
-
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
|
|
138
|
+
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`. **Permissão do Service Account:** `meetings.create`
|
|
119
139
|
* @summary Criar reunião
|
|
120
140
|
* @param {MeetingCreate} meetingCreate
|
|
121
141
|
* @param {*} [options] Override http request option.
|
|
@@ -123,7 +143,7 @@ export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
|
123
143
|
*/
|
|
124
144
|
createMeeting(meetingCreate: MeetingCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Meeting>>;
|
|
125
145
|
/**
|
|
126
|
-
*
|
|
146
|
+
* **Permissão do Service Account:** `meetings.delete`
|
|
127
147
|
* @summary Excluir reunião
|
|
128
148
|
* @param {string} id ID do registro.
|
|
129
149
|
* @param {*} [options] Override http request option.
|
|
@@ -148,7 +168,7 @@ export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
|
148
168
|
*/
|
|
149
169
|
finishMeeting(id: string, finishMeetingRequest?: FinishMeetingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Meeting>>;
|
|
150
170
|
/**
|
|
151
|
-
*
|
|
171
|
+
* **Permissão do Service Account:** `meetings.read`
|
|
152
172
|
* @summary Obter reunião
|
|
153
173
|
* @param {string} id ID do registro.
|
|
154
174
|
* @param {*} [options] Override http request option.
|
|
@@ -156,14 +176,32 @@ export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
|
156
176
|
*/
|
|
157
177
|
getMeeting(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Meeting>>;
|
|
158
178
|
/**
|
|
159
|
-
*
|
|
179
|
+
* Use para descobrir o `room` de uma reunião.
|
|
180
|
+
* @summary Listar salas de reunião
|
|
181
|
+
* @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
182
|
+
* @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
listMeetingRooms(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMeetingRooms200Response>>;
|
|
187
|
+
/**
|
|
188
|
+
* Use para descobrir o `type` de uma reunião.
|
|
189
|
+
* @summary Listar tipos de reunião
|
|
190
|
+
* @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
191
|
+
* @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
listMeetingTypes(page?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMeetingTypes200Response>>;
|
|
196
|
+
/**
|
|
197
|
+
* Ordenação padrão: `start` decrescente. **Permissão do Service Account:** `meetings.list`
|
|
160
198
|
* @summary Listar reuniões
|
|
161
199
|
* @param {number} [page] Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
162
200
|
* @param {number} [limit] Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
163
201
|
* @param {string} [sortBy] Campo de ordenação. O padrão varia por recurso.
|
|
164
202
|
* @param {ListMeetingsSortTypeEnum} [sortType] Direção da ordenação.
|
|
165
203
|
* @param {string} [staff] ID do organizador.
|
|
166
|
-
* @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores.
|
|
204
|
+
* @param {Array<string>} [staffs] Usuários: busca em organizador, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (`?staffs[]=id1&staffs[]=id2`).
|
|
167
205
|
* @param {string} [type] ID do tipo de reunião.
|
|
168
206
|
* @param {string} [room] ID da sala.
|
|
169
207
|
* @param {string} [contact] ID do contato.
|
|
@@ -171,7 +209,7 @@ export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
|
171
209
|
* @param {string} [organization] ID da empresa.
|
|
172
210
|
* @param {ListMeetingsPriorityEnum} [priority] Prioridade.
|
|
173
211
|
* @param {ListMeetingsStatusEnum} [status] Situação.
|
|
174
|
-
* @param {Array<string>} [labels] Etiquetas.
|
|
212
|
+
* @param {Array<string>} [labels] Etiquetas. Lista de IDs: envie com colchetes, mesmo para um só valor (`?labels[]=id1&labels[]=id2`).
|
|
175
213
|
* @param {string} [startMinDate] Início a partir de (timestamp em ms ou data ISO).
|
|
176
214
|
* @param {string} [startMaxDate] Início até (timestamp em ms ou data ISO).
|
|
177
215
|
* @param {number} [createdAtMinDate] Criada a partir de (timestamp em milissegundos).
|
|
@@ -183,7 +221,7 @@ export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
|
183
221
|
*/
|
|
184
222
|
listMeetings(page?: number, limit?: number, sortBy?: string, sortType?: ListMeetingsSortTypeEnum, staff?: string, staffs?: Array<string>, type?: string, room?: string, contact?: string, deal?: string, organization?: string, priority?: ListMeetingsPriorityEnum, status?: ListMeetingsStatusEnum, labels?: Array<string>, startMinDate?: string, startMaxDate?: string, createdAtMinDate?: number, createdAtMaxDate?: number, visualization?: ListMeetingsVisualizationEnum, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListMeetings200Response>>;
|
|
185
223
|
/**
|
|
186
|
-
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
|
|
224
|
+
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`. **Permissão do Service Account:** `meetings.update`
|
|
187
225
|
* @summary Substituir reunião
|
|
188
226
|
* @param {string} id ID do registro.
|
|
189
227
|
* @param {MeetingCreate} meetingCreate
|
|
@@ -206,7 +244,7 @@ export declare const MeetingsApiFp: (configuration?: Configuration) => {
|
|
|
206
244
|
*/
|
|
207
245
|
export declare const MeetingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
208
246
|
/**
|
|
209
|
-
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
|
|
247
|
+
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`. **Permissão do Service Account:** `meetings.create`
|
|
210
248
|
* @summary Criar reunião
|
|
211
249
|
* @param {MeetingsApiCreateMeetingRequest} requestParameters Request parameters.
|
|
212
250
|
* @param {*} [options] Override http request option.
|
|
@@ -214,7 +252,7 @@ export declare const MeetingsApiFactory: (configuration?: Configuration, basePat
|
|
|
214
252
|
*/
|
|
215
253
|
createMeeting(requestParameters: MeetingsApiCreateMeetingRequest, options?: RawAxiosRequestConfig): AxiosPromise<Meeting>;
|
|
216
254
|
/**
|
|
217
|
-
*
|
|
255
|
+
* **Permissão do Service Account:** `meetings.delete`
|
|
218
256
|
* @summary Excluir reunião
|
|
219
257
|
* @param {MeetingsApiDeleteMeetingRequest} requestParameters Request parameters.
|
|
220
258
|
* @param {*} [options] Override http request option.
|
|
@@ -238,7 +276,7 @@ export declare const MeetingsApiFactory: (configuration?: Configuration, basePat
|
|
|
238
276
|
*/
|
|
239
277
|
finishMeeting(requestParameters: MeetingsApiFinishMeetingRequest, options?: RawAxiosRequestConfig): AxiosPromise<Meeting>;
|
|
240
278
|
/**
|
|
241
|
-
*
|
|
279
|
+
* **Permissão do Service Account:** `meetings.read`
|
|
242
280
|
* @summary Obter reunião
|
|
243
281
|
* @param {MeetingsApiGetMeetingRequest} requestParameters Request parameters.
|
|
244
282
|
* @param {*} [options] Override http request option.
|
|
@@ -246,7 +284,23 @@ export declare const MeetingsApiFactory: (configuration?: Configuration, basePat
|
|
|
246
284
|
*/
|
|
247
285
|
getMeeting(requestParameters: MeetingsApiGetMeetingRequest, options?: RawAxiosRequestConfig): AxiosPromise<Meeting>;
|
|
248
286
|
/**
|
|
249
|
-
*
|
|
287
|
+
* Use para descobrir o `room` de uma reunião.
|
|
288
|
+
* @summary Listar salas de reunião
|
|
289
|
+
* @param {MeetingsApiListMeetingRoomsRequest} requestParameters Request parameters.
|
|
290
|
+
* @param {*} [options] Override http request option.
|
|
291
|
+
* @throws {RequiredError}
|
|
292
|
+
*/
|
|
293
|
+
listMeetingRooms(requestParameters?: MeetingsApiListMeetingRoomsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListMeetingRooms200Response>;
|
|
294
|
+
/**
|
|
295
|
+
* Use para descobrir o `type` de uma reunião.
|
|
296
|
+
* @summary Listar tipos de reunião
|
|
297
|
+
* @param {MeetingsApiListMeetingTypesRequest} requestParameters Request parameters.
|
|
298
|
+
* @param {*} [options] Override http request option.
|
|
299
|
+
* @throws {RequiredError}
|
|
300
|
+
*/
|
|
301
|
+
listMeetingTypes(requestParameters?: MeetingsApiListMeetingTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListMeetingTypes200Response>;
|
|
302
|
+
/**
|
|
303
|
+
* Ordenação padrão: `start` decrescente. **Permissão do Service Account:** `meetings.list`
|
|
250
304
|
* @summary Listar reuniões
|
|
251
305
|
* @param {MeetingsApiListMeetingsRequest} requestParameters Request parameters.
|
|
252
306
|
* @param {*} [options] Override http request option.
|
|
@@ -254,7 +308,7 @@ export declare const MeetingsApiFactory: (configuration?: Configuration, basePat
|
|
|
254
308
|
*/
|
|
255
309
|
listMeetings(requestParameters?: MeetingsApiListMeetingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListMeetings200Response>;
|
|
256
310
|
/**
|
|
257
|
-
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
|
|
311
|
+
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`. **Permissão do Service Account:** `meetings.update`
|
|
258
312
|
* @summary Substituir reunião
|
|
259
313
|
* @param {MeetingsApiReplaceMeetingRequest} requestParameters Request parameters.
|
|
260
314
|
* @param {*} [options] Override http request option.
|
|
@@ -310,6 +364,32 @@ export interface MeetingsApiGetMeetingRequest {
|
|
|
310
364
|
*/
|
|
311
365
|
readonly id: string;
|
|
312
366
|
}
|
|
367
|
+
/**
|
|
368
|
+
* Request parameters for listMeetingRooms operation in MeetingsApi.
|
|
369
|
+
*/
|
|
370
|
+
export interface MeetingsApiListMeetingRoomsRequest {
|
|
371
|
+
/**
|
|
372
|
+
* Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
373
|
+
*/
|
|
374
|
+
readonly page?: number;
|
|
375
|
+
/**
|
|
376
|
+
* Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
377
|
+
*/
|
|
378
|
+
readonly limit?: number;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Request parameters for listMeetingTypes operation in MeetingsApi.
|
|
382
|
+
*/
|
|
383
|
+
export interface MeetingsApiListMeetingTypesRequest {
|
|
384
|
+
/**
|
|
385
|
+
* Página, a partir de 1. **Envie sempre**: sem `page`, a resposta vem como lista simples, sem o envelope de paginação, e `limit` é ignorado.
|
|
386
|
+
*/
|
|
387
|
+
readonly page?: number;
|
|
388
|
+
/**
|
|
389
|
+
* Registros por página. Padrão: 15, salvo indicação na operação. Máximo: 100 — acima disso a API usa 100.
|
|
390
|
+
*/
|
|
391
|
+
readonly limit?: number;
|
|
392
|
+
}
|
|
313
393
|
/**
|
|
314
394
|
* Request parameters for listMeetings operation in MeetingsApi.
|
|
315
395
|
*/
|
|
@@ -335,7 +415,7 @@ export interface MeetingsApiListMeetingsRequest {
|
|
|
335
415
|
*/
|
|
336
416
|
readonly staff?: string;
|
|
337
417
|
/**
|
|
338
|
-
* Usuários: busca em organizador, participantes e observadores.
|
|
418
|
+
* Usuários: busca em organizador, participantes e observadores. Lista de IDs: envie com colchetes, mesmo para um só valor (`?staffs[]=id1&staffs[]=id2`).
|
|
339
419
|
*/
|
|
340
420
|
readonly staffs?: Array<string>;
|
|
341
421
|
/**
|
|
@@ -367,7 +447,7 @@ export interface MeetingsApiListMeetingsRequest {
|
|
|
367
447
|
*/
|
|
368
448
|
readonly status?: ListMeetingsStatusEnum;
|
|
369
449
|
/**
|
|
370
|
-
* Etiquetas.
|
|
450
|
+
* Etiquetas. Lista de IDs: envie com colchetes, mesmo para um só valor (`?labels[]=id1&labels[]=id2`).
|
|
371
451
|
*/
|
|
372
452
|
readonly labels?: Array<string>;
|
|
373
453
|
/**
|
|
@@ -420,7 +500,7 @@ export interface MeetingsApiUpdateMeetingRequest {
|
|
|
420
500
|
*/
|
|
421
501
|
export declare class MeetingsApi extends BaseAPI {
|
|
422
502
|
/**
|
|
423
|
-
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`.
|
|
503
|
+
* Obrigatórios por padrão: `title` e `start`. `staff` e `calendar` são preenchidos pela API quando omitidos. Os campos obrigatórios podem variar por conta: o administrador define quais campos de sistema são obrigatórios. `GET /api/customfields?feature=meeting&required=true` devolve os campos obrigatórios da conta. Quando falta um deles, a API responde `400` com `code: MISSING_REQUIRED` e a lista em `fields`. Referências (`staff`, `contact`, `deal`...) aceitam só o ID em texto. Enviar o objeto (`{\"_id\": \"...\"}`) devolve `400 VALIDATION_ERROR`. **Permissão do Service Account:** `meetings.create`
|
|
424
504
|
* @summary Criar reunião
|
|
425
505
|
* @param {MeetingsApiCreateMeetingRequest} requestParameters Request parameters.
|
|
426
506
|
* @param {*} [options] Override http request option.
|
|
@@ -428,7 +508,7 @@ export declare class MeetingsApi extends BaseAPI {
|
|
|
428
508
|
*/
|
|
429
509
|
createMeeting(requestParameters: MeetingsApiCreateMeetingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Meeting, any, {}, any>>;
|
|
430
510
|
/**
|
|
431
|
-
*
|
|
511
|
+
* **Permissão do Service Account:** `meetings.delete`
|
|
432
512
|
* @summary Excluir reunião
|
|
433
513
|
* @param {MeetingsApiDeleteMeetingRequest} requestParameters Request parameters.
|
|
434
514
|
* @param {*} [options] Override http request option.
|
|
@@ -452,7 +532,7 @@ export declare class MeetingsApi extends BaseAPI {
|
|
|
452
532
|
*/
|
|
453
533
|
finishMeeting(requestParameters: MeetingsApiFinishMeetingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Meeting, any, {}, any>>;
|
|
454
534
|
/**
|
|
455
|
-
*
|
|
535
|
+
* **Permissão do Service Account:** `meetings.read`
|
|
456
536
|
* @summary Obter reunião
|
|
457
537
|
* @param {MeetingsApiGetMeetingRequest} requestParameters Request parameters.
|
|
458
538
|
* @param {*} [options] Override http request option.
|
|
@@ -460,7 +540,23 @@ export declare class MeetingsApi extends BaseAPI {
|
|
|
460
540
|
*/
|
|
461
541
|
getMeeting(requestParameters: MeetingsApiGetMeetingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Meeting, any, {}, any>>;
|
|
462
542
|
/**
|
|
463
|
-
*
|
|
543
|
+
* Use para descobrir o `room` de uma reunião.
|
|
544
|
+
* @summary Listar salas de reunião
|
|
545
|
+
* @param {MeetingsApiListMeetingRoomsRequest} requestParameters Request parameters.
|
|
546
|
+
* @param {*} [options] Override http request option.
|
|
547
|
+
* @throws {RequiredError}
|
|
548
|
+
*/
|
|
549
|
+
listMeetingRooms(requestParameters?: MeetingsApiListMeetingRoomsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
|
|
550
|
+
/**
|
|
551
|
+
* Use para descobrir o `type` de uma reunião.
|
|
552
|
+
* @summary Listar tipos de reunião
|
|
553
|
+
* @param {MeetingsApiListMeetingTypesRequest} requestParameters Request parameters.
|
|
554
|
+
* @param {*} [options] Override http request option.
|
|
555
|
+
* @throws {RequiredError}
|
|
556
|
+
*/
|
|
557
|
+
listMeetingTypes(requestParameters?: MeetingsApiListMeetingTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
|
|
558
|
+
/**
|
|
559
|
+
* Ordenação padrão: `start` decrescente. **Permissão do Service Account:** `meetings.list`
|
|
464
560
|
* @summary Listar reuniões
|
|
465
561
|
* @param {MeetingsApiListMeetingsRequest} requestParameters Request parameters.
|
|
466
562
|
* @param {*} [options] Override http request option.
|
|
@@ -468,7 +564,7 @@ export declare class MeetingsApi extends BaseAPI {
|
|
|
468
564
|
*/
|
|
469
565
|
listMeetings(requestParameters?: MeetingsApiListMeetingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<import("../models").Page, any, {}, any>>;
|
|
470
566
|
/**
|
|
471
|
-
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`.
|
|
567
|
+
* Substitui o registro: reenvie o objeto completo. Para alterar só alguns campos, use `PATCH`. **Permissão do Service Account:** `meetings.update`
|
|
472
568
|
* @summary Substituir reunião
|
|
473
569
|
* @param {MeetingsApiReplaceMeetingRequest} requestParameters Request parameters.
|
|
474
570
|
* @param {*} [options] Override http request option.
|