Conteúdo do post
","createdAt":"2021-08-10T15:00:00Z","updatedAt":"2021-08-10T15:00:00Z","totalComments":1,"totalLikes":1,"member":{"id":4109,"email":"teste@example.com"},"space":{"id":4329,"name":"Espaço 1"},"tags":["tag1","tag2"]}]}}}}}}}},"/heycamp/v1/posts/community/:communityId":{"get":{"operationId":"getheycampv1postscommunitycommunityId","summary":"Listar posts de uma comunidade","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_posts"]}],"parameters":[{"name":"communityId","description":"Id da comunidade onde os posts estão associados","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listar posts associados à comunidade","content":{"application/json":{"examples":{"default":{"value":{"page":1,"pages":1,"itemsPerPage":1,"totalItems":2,"items":[{"id":1598,"title":"Post 1","createdAt":"2021-08-10T15:00:00Z","updatedAt":"2021-08-10T15:00:00Z","totalComments":1,"totalLikes":1,"member":{"id":4109,"email":"teste@example.com"},"space":{"id":4329,"name":"Espaço 1"},"tags":["tag1","tag2"]},{"id":1599,"title":"Post 2","createdAt":"2021-08-11T15:00:00Z","updatedAt":"2021-08-11T15:00:00Z","totalComments":5,"totalLikes":10,"member":{"id":8330,"email":"teste2@example.com"},"space":{"id":4330,"name":"Espaço 2"},"tags":["tag3"]}]}}}}}}}}},"/heycamp/v1/posts/community/:communityId/top/commented":{"get":{"operationId":"getheycampv1postscommunitycommunityIdtopcommented","summary":"Listar os 5 posts mais comentados da comunidade por um determinado período","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_posts"]}],"parameters":[{"name":"communityId","description":"Id da comunidade onde os posts estão associados","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listar posts associados à comunidade","content":{"application/json":{"examples":{"default":{"value":{"items":[{"id":1598,"title":"Post 1","createdAt":"2021-08-10T15:00:00Z","updatedAt":"2021-08-10T15:00:00Z","totalComments":20,"totalLikes":17,"member":{"id":4329,"email":"teste@example.com"},"space":{"id":4329,"name":"Espaço 1"},"tags":["tag1"]},{"id":1598,"title":"Post 2","createdAt":"2021-08-10T15:00:00Z","updatedAt":"2021-08-10T15:00:00Z","totalComments":10,"totalLikes":9,"member":{"id":4329,"email":"teste@example.com"},"space":{"id":4329,"name":"Espaço 2"},"tags":["tag2"]}]}}}}}}}}},"/heycamp/v1/posts/community/:communityId/top/liked":{"get":{"operationId":"getheycampv1postscommunitycommunityIdtopliked","summary":"Listar os 5 posts com mais curtidas da comunidade por um determinado período","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_posts"]}],"parameters":[{"name":"communityId","description":"Id da comunidade onde os posts estão associados","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listar posts associados à comunidade","content":{"application/json":{"examples":{"default":{"value":{"items":[{"id":1598,"title":"Post 1","createdAt":"2021-08-10T15:00:00Z","updatedAt":"2021-08-10T15:00:00Z","totalComments":1,"totalLikes":1,"member":{"id":4109,"email":"teste@example.com"},"space":{"id":4329,"name":"Espaço 1"},"tags":["tag1","tag2"]},{"id":1599,"title":"Post 2","createdAt":"2021-08-11T15:00:00Z","updatedAt":"2021-08-11T15:00:00Z","totalComments":5,"totalLikes":10,"member":{"id":8330,"email":"teste2@example.com"},"space":{"id":4330,"name":"Espaço 2"},"tags":["tag3"]}]}}}}}}}}},"/heycamp/v1/posts/community/:communityId/total/comments":{"get":{"operationId":"getheycampv1postscommunitycommunityIdtotalcomments","summary":"Listar o total de comentários da comunidade por um determinado período","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_posts"]}],"parameters":[{"name":"communityId","description":"Id da comunidade que você deseja buscar o total de comentários","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Exibição do total de comentários","content":{"application/json":{"examples":{"default":{"value":{"totalComments":40}}}}}}}}},"/myeduzz/v1/affiliates":{"get":{"operationId":"getmyeduzzv1affiliates","summary":"Listagem de todos os afiliados do produtor com base nos filtros fornecidos.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_affiliates_read"]}],"parameters":[{"name":"productIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de afiliados do produtor","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"32366478","status":"approved","requestedAt":"2024-06-17T17:25:31.000Z","approvedAt":"2024-06-17T17:25:31.000Z","updatedAt":"2024-06-17T17:25:32.150Z","createdAt":"2024-06-17T17:25:31.470Z","product":{"id":"1739854","name":"Produto de exemplo"},"customer":{"id":"74452654","name":"José da Silva"}}]}}}}}}}}},"/myeduzz/v1/subscriptions/:id/recurring-date":{"put":{"operationId":"putmyeduzzv1subscriptionsidrecurringdate","summary":"Modifica o dia de cobrança de uma assinatura específica.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_write"]}],"parameters":[{"name":"id","description":"Id da assinatura","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"dueDateDay":{"type":"string","example":"Dia do vencimento a ser alterado no contrato.","enum":[{"key":"1","description":"1"},{"key":"5","description":"5"},{"key":"10","description":"10"},{"key":"15","description":"15"},{"key":"20","description":"20"},{"key":"25","description":"25"}]},"motive":{"type":"string","example":"Motivo da alteração do dia do vencimento.","enum":[{"key":"Solicitação do cliente","description":"Solicitação do cliente"},{"key":"Negociação comercial","description":"Negociação comercial"},{"key":"Reorganização financeira do cliente","description":"Reorganização financeira do cliente"},{"key":"Mudança no método de pagamento","description":"Mudança no método de pagamento"},{"key":"Problemas com a data atual de pagamento","description":"Problemas com a data atual de pagamento"}]}}}}}},"responses":{"200":{"description":"Alteração solicitada com sucesso","content":{"application/json":{"examples":{"default":{"value":{"message":"Solicitação de alteração de data de vencimento enviada para o cliente."}}}}}}}}},"/myeduzz/v1/subscriptions/bulk-cancel":{"post":{"operationId":"postmyeduzzv1subscriptionsbulkcancel","summary":"Realiza o cancelamento em massa de contratos.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_write"]}],"parameters":[],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"subscriptions":{"type":"array","example":"Ids dos contratos a serem cancelados.","items":{"type":"string","example":"123456789"}},"cancelReason":{"type":"string","example":"Problemas com o pagamento."}}}}}},"responses":{"202":{"description":"Contrato solicitado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"message":"Cancelamento solicitado com sucesso. Aguarde o processo ser finalizado."}}}}}}}}},"/myeduzz/v1/subscriptions/:id":{"get":{"operationId":"getmyeduzzv1subscriptionsid","summary":"Obtém os detalhes de uma assinatura por id","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_read"]}],"parameters":[{"name":"id","description":"Id da assinatura","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes do contrato informado","content":{"application/json":{"examples":{"default":{"value":{"id":"123456","createdAt":"2024-01-15T15:00:00.000Z","updatedAt":"2024-01-20T15:00:00.000Z","status":"canceled","firstInvoiceId":"654321","isFinite":true,"isUnlimitedInstallments":false,"hasNegotiation":false,"interruption":{"createdAt":"2024-01-20T15:00:00.000Z","type":"cancel","removeAccessDate":"2024-02-30T15:00:00.000Z","reason":"Cliente não está realizando os pagamentos corretamente","origin":"MyEduzz","previousStatus":"late","responsible":"Atendimento Eduzz"},"recurrence":{"startsAt":"2024-01-15T15:00:00.000Z","nextDueDate":"2024-02-15T15:00:00.000Z","currentDueDate":"2024-01-15T15:00:00.000Z","finalDueDate":"2025-06-15T15:00:00.000Z","finishesAt":"2025-07-15T15:00:00.000Z","frequency":{"type":"monthly","value":1}},"charges":{"total":6,"current":1,"paid":1,"pending":0,"negotiated":0},"products":[{"id":"123321","title":"Teste Assinatura","hasMembershipFee":false,"membershipFee":{"currency":"BRL","value":0},"deliveries":["files","external","nutror","alpaClass"]}],"payment":{"price":{"currency":"BRL","value":1000},"method":"bankslip","installments":6},"client":{"name":"Fulano de tal","email":"fulanodetal@eduzz.com","phone":{"countryCode":"55","areaCode":"15","number":"999999999"}}}}}}}}}}},"/myeduzz/v1/subscriptions":{"get":{"operationId":"getmyeduzzv1subscriptions","summary":"Obtém os detalhes das assinaturas por intervalo de data","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"filterBy","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes da assinatura","content":{"application/json":{"examples":{"default":{"value":{"pages":49,"page":2,"itemsPerPage":15,"totalItems":733,"items":[{"id":"123456","createdAt":"2024-01-15T15:00:00.000Z","updatedAt":"2024-01-20T15:00:00.000Z","status":"canceled","firstInvoiceId":"654321","isFinite":true,"isUnlimitedInstallments":false,"hasNegotiation":false,"interruption":{"createdAt":"2024-01-20T15:00:00.000Z","type":"cancel","removeAccessDate":"2024-02-30T15:00:00.000Z","reason":"Cliente não está realizando os pagamentos corretamente","origin":"MyEduzz","previousStatus":"late","responsible":"Atendimento Eduzz"},"recurrence":{"startsAt":"2024-01-15T15:00:00.000Z","nextDueDate":"2024-02-15T15:00:00.000Z","currentDueDate":"2024-01-15T15:00:00.000Z","finalDueDate":"2025-06-15T15:00:00.000Z","finishesAt":"2025-07-15T15:00:00.000Z","frequency":{"type":"monthly","value":1}},"charges":{"total":6,"current":1,"paid":1,"pending":0,"negotiated":0},"products":[{"id":"123321","title":"Teste Assinatura","hasMembershipFee":false,"membershipFee":{"currency":"BRL","value":0},"deliveries":["files","external","nutror","alpaClass"]}],"payment":{"price":{"currency":"BRL","value":1000},"method":"bankslip","installments":6},"client":{"name":"Fulano de tal","email":"fulanodetal@eduzz.com","phone":{"countryCode":"55","areaCode":"15","number":"999999999"}}}]}}}}}}}}},"/myeduzz/v1/subscriptions/customers/:email":{"get":{"operationId":"getmyeduzzv1subscriptionscustomersemail","summary":"Obtém os detalhes do cliente via email","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_read"]}],"parameters":[{"name":"email","description":"E-mail do cliente","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes do cliente informado","content":{"application/json":{"examples":{"default":{"value":{"name":"fulanodetal","email":"fulanodetal@eduzz.com","phone":{"countryCode":"55","areaCode":"15","number":"999999999"},"subscriptions":[{"id":"2060691","startDate":"2024-01-15T15:00:00.000Z","updatedAt":null,"status":"upToDate","firstInvoiceId":"51128029","interruption":{"createdAt":"2024-01-15T15:00:00.000Z","type":"cancel","removeAccessDate":"2024-01-15T15:00:00.000Z","reason":"Cliente não está realizando os pagamentos corretamente","origin":"Myeduzz","previousStatus":"late","responsible":"Atendimento Eduzz"},"isUnlimitedInstallments":false,"hasNegotiation":false,"isFinite":false,"recurrence":{"startsAt":"2024-01-15T15:00:00.000Z","nextDueDate":"2024-02-15T15:00:00.000Z","currentDueDate":"2024-01-15T15:00:00.000Z","finalDueDate":"2025-01-09T15:00:00.000Z","finishesAt":"2025-01-09T15:00:00.000Z","frequency":{"type":"monthly","value":1}},"products":[{"id":"1737509","name":"Teste Assinatura","hasMembershipFee":false,"membershipFee":{"currency":"BRL","value":0}}],"payment":{"price":{"currency":"BRL","value":1000},"method":"bankslip","installments":6},"charges":{"total":6,"current":2,"paid":1,"pending":3,"negotiated":0}}]}}}}}}}}},"/myeduzz/v1/subscriptions/:id/invoices":{"get":{"operationId":"getmyeduzzv1subscriptionsidinvoices","summary":"Obtém as faturas de uma assinatura.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_read"]}],"parameters":[{"name":"id","description":"Id da assinatura","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de faturas do contrato","content":{"application/json":{"examples":{"default":{"value":{"items":[{"id":"123","subscriptionId":"12345","createdAt":"2024-05-24T10:00:34.000Z","dueDate":"2024-06-24T00:00:00.000Z","coupon":"teste","hasAffiliate":false,"status":"open","payment":{"amount":{"currency":"BRL","value":20},"link":"https://url-teste-pagamento/123456/123456?t=x","method":"creditCard"},"items":[{"product":{"id":"123456789","title":"Teste"},"description":"Teste descrição produto","amount":{"currency":"BRL","value":20},"total":{"currency":"BRL","value":20},"quantity":1}]}]}}}}}}}}},"/myeduzz/v1/subscriptions/:id/reactivate":{"post":{"operationId":"postmyeduzzv1subscriptionsidreactivate","summary":"Realiza a reativação de um contrato","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_write"]}],"parameters":[{"name":"id","description":"Id da assinatura","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Contrato reativado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"message":"Reativação solicitada com sucesso. Aguarde o processo ser finalizado."}}}}}}}}},"/myeduzz/v1/subscriptions/:id/send-card-change-email":{"put":{"operationId":"putmyeduzzv1subscriptionsidsendcardchangeemail","summary":"Envia email para alteração do cartão de pagamento de um contrato específico","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_write"]}],"parameters":[{"name":"id","description":"Id da assinatura","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Alteração solicitada com sucesso","content":{"application/json":{"examples":{"default":{"value":{}}}}}}}}},"/myeduzz/v1/customers/:email":{"get":{"operationId":"getmyeduzzv1customersemail","summary":"Obtém detalhes de um comprador","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_customers_read"]}],"parameters":[{"name":"email","description":"E-mail do comprador que se deseja obter os detalhes","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes do comprador","content":{"application/json":{"examples":{"default":{"value":{"id":"123456","name":"John Doe","email":"buyer@teste.com","phone":{"countryCode":"55","areaCode":"15","number":"999999999"},"address":{"street":"Av. Sorocaba","number":"500","supplement":"Casa 2","cep":"18044-390","state":"SP","country":"BR"}}}}}}}}}},"/myeduzz/v1/customers":{"get":{"operationId":"getmyeduzzv1customers","summary":"Listagem de todos os compradores com base nos filtros fornecidos.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_customers_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de compradores","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"123456","name":"John Doe","email":"buyer@teste.com","phone":{"countryCode":"55","areaCode":"15","number":"999999999"},"purchaseHistoryOverview":{"productsQuantity":10,"net":{"currency":"BRL","value":1000},"gross":{"currency":"BRL","value":1005}}}]}}}}}}}}},"/myeduzz/v1/financial/affiliate/fiscal-documents/:id/change-status":{"patch":{"operationId":"patchmyeduzzv1financialaffiliatefiscaldocumentsidchangestatus","summary":"Atualiza o status de um documento fiscal emitido a um afiliado","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_financial_write"]}],"parameters":[{"name":"id","description":"Id do documento fiscal","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":[{"key":"new","description":"Novo"},{"key":"pending","description":"Pendente"},{"key":"waitingDocument","description":"Aguardando documento"},{"key":"canceled","description":"Cancelado"},{"key":"processed","description":"Processado"},{"key":"approved","description":"Aprovado"},{"key":"fileGenerated","description":"Arquivo gerado"},{"key":"processing","description":"Processando"},{"key":"deleted","description":"Deletado"}]}}}}}},"responses":{"200":{"description":"Documento fiscal atualizado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"updated":true}}}}}}}}},"/myeduzz/v1/financial/buyer/fiscal-documents/:id/change-status":{"patch":{"operationId":"patchmyeduzzv1financialbuyerfiscaldocumentsidchangestatus","summary":"Atualiza o status de um documento fiscal emitido a um Comprador","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_financial_write"]}],"parameters":[{"name":"id","description":"Id do documento fiscal","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":[{"key":"new","description":"Novo"},{"key":"pending","description":"Pendente"},{"key":"waitingDocument","description":"Aguardando documento"},{"key":"canceled","description":"Cancelado"},{"key":"processed","description":"Processado"},{"key":"approved","description":"Aprovado"},{"key":"fileGenerated","description":"Arquivo gerado"},{"key":"processing","description":"Processando"},{"key":"deleted","description":"Deletado"}]}}}}}},"responses":{"200":{"description":"Documento fiscal atualizado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"updated":true}}}}}}}}},"/myeduzz/v2/financial/statement":{"get":{"operationId":"getmyeduzzv2financialstatement","summary":"Retorna o extrato financeiro com base nos filtros fornecidos.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_financial_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"saleId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes do extrato financeiro","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"1","creditDate":"2021-08-01T00:00:00.000Z","description":"Venda de produto 1 referente ao pedido 123456","saleId":"123456","type":"sale","value":{"currency":"BRL","value":100}}]}}}}}}}}},"/myeduzz/v1/financial/affiliate/fiscal-documents":{"get":{"operationId":"getmyeduzzv1financialaffiliatefiscaldocuments","summary":"Lista documentos fiscais do afiliado com base em critérios como datas, status, venda e conteúdo, detalhando informações fiscais e do cliente.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_financial_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}},{"name":"saleId","in":"query","required":false,"schema":{"type":"string"}},{"name":"productId","in":"query","required":false,"schema":{"type":"string"}},{"name":"documentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listagem de Documentos Fiscais","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":2,"items":[{"document":{"id":"1234567","name":"Empresa Fictícia - 12345678901","status":"Pendente","type":"Alunos / Clientes","baseValue":{"currency":"BRL","value":100},"emissionDate":"2024-11-04T21:17:02.000Z","referenceDate":"2024-10-30T09:45:39.000Z","processingDate":"2024-12-04T21:17:02.000Z","fileStatus":"5","taxBase":2,"basePercent":10,"taxValue":{"currency":"BRL","value":5}},"source":{"taxType":"J","companyName":"Empresa Fictícia","document":"12345678000190","ie":"ISENTO","im":null,"email":"empresa@ficticia.com","tel":null,"tel2":"11987654321","cell":null,"address":{"street":"Rua Fictícia","number":"123","complement":"Sala 1","district":"Centro","zipCode":"12345678","city":"Cidade Fictícia","uf":"SP"}},"destination":{"companyName":"Cliente Fictício","taxType":"F","taxId":"12345678901","ie":"ISENTO","im":null,"email":"cliente@ficticio.com","tel":null,"tel2":null,"cell":"+551199999999","address":{"street":"Rua 123","number":"2","complement":"Esquina Nova","district":"Jardim das Magnolias","zipCode":"9999999","countryForeign":null,"city":"São Paulo","uf":null,"country":null}},"sale":{"id":"7654321","paymentDate":"2024-10-30T09:45:39.000Z","total":{"currency":"BRL","value":100}},"client":{"id":"123456789","name":"Cliente Fictício","document":"12345678901","email":"cliente@ficticio.com","tel":null,"tel2":null,"cell":"+5511998765432","address":{"street":"Rua 123","number":"2","complement":null,"neighborhood":null,"zipCode":"","city":"São Paulo","state":null}},"product":{"id":"9876543","title":"Conteúdo Fictício"}},{"document":{"id":"7654321","name":"Outro Cliente - 10987654321","status":"Novo","type":"Alunos / Clientes","baseValue":{"currency":"BRL","value":200},"emissionDate":"2024-11-04T21:16:10.000Z","referenceDate":"2024-10-30T09:02:25.000Z","processingDate":"2024-12-04T21:16:10.000Z","fileStatus":"5","taxBase":2,"basePercent":10,"taxValue":{"currency":"BRL","value":5}},"source":{"taxType":null,"companyName":"Empresa Fictícia","document":"12345678000190","ie":"ISENTO","im":null,"email":"empresa@ficticia.com","tel":null,"tel2":"11987654321","cell":null,"address":{"street":"Rua Fictícia","number":"123","complement":"Sala 1","district":"Centro","zipCode":"12345678","city":"Cidade Fictícia","uf":"SP"}},"destination":{"companyName":"Outro Cliente","taxType":"F","taxId":"10987654321","ie":"ISENTO","im":null,"email":"outrocliente@ficticio.com","tel":null,"tel2":null,"cell":"+5511987654321","address":{"street":"Rua 123","number":"2","complement":null,"district":null,"zipCode":"","countryForeign":null,"city":"São Paulo","uf":null,"country":null}},"sale":{"id":"1234567","paymentDate":"2024-10-30T09:02:25.000Z","total":{"currency":"BRL","value":200}},"client":{"id":"987654321","name":"Outro Cliente","document":"10987654321","email":"outrocliente@ficticio.com","tel":null,"tel2":null,"cell":"+5511987654321","address":{"street":"Rua 123","number":"2","complement":null,"neighborhood":null,"zipCode":"","city":"São Paulo","state":null}},"product":{"id":"8765432","title":"Outro Conteúdo Fictício"}}]}}}}}}}}},"/myeduzz/v1/financial/buyer/fiscal-documents":{"get":{"operationId":"getmyeduzzv1financialbuyerfiscaldocuments","summary":"Lista documentos fiscais do comprador com base em critérios como datas, status, venda e conteúdo, detalhando informações fiscais e do cliente.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_financial_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}},{"name":"saleId","in":"query","required":false,"schema":{"type":"string"}},{"name":"productId","in":"query","required":false,"schema":{"type":"string"}},{"name":"documentId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listagem de Documentos Fiscais","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":2,"items":[{"document":{"id":"1234567","name":"Empresa Fictícia - 12345678901","status":"Pendente","type":"Alunos / Clientes","baseValue":{"currency":"BRL","value":100},"emissionDate":"2024-11-04T21:17:02.000Z","referenceDate":"2024-10-30T09:45:39.000Z","processingDate":"2024-12-04T21:17:02.000Z"},"source":{"taxType":null,"companyName":"Empresa Fictícia","document":"12345678000190","ie":"ISENTO","im":null,"email":"empresa@ficticia.com","tel":null,"tel2":"11987654321","cell":null,"address":{"street":"Rua Fictícia","number":"123","complement":"Sala 1","district":"Centro","zipCode":"12345678","city":"Cidade Fictícia","uf":"SP"}},"destination":{"companyName":"Cliente Fictício","taxType":"F","taxId":"12345678901","ie":"ISENTO","im":null,"email":"cliente@ficticio.com","tel":null,"tel2":null,"cell":"+5511998765432","address":{"street":"Rua 123","number":"2","complement":null,"district":null,"zipCode":"","countryForeign":null,"city":"São Paulo","uf":null,"country":null}},"sale":{"id":"7654321","paymentDate":"2024-10-30T09:45:39.000Z","total":{"currency":"BRL","value":100}},"client":{"id":"123456789","name":"Cliente Fictício","document":"12345678901","email":"cliente@ficticio.com","telephone":null,"telephone2":null,"cellphone":"+5511998765432","address":{"street":"Rua 123","number":"2","complement":null,"neighborhood":null,"zipCode":"","city":"São Paulo","state":null}},"product":{"id":"9876543","title":"Conteúdo Fictício"},"generatedByNewSystem":true},{"document":{"id":"7654321","name":"Outro Cliente - 10987654321","status":"Novo","type":"Alunos / Clientes","baseValue":{"currency":"BRL","value":200},"emissionDate":"2024-11-04T21:16:10.000Z","referenceDate":"2024-10-30T09:02:25.000Z","processingDate":"2024-12-04T21:16:10.000Z"},"source":{"taxType":null,"companyName":"Empresa Fictícia","document":"12345678000190","ie":"ISENTO","im":null,"email":"empresa@ficticia.com","tel":null,"tel2":"11987654321","cell":null,"address":{"street":"Rua Fictícia","number":"123","complement":"Sala 1","district":"Centro","zipCode":"12345678","city":"Cidade Fictícia","uf":"SP"}},"destination":{"companyName":"Outro Cliente","taxType":"F","taxId":"10987654321","ie":"ISENTO","im":null,"email":"outrocliente@ficticio.com","tel":null,"tel2":null,"cell":"+5511987654321","address":{"street":"Rua 123","number":"2","complement":null,"district":null,"zipCode":"","countryForeign":null,"city":"São Paulo","uf":null,"country":null}},"sale":{"id":"1234567","paymentDate":"2024-10-30T09:02:25.000Z","total":{"currency":"BRL","value":200}},"client":{"id":"987654321","name":"Outro Cliente","document":"10987654321","email":"outrocliente@ficticio.com","telephone":null,"telephone2":null,"cellphone":"+5511987654321","address":{"street":"Rua 123","number":"2","complement":null,"neighborhood":null,"zipCode":"","city":"São Paulo","state":null}},"product":{"id":"8765432","title":"Outro Conteúdo Fictício"},"generatedByNewSystem":true}]}}}}}}}}},"/myeduzz/v1/financial/transfers":{"get":{"operationId":"getmyeduzzv1financialtransfers","summary":"Obtém detalhes das transferências realizadas com base nos filtros fornecidos.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_financial_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Listagem de transferências","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"123456","value":{"currency":"BRL","value":1000},"requestedAt":"2021-01-02","completedAt":"2021-01-02","createdAt":"2021-01-01","status":"confirmed","details":"Transferência realizada com sucesso.","bankAccount":{"type":"checkingAccount","bankCode":"001","agency":"1234","account":"123456-0"}}]}}}}}}}}},"/myeduzz/v1/products/:id/campaigns":{"get":{"operationId":"getmyeduzzv1productsidcampaigns","summary":"Obtém as campanhas de um produto ","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_products_read"]}],"parameters":[{"name":"id","description":"Id do produto que se deseja obter as campanhas","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de campanhas do produto","content":{"application/json":{"examples":{"default":{"value":[{"id":"12345","key":"ABC123","title":"Campanha de Verão","url":"http://verao.promocoes.fake","resultPerClick":{"affiliate":2,"producer":5},"isInfinityFunnel":true,"isActive":true,"createdAt":"2022-01-15T12:34:56.789Z"},{"id":"67890","key":"XYZ789","title":"Promoção de Inverno","url":"http://inverno.promocoes.fake","resultPerClick":{"affiliate":3,"producer":7},"isInfinityFunnel":false,"isActive":false,"createdAt":"2021-11-30T08:45:12.345Z"},{"id":"54321","key":"QWE456","title":"Oferta de Primavera","url":"http://primavera.ofertas.fake","resultPerClick":{"affiliate":9,"producer":4},"isInfinityFunnel":true,"isActive":true,"createdAt":"2023-03-25T10:20:30.000Z"}]}}}}}}}},"/myeduzz/v1/products/coupons":{"get":{"operationId":"getmyeduzzv1productscoupons","summary":"Listagem de todos os cupons de produtos do produtor","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_products_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de produtos do produtor","content":{"application/json":{"examples":{"default":{"value":{"pages":821,"page":1,"itemsPerPage":3,"totalItems":2461,"items":[{"code":"CUPOM123","description":"Cupom simples","value":10,"type":"value","quantity":1000,"limitDate":"2029-03-20T16:24:47.180Z","products":[{"id":"1234","title":"Produto Simples 1","price":{"currency":"BRL","value":200},"priceWithDiscount":{"currency":"BRL","value":190},"link":"https://linkdevenda/produto?cupom=CUPOM123"}]},{"code":"CUPOM456","description":"Cupom complexo","value":10,"type":"percentage","quantity":1000,"limitDate":"2029-03-20T16:24:47.180Z","products":[{"id":"1234","title":"Produto Simples 1","price":{"currency":"BRL","value":200},"priceWithDiscount":{"currency":"BRL","value":180},"link":"https://linkdevenda/produto?cupom=CUPOM456"},{"id":"12345","title":"Produto Simples 2","price":{"currency":"BRL","value":500},"priceWithDiscount":{"currency":"BRL","value":450},"link":"https://linkdevenda/produto?cupom=CUPOM456"}]}]}}}}}}}}},"/myeduzz/v1/products/:id":{"get":{"operationId":"getmyeduzzv1productsid","summary":"Obtém os detalhes de um produto específico","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_products_read"]}],"parameters":[{"name":"id","description":"Id do produto que se deseja obter os detalhes","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes do produto solicitado","content":{"application/json":{"examples":{"default":{"value":{"id":"48045","name":"Produto Premium","description":"Produto premium com funcionalidades avançadas.","producerId":"1234","type":"digital","status":"active","author":"Eduzz","moderation":"new","imageUrl":"https://cdn.eduzzcdn.com/xpto.jpg","createdAt":"2018-03-20T19:57:44.357Z","updatedAt":"2023-05-15T18:46:44.647Z","payment":{"type":"oneTime","price":{"currency":"BRL","value":100},"methods":{"bankslip":true,"pix":true,"card":true,"multipleCards":false}}}}}}}}}}},"/myeduzz/v1/products":{"get":{"operationId":"getmyeduzzv1products","summary":"Listagem de todos os produtos do produtor","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_products_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de produtos do produtor","content":{"application/json":{"examples":{"default":{"value":{"pages":821,"page":1,"itemsPerPage":3,"totalItems":2461,"items":[{"id":"47998","name":"Produto Digital Básico","description":"Produto digital básico para teste e validação do sistema.","producerId":"1234","type":"digital","status":"active","author":"Eduzz","moderation":"pending","imageUrl":"https://cdn.eduzzcdn.com/xpto.jpg","createdAt":"2018-03-20T16:24:47.180Z","updatedAt":"2023-05-15T18:46:44.647Z","payment":{"type":"oneTime","price":{"currency":"BRL","value":1.1},"methods":{"bankslip":true,"pix":true,"card":true,"multipleCards":true}}},{"id":"48015","name":"Produto de Assinatura","description":"Produto de assinatura para teste e validação contínua.","producerId":"1234","type":"digital","status":"active","author":"Eduzz","moderation":"new","imageUrl":"https://cdn.eduzzcdn.com/xpto.jpg","createdAt":"2018-03-20T17:20:05.567Z","updatedAt":"2023-05-15T18:46:44.647Z","payment":{"type":"subscription","price":{"currency":"BRL","value":10},"methods":{"bankslip":true,"pix":true,"card":true,"multipleCards":true}}},{"id":"48045","name":"Produto Premium","description":"Produto premium com funcionalidades avançadas.","producerId":"1234","type":"physical","status":"inactive","author":"Eduzz","moderation":"approved","imageUrl":"https://cdn.eduzzcdn.com/xpto.jpg","createdAt":"2018-03-20T19:57:44.357Z","updatedAt":"2023-05-15T18:46:44.647Z","payment":{"type":"oneTime","price":{"currency":"BRL","value":100},"methods":{"bankslip":true,"pix":true,"card":true,"multipleCards":false}}}]}}}}}}}}},"/myeduzz/v1/products/:id/offers":{"get":{"operationId":"getmyeduzzv1productsidoffers","summary":"Obtém as ofertas de um produto","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_products_read"]}],"parameters":[{"name":"id","description":"Id do produto que se deseja obter as ofertas","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de ofertas do produto","content":{"application/json":{"examples":{"default":{"value":[{"id":"12345","isDefault":true,"name":"Oferta Base","isVisibleToAffiliates":false,"checkoutUrl":"https://chk.eduzz.com/6uiwvmo4","defaultPrice":{"currency":"BRL","value":1000},"prices":[{"currency":"BRL","value":1000},{"currency":"USD","value":100}]}]}}}}}}}},"/myeduzz/v1/products/:id/partners":{"get":{"operationId":"getmyeduzzv1productsidpartners","summary":"Obtém os parceiros de um produto","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_products_read"]}],"parameters":[{"name":"id","description":"Id do produto que se deseja obter os parceiros","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de parceiros do produtor","content":{"application/json":{"examples":{"default":{"value":[{"id":"1234","name":"Eduzz","email":"eduzz@eduzz.com","commission":{"type":"percentage","value":90,"onlyByAffiliate":false},"permission":{"canManageAffiliates":true,"canRefund":true,"canViewCustomerData":true}},{"id":"4321","name":"Parceiro Eduzz","email":"parceiro@eduzz.com","commission":{"type":"percentage","value":10,"onlyByAffiliate":false},"permission":{"canManageAffiliates":false,"canRefund":false,"canViewCustomerData":false}}]}}}}}}}},"/myeduzz/v1/sales/:id":{"get":{"operationId":"getmyeduzzv1salesid","summary":"Obtém detalhes de uma venda específica","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_sales_read"]}],"parameters":[{"name":"id","description":"Id da venda que se deseja obter os detalhes","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes da venda","content":{"application/json":{"examples":{"default":{"value":{"id":"123456","contractId":"78910","status":"paid","grossGain":{"currency":"BRL","value":1000},"netGain":{"currency":"BRL","value":900},"partnersGain":{"currency":"BRL","value":50},"affiliatesGain":{"currency":"BRL","value":50},"fee":{"currency":"BRL","value":10},"total":{"currency":"BRL","value":1000},"totalInterest":{"currency":"BRL","value":5},"installments":3,"alumyFee":{"currency":"BRL","value":5},"others":{"currency":"BRL","value":2},"currency":"BRL","locale":"pt-BR","dueDate":"2023-12-31T23:59:59Z","paidAt":"2023-01-01T12:00:00Z","creditDate":"2023-01-02T12:00:00Z","isInfiniteFunnel":false,"recoveringStatus":"inactive","tracker":"tracker1","tracker2":"tracker2","tracker3":"tracker3","createdAt":"2023-01-01T00:00:00Z","updatedAt":"2023-01-02T00:00:00Z","payment":{"method":"creditCard","detail":"visaCreditCard","link":"https://edz.la/123456/123456?t=x"},"product":{"id":"1","name":"Product Example 1","type":"digital","billingType":"single","sku":"5"},"refund":{"type":"common","value":{"currency":"BRL","value":100},"partialValue":{"currency":"BRL","value":50},"refundedAt":"2023-01-03T12:00:00Z","requestedAt":"2023-01-02T12:00:00Z","motive":"Não fiz essa compra.","requesterName":"Tio Patinhas"},"affiliate":{"id":123,"name":"Affiliate Example"},"recipient":{"id":"456","name":"Example Recipient","email":"examplerecipient@example.com","document":"12345678900","phone":"11999999999"},"buyer":{"id":"3","name":"Buyer Example","email":"buyer@example.com","document":"12345678900","phone":"11999999999","phone2":"11888888888","phone3":"11777777777","address":{"zipCode":"12345678","street":"Street Example","number":"123","complement":"number 101","neighborhood":"Neighborhood Example","city":"City Example","state":"SP"}},"producer":{"id":"2","name":"Producer Example"},"affiliates":[{"id":"4","name":"Affiliates 1","email":"affiliate1@example.com","netGain":{"currency":"BRL","value":50}}],"partners":[{"id":"6","name":"Partners 1","email":"partner@example.com","netGain":{"currency":"BRL","value":50}}],"items":[{"id":"7","productId":"1","description":"Item Example 7 ","unitValue":{"currency":"BRL","value":500},"quantity":2,"value":{"currency":"BRL","value":1000},"discount":{"currency":"BRL","value":50},"freightType":"normal","freightDeadline":"7 dias","trackingCode":"TRACK123"}],"offer":{"name":"Oferta Base"},"utm":{"source":"google","campaign":"campaing2023","medium":"cpc","content":"contect1","term":"term1"},"orderBump":{"has":true,"isMainSale":false,"mainSaleId":123456}}}}}}},"404":{"description":"Venda não encontrada","content":{"application/json":{"examples":{"default":{"value":{"message":"Sale not found."}}}}}}}}},"/myeduzz/v1/sales":{"get":{"operationId":"getmyeduzzv1sales","summary":"Obtém uma lista detalhada de vendas com base nos filtros fornecidos","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_sales_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"referenceDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"contractId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"productId","in":"query","required":false,"schema":{"type":"string"}},{"name":"affiliateId","in":"query","required":false,"schema":{"type":"string"}},{"name":"buyerEmail","in":"query","required":false,"schema":{"type":"string"}},{"name":"buyerDocument","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de vendas","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"123456","contractId":"78910","status":"paid","grossGain":{"currency":"BRL","value":1000},"netGain":{"currency":"BRL","value":900},"partnersGain":{"currency":"BRL","value":50},"affiliatesGain":{"currency":"BRL","value":50},"fee":{"currency":"BRL","value":10},"total":{"currency":"BRL","value":1000},"totalInterest":{"currency":"BRL","value":5},"installments":3,"alumyFee":{"currency":"BRL","value":5},"others":{"currency":"BRL","value":2},"currency":"BRL","locale":"pt-BR","dueDate":"2023-12-31T23:59:59Z","paidAt":"2023-01-01T12:00:00Z","creditDate":"2023-01-02T12:00:00Z","isInfiniteFunnel":false,"recoveringStatus":"inactive","tracker":"tracker1","tracker2":"tracker2","tracker3":"tracker3","createdAt":"2023-01-01T00:00:00Z","updatedAt":"2023-01-02T00:00:00Z","payment":{"method":"creditCard","detail":"visaCreditCard","link":"https://edz.la/123456/123456?t=x"},"product":{"id":"4","name":"Produto Exemplo","type":"digital","billingType":"single","sku":"5"},"refund":{"type":"common","value":{"currency":"BRL","value":100},"partialValue":{"currency":"BRL","value":50},"refundedAt":"2023-01-03T12:00:00Z"},"affiliate":{"id":"123","name":"Afiliado Exemplo"},"recipient":{"id":"456","name":"recipient Example","email":"recebedor@example.com","document":"12345678900","phone":"11999999999"},"buyer":{"id":"13","name":"Buyer Example","email":"buyer@example.com","document":"12345678900","phone":"11999999999"},"producer":{"id":"5","name":"Producer Name Example"},"offer":{"name":"Oferta Base"},"utm":{"source":"google","campaign":"campaing2023","medium":"cpc","content":"contect","term":"term"},"orderBump":{"has":true,"isMainSale":false,"mainSaleId":123456}}]}}}}}}}}},"/myeduzz/v1/sales/chargebacks":{"get":{"operationId":"getmyeduzzv1saleschargebacks","summary":"Obtém uma lista detalhada de chargebacks com base nos filtros fornecidos","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_sales_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"chargebackStatus","in":"query","required":false,"schema":{"type":"string"}},{"name":"buyerEmail","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de vendas","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"123456","total":{"currency":"BRL","value":1000},"chargeback":{"requestedAt":"2023-01-02T12:00:00.000Z","limitDate":"2023-01-04T12:00:00.000Z","documentsUploadedAt":"2023-01-03T12:00:00.000Z","status":"lost"},"affiliate":{"id":"123","name":"Afiliado Exemplo"},"product":{"id":"4","name":"Produto Exemplo","type":"digital","sku":"5"},"buyer":{"id":"13","name":"Buyer Example","email":"buyer@example.com","document":"12345678900","phone":"11999999999"}}]}}}}}}}}},"/myeduzz/v1/sales/summary":{"get":{"operationId":"getmyeduzzv1salessummary","summary":"Retorna um relatório sumarizado com o total realizado em vendas com base nos filtros fornecidos.","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_sales_read"]}],"parameters":[{"name":"startDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"}},{"name":"contractId","in":"query","required":false,"schema":{"type":"string"}},{"name":"productId","in":"query","required":false,"schema":{"type":"string"}},{"name":"affiliateId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Resumo das vendas","content":{"application/json":{"examples":{"default":{"value":{"discount":{"currency":"BRL","value":100},"grossGain":{"currency":"BRL","value":1000},"netGain":{"currency":"BRL","value":780},"partnersGain":{"currency":"BRL","value":50},"affiliatesGain":{"currency":"BRL","value":50},"fee":{"currency":"BRL","value":10},"others":{"currency":"BRL","value":10},"total":{"currency":"BRL","value":1000}}}}}}}}}},"/nutror/v1/comments/:id":{"patch":{"operationId":"patchnutrorv1commentsid","summary":"Altera estados do comentário.","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_write"]}],"parameters":[{"name":"id","description":"Id do comentário","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"isFixed":{"type":"boolean","example":"true"},"isApproved":{"type":"boolean","example":"false"},"isRead":{"type":"boolean","example":"true"},"isFavorite":{"type":"boolean","example":"false"}}}}}},"responses":{"204":{"description":"Comentário alterado com sucesso","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}},"get":{"operationId":"getnutrorv1commentsid","summary":"Busca por um comentário específico","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_read"]}],"parameters":[{"name":"id","description":"Id do comentário","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Dados do comentário","content":{"application/json":{"examples":{"default":{"value":{"id":12345,"type":"text","isRead":false,"author":"Carlos Eduardo","status":"inModeration","text":"Esse é um comentário","lessonId":54321,"createdAt":"2023-04-28T20:47:32Z","isFixed":false,"isFavorite":false,"isAnswered":true}}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}},"delete":{"operationId":"deletenutrorv1commentsid","summary":"Deletar um comentário","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_write"]}],"parameters":[{"name":"id","description":"Id do comentário","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Comentário excluído com sucesso","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}}},"/nutror/v1/answers/:id":{"delete":{"operationId":"deletenutrorv1answersid","summary":"Deletar uma resposta","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_write"]}],"parameters":[{"name":"id","description":"Id da resposta","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Exclusão de resposta","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Resposta não encontrada","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}}},"/nutror/v1/comments":{"get":{"operationId":"getnutrorv1comments","summary":"Lista comentários","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"courseId","in":"query","required":false,"schema":{"type":"string"}},{"name":"lessonId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"favorite","in":"query","required":false,"schema":{"type":"string"}},{"name":"answered","in":"query","required":false,"schema":{"type":"string"}},{"name":"read","in":"query","required":false,"schema":{"type":"string"}},{"name":"fixed","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de comentários","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":12345,"type":"text","isRead":false,"author":"Carlos Eduardo","status":"inModeration","text":"Esse é um comentário","lessonId":54321,"createdAt":"2023-04-28T20:47:32Z","isFixed":false,"isFavorite":false,"isAnswered":true}]}}}}}}}}},"/nutror/v1/comments/:id/answers":{"get":{"operationId":"getnutrorv1commentsidanswers","summary":"Lista respostas de comentário","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_read"]}],"parameters":[{"name":"id","description":"Id do comentário","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sem respostas","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":50,"totalItems":1,"items":[]}}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}},"post":{"operationId":"postnutrorv1commentsidanswers","summary":"Cria uma resposta para um comentário","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_comments_write"]}],"parameters":[{"name":"id","description":"Id do comentário","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"}}}}}},"responses":{"201":{"description":"Resposta ao comentário","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}}},"/nutror/v1/courses/:courseId":{"get":{"operationId":"getnutrorv1coursescourseId","summary":"Buscar por um curso em específico","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_read"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Dados do curso específico","content":{"application/json":{"examples":{"default":{"value":{"id":12351,"title":"Novo curso!","description":"Este é curso dedicado para especialistas","published":true,"replyEmail":"email-reply@gmail.com","daysAvailable":365,"allowManualWatch":false,"releaseDate":"2024-08-27","progressBar":true,"pixelFacebook":"123456789","pixelGoogleAnalytics":"UA-123456789","duration":2400,"type":1,"certificateProgress":100,"supportExternalUrl":"https://www.minha-pagina-de-ajuda.com","allowMultipleAccess":false,"secretaryStatus":true,"secretaryUrl":"https://www.example.com","customization":{"background":"https://www.minha-imagem.com/card.jpg","backgroundLight":"https://www.minha-imagem.com/card-light.jpg","modulesDefaultImage":"https://www.minha-imagem.com/module/image.jpg","lessonsDefaultImage":"https://www.minha-imagem.com/lesson/image.jpg"}}}}}}},"403":{"description":"Permissão negada","content":{"application/json":{"examples":{"default":{"value":{"message":"Este usuário não tem permissão","code":11}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"examples":{"default":{"value":{"message":"Dados não encontrados","code":2}}}}}}}},"delete":{"operationId":"deletenutrorv1coursescourseId","summary":"Deletar curso","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_write"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Exclusão feita com sucesso","content":{"application/json":{"examples":{"default":{"value":{"code":null,"message":"Curso deletado com sucesso"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}}}},"put":{"operationId":"putnutrorv1coursescourseId","summary":"Editar as informações básicas de um curso","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_write"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Curso de Nutrição"},"description":{"type":"string","example":"Curso de nutrição para iniciantes"},"authorId":{"type":"number","example":"1"},"published":{"type":"boolean","example":"true"}}}}}},"responses":{"200":{"description":"Curso atualizado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"code":null,"message":"Curso atualizado com sucesso"}}}}}},"400":{"description":"Erro de validação","content":{"application/json":{"examples":{"default":{"value":{"code":5,"message":"Um ou mais dos dados informados são inválidos"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}}}}},"/nutror/v1/courses/:courseId/modules/:moduleId":{"get":{"operationId":"getnutrorv1coursescourseIdmodulesmoduleId","summary":"Buscar por um módulo específico de um curso","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_read"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}},{"name":"moduleId","description":"Id do módulo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Dados do módulo","content":{"application/json":{"examples":{"default":{"value":{"id":12351,"courseId":"Novo curso!","title":"53bc09b45b1s","daysLocked":null,"isDraft":false,"availableDays":null,"releaseDate":"2024-10-15","sequence":0,"isFree":false,"createdAt":"2024-08-01 16:24:04.0000000","banner":"https://www.example.com/image.jpg"}}}}}},"403":{"description":"Permissão negada","content":{"application/json":{"examples":{"default":{"value":{"message":"Este usuário não tem permissão","code":11}}}}}},"404":{"description":"Curso ou módulo não encontrado","content":{"application/json":{"examples":{"default":{"value":{"message":"Dados não encontrados","code":2}}}}}}}},"delete":{"operationId":"deletenutrorv1coursescourseIdmodulesmoduleId","summary":"Deletar módulo","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_write"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}},{"name":"moduleId","description":"Id do módulo","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Exclusão feita com sucesso","content":{"application/json":{"examples":{"default":{"value":{"code":null,"message":"Módulo deletado com sucesso"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Módulo não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}},"500":{"description":"Erro ao deletar os dados","content":{"application/json":{"examples":{"default":{"value":{"code":33,"message":"Erro ao deletar os dados"}}}}}}}},"put":{"operationId":"putnutrorv1coursescourseIdmodulesmoduleId","summary":"Editar as informações de um módulo","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_write"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}},{"name":"moduleId","description":"Id do módulo","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","example":"Novo curso"},"daysLocked":{"type":"number","example":"14"},"isDraft":{"type":"boolean","example":"false"},"availableDays":{"type":"number","example":"30"},"releaseDate":{"type":"string","example":"2024-10-15"},"sequence":{"type":"number","example":"1"},"isFree":{"type":"boolean","example":"false"}}}}}},"responses":{"200":{"description":"Módulo atualizado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"code":null,"message":"Módulo atualizado com sucesso"}}}}}},"400":{"description":"Erro de validação ao atualizar os dados","content":{"application/json":{"examples":{"default":{"value":{"code":22,"message":"Erro ao atualizar os dados"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Dados não encontrados","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}}}}},"/nutror/v1/courses/:courseId/advanced":{"put":{"operationId":"putnutrorv1coursescourseIdadvanced","summary":"Editar as informações avançadas de um curso","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_write"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"daysAvailable":{"type":"number","example":"365"},"releaseDate":{"type":"string","example":"2024-08-27"},"progressBar":{"type":"boolean","example":"true"},"pixelFacebook":{"type":"string","example":"123456789"},"pixelGoogleAnalytics":{"type":"string","example":"UA-123456789"},"duration":{"type":"number","example":"2400"},"certificateProgress":{"type":"number","example":"100"},"supportExternalUrl":{"type":"string","example":"https://www.minha-pagina-de-ajuda.com"},"allowMultipleAccess":{"type":"boolean","example":"false"},"secretaryStatus":{"type":"boolean","example":"false"},"secretaryUrl":{"type":"string","example":"https://www.example.com"}}}}}},"responses":{"200":{"description":"Curso atualizado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"code":null,"message":"Curso atualizado com sucesso"}}}}}},"400":{"description":"Erro de validação","content":{"application/json":{"examples":{"default":{"value":{"code":5,"message":"Um ou mais dos dados informados são inválidos"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}}}}},"/nutror/v1/courses/:courseId/customization":{"put":{"operationId":"putnutrorv1coursescourseIdcustomization","summary":"Editar as informações de customização de um curso","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_write"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"lessonsDefaultImage":{"type":"string","example":"https://example.com/image.jpg"},"modulesDefaultImage":{"type":"string","example":"https://example.com/image.jpg"},"background":{"type":"string","example":"https://example.com/image.jpg"}}}}}},"responses":{"200":{"description":"Curso atualizado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"code":null,"message":"Curso atualizado com sucesso"}}}}}},"400":{"description":"Erro ao atualizar os dados do curso","content":{"application/json":{"examples":{"default":{"value":{"code":22,"message":"Erro ao atualizar os dados"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}}}}},"/nutror/v1/courses":{"get":{"operationId":"getnutrorv1courses","summary":"Listar todos cursos","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_read"]}],"parameters":[],"responses":{"200":{"description":"Lista de cursos","content":{"application/json":{"examples":{"default":{"value":{"id":12351,"title":"Novo curso!","hash":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9","createdAt":"2024-08-29T18:14:53Z","updatedAt":"2024-08-29T18:14:53Z","published":true,"myEduzzAssociation":{"contentId":"123548","title":"Produto 1"},"category":{"id":1,"name":"Empreendedorismo"}}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Dados não encontrados","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}}}}},"/nutror/v1/courses/:courseId/modules":{"get":{"operationId":"getnutrorv1coursescourseIdmodules","summary":"Listar todos módulos do curso","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_courses_read"]}],"parameters":[{"name":"courseId","description":"Id do curso","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de módulos do curso","content":{"application/json":{"examples":{"default":{"value":{"id":12351,"courseId":"Novo curso!","title":"53bc09b45b1s","daysLocked":null,"isDraft":false,"availableDays":null,"releaseDate":"2024-10-15","sequence":0,"isFree":false,"createdAt":"2024-08-29T18:14:53Z","banner":"https://www.example.com/image.jpg"}}}}}},"404":{"description":"Módulo não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}}}}},"/nutror/v1/enrollments/:id/block":{"put":{"operationId":"putnutrorv1enrollmentsidblock","summary":"Bloqueia o aluno","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_write"]}],"parameters":[{"name":"id","description":"Id da matrícula","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Aluno bloqueado com sucesso","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Matrícula não encontrada","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}},"411":{"description":"Sem permissão","content":{"application/json":{"examples":{"default":{"value":{"code":6,"message":"Você não tem permissão de acesso administrativo para realizar esta ação","errors":[]}}}}}}}}},"/nutror/v1/enrollments/:id/extend-access":{"put":{"operationId":"putnutrorv1enrollmentsidextendaccess","summary":"Estende o acesso do aluno","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_write"]}],"parameters":[{"name":"id","description":"Id da matrícula","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"expiredAt":{"type":"datetime","example":"2025-01-22"}}}}}},"responses":{"201":{"description":"Acesso extendido","content":{"application/json":{"examples":{"default":{}}}}},"400":{"description":"Dados incorretos","content":{"application/json":{"examples":{"default":{"value":{"code":"0010","message":"Código padrão para validação de input.","errors":[{"field":"expireAt","message":"The expire at field is required."}]}}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":12,"message":"Usuário não encontrado","errors":[]}}}}}},"409":{"description":"Sem permissão","content":{"application/json":{"examples":{"default":{"value":{"code":91,"message":"Não é possível completar a ação, pois a matrícula está bloqueada.","errors":[]}}}}}}}}},"/nutror/v1/students/:id":{"delete":{"operationId":"deletenutrorv1studentsid","summary":"Exclui o aluno especificado pelo id","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_write"]}],"parameters":[{"name":"id","description":"Id do aluno","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Aluno excluído com sucesso","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}}}},"get":{"operationId":"getnutrorv1studentsid","summary":"Perfil do aluno","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_read"]}],"parameters":[{"name":"id","description":"Id do aluno","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Perfil do aluno","content":{"application/json":{"examples":{"default":{"value":{"id":"9b71e95310b7464bb6ca910ab3036372","name":"Jão Carlos","email":"test@test.com","avatar":null}}}}}}}}},"/nutror/v1/enrollments/:id/release-modules":{"put":{"operationId":"putnutrorv1enrollmentsidreleasemodules","summary":"Libera os módulos do curso para o aluno matrículado","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_write"]}],"parameters":[{"name":"id","description":"Id da matrícula","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Módulos liberados com sucesso","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":12,"message":"Usuário não encontrado","errors":[]}}}}}},"409":{"description":"Matrícula bloqueada","content":{"application/json":{"examples":{"default":{"value":{"code":91,"message":"Não é possível completar a ação, pois a matrícula está bloqueada.","errors":[]}}}}}},"411":{"description":"Sem permissão","content":{"application/json":{"examples":{"default":{"value":{"code":6,"message":"Você não tem permissão de acesso administrativo para realizar esta ação","errors":[]}}}}}}}}},"/nutror/v1/students":{"get":{"operationId":"getnutrorv1students","summary":"Listar alunos","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_read"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}},{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de alunos","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":10,"totalItems":1,"items":[{"id":"9b71e95310b7464bb6ca910ab3036372","name":"João Carlos","email":"test@test.com","avatar":"https://www.example.com/avatar.jpg"},{"id":"124323123","name":"Maria Silva","email":"xpto@test.com","avatar":"https://www.example.com/avatar.jpg"}]}}}}}}}}},"/nutror/v1/students/:id/enrollments":{"get":{"operationId":"getnutrorv1studentsidenrollments","summary":"Lista matrículas do aluno","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_read"]}],"parameters":[{"name":"id","description":"Id do aluno","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"itemsPerPage","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sem matrículas","content":{"application/json":{"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":50,"totalItems":0,"items":[]}}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"examples":{"default":{"value":{"code":12,"message":"Usuário não encontrado","errors":[]}}}}}}}}},"/nutror/v1/enrollments/:id":{"delete":{"operationId":"deletenutrorv1enrollmentsid","summary":"Remover a matrícula do aluno","tags":["Nutror"],"security":[{"eduzz_auth":["nutror_my_students_write"]}],"parameters":[{"name":"id","description":"Id da matrícula","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Matrícula removida com sucesso","content":{"application/json":{"examples":{"default":{}}}}},"404":{"description":"Matrícula não encontrada","content":{"application/json":{"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}},"411":{"description":"Sem permissão","content":{"application/json":{"examples":{"default":{"value":{"code":6,"message":"Você não tem permissão de acesso administrativo para realizar esta ação","errors":[]}}}}}}}}},"/safevideo/v1/medias/:id/domains":{"put":{"operationId":"putsafevideov1mediasiddomains","summary":"Pode alterar os domínios permitidos da mídia","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_write"]}],"parameters":[{"name":"id","description":"Identificador da mídia","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"url","example":"https://eduzz.com"}}}}}}},"responses":{"201":{"description":"Domínios alterados com sucesso","content":{"application/json":{"examples":{"default":{"value":{"link":""}}}}}},"400":{"description":"Requisição Inválida","content":{"application/json":{"examples":{"default":{"value":{"status":400,"message":"Error: referrers must be an array"}}}}}},"401":{"description":"Não autorizado alterar dominios","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Não permitido alterar dominios","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Media not found"}}}}}}}},"delete":{"operationId":"deletesafevideov1mediasiddomains","summary":"Poder excluir os domínios da mídia","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_write"]}],"parameters":[{"name":"id","description":"Identificador da mídia","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Domínios removidos com sucesso","content":{"application/json":{"examples":{"default":{"value":{}}}}}},"401":{"description":"Não autorizado a excluir domínios da mídia","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para excluir domínios da mídia","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Media not found"}}}}}}}}},"/safevideo/v1/medias/:id":{"put":{"operationId":"putsafevideov1mediasid","summary":"Pode alterar o título ou descrição da mídia","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_write"]}],"parameters":[{"name":"id","description":"Identificador da mídia","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"204":{"description":"Mídia alterada com sucesso","content":{"application/json":{"examples":{"default":{"value":{}}}}}},"400":{"description":"Requisição Inválida","content":{"application/json":{"examples":{"default":{"value":{"status":400,"message":"Error: title must be a string"}}}}}},"401":{"description":"Não autorizado a alterar mídia","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para alterar mídia","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Media not found"}}}}}}}},"get":{"operationId":"getsafevideov1mediasid","summary":"Detalhes da mídia do produtor","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_read"]}],"parameters":[{"name":"id","description":"Identificador da mídia","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Detalhes da mídia do produtor","content":{"application/json":{"examples":{"default":{"value":[{"source":{"filename":"698dc19d489c4e4db73e28a713eab07b.mp4","size":9019048,"width":576,"height":1024},"id":"6695366e04f7a37bfd00a926","key":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","userId":"66954fbd04f7a37bfd00a928","userEmail":"user@eduzz.com","title":"Teste.mp4","filename":"698dc19d489c4e4db73e28a713eab07b.mp4","status":"encoded","duration":123,"order":1,"tags":[""],"storage":"r2","deletedAt":null,"encoded":[{"format":"hls","codec":"h264","size":123,"resolutions":[{"width":135,"height":240},{"width":202,"height":360},{"width":270,"height":480},{"width":405,"height":720}]}],"createdAt":"2024-03-15T16:55:17.410Z","updatedAt":"2024-07-11T01:59:32.802Z","description":"teste teste"}]}}}}},"401":{"description":"Não autorizado a mostrar detalhes da mídia","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para mostrar detalhes da mídia","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Media not found"}}}}}}}},"delete":{"operationId":"deletesafevideov1mediasid","summary":"Excluir mídia especifica por id","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_write"]}],"parameters":[{"name":"id","description":"Identificador da mídia","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Exclui uma mídia","content":{"application/json":{"examples":{"default":{"value":{}}}}}},"400":{"description":"Requisição Inválida","content":{"application/json":{"examples":{"default":{"value":{"status":400,"message":"Query Media Path Params Invalid"}}}}}},"401":{"description":"Não autorizado excluir mídia","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Não permitido excluir mídia","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Media not found"}}}}}}}}},"/safevideo/v1/medias/:id/embed":{"get":{"operationId":"getsafevideov1mediasidembed","summary":"Poder adicionar a mídia em sites externos com link de embed","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_read"]}],"parameters":[{"name":"id","description":"Identificador da mídia","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Link com embed para mídia","content":{"application/json":{"examples":{"default":{"value":{"link":""}}}}}},"401":{"description":"Não autorizado a listar link com embed","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para listar link com embed","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Media not found"}}}}}}}}},"/safevideo/v1/medias":{"get":{"operationId":"getsafevideov1medias","summary":"Listagem com as mídias do produtor","tags":["SafeVideo"],"security":[{"eduzz_auth":["safevideo_contents_read"]}],"parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"title","in":"query","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista de mídias","content":{"application/json":{"examples":{"default":{"value":[{"id":"6695366e04f7a37bfd00a926","key":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","title":"Teste.mp4","status":"encoded","duration":123,"createdAt":"2024-05-21T00:30:33.645Z","updatedAt":"2024-05-21T00:57:59.498Z","thumbnail":"https://domain/thumbs/b0b40529-e25d-4496-9ffc-bf54be9dcfd6.jpg"}]}}}}},"401":{"description":"Não autorizado a listar mídias","content":{"application/json":{"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para listar mídias","content":{"application/json":{"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"examples":{"default":{"value":{"status":404,"message":"Medias not found"}}}}}}}}},"/webhook/v1/subscription/:subscriptionId":{"put":{"operationId":"putwebhookv1subscriptionsubscriptionId","summary":"Alterar uma configuração (url que receberá os eventos) de webhook","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_write"]}],"parameters":[{"name":"subscriptionId","description":"Id da configuração","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Aluno assistiu Aula"},"url":{"type":"string","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"nutror.lesson_watched"}}}},"filters":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"string","example":"productId"},"values":{"type":"array","items":{"type":"string","example":"123456"}}}}}}}}}},"responses":{"200":{"description":"Configuração de WebHook alterada com sucesso","content":{"application/json":{"examples":{"default":{"value":{"name":"Test for Doc","url":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","secretId":"87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180","events":[{"name":"nutror.lesson_watched"}],"status":"disabled","id":"yaeung4oaxt25pi0bzzycoezf"}}}}}}}}},"/webhook/v1/subscription":{"post":{"operationId":"postwebhookv1subscription","summary":"Criar uma configuração (url que receberá os eventos) de webhook","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_write"]}],"parameters":[],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Aluno assistiu Aula"},"url":{"type":"string","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"nutror.lesson_watched"}}}},"filters":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"string","example":"productId"},"values":{"type":"array","items":{"type":"string","example":"123456"}}}}}}}}}},"responses":{"200":{"description":"Configuração de WebHook criada com sucesso","content":{"application/json":{"examples":{"default":{"value":{"name":"Test for Doc","url":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","secretId":"87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180","events":[{"name":"nutror.lesson_watched"}],"status":"disabled","id":"yaeung4oaxt25pi0bzzycoezf"}}}}}}}},"delete":{"operationId":"deletewebhookv1subscription","summary":"Deleta uma inscrição de WebHook por URL","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_write"]}],"parameters":[],"responses":{"204":{"description":"Exclusão feita com sucesso","content":{"application/json":{"examples":{"default":{}}}}}}},"get":{"operationId":"getwebhookv1subscription","summary":"Lista Inscrições de Webhook","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_read"]}],"parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lista inscrições com sucesso","content":{"application/json":{"examples":{"default":{"value":[{"id":"yaeung4oaxt25pi0bzzycoezf","secretId":"87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180","name":"Aluno Assistiu a Aula","status":"active","url":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","events":["nutror.lesson_watched"]}]}}}}}}}},"/webhook/v1/subscription/:id":{"delete":{"operationId":"deletewebhookv1subscriptionid","summary":"Deleta uma inscrição de WebHook por ID","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_write"]}],"parameters":[{"name":"id","description":"Id do evento","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Exclusão feita com sucesso","content":{"application/json":{"examples":{"default":{}}}}}}}},"/webhook/v1/subscription/:id/status":{"post":{"operationId":"postwebhookv1subscriptionidstatus","summary":"Habilita ou desabilita uma inscrição de webhook","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_write"]}],"parameters":[{"name":"id","description":"Id do evento","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"active"}}}}}},"responses":{"200":{"description":"Webhook alterado com sucesso","content":{"application/json":{"examples":{"default":{"value":{"name":"Inscrição de webhook alterada","url":"https://webhook.site/3559d85c-4c65-4035-854b-e935ef9c1278","secretId":"lw4nb4ghqox1k7cr05732cors","events":[{"name":"test.event_one","conditions":[]}],"status":"disabled","id":"d01dgcs80wsjm8z9n67csd55o"}}}}}}}}},"/webhook/v1/subscription/sample":{"post":{"operationId":"postwebhookv1subscriptionsample","summary":"Requisita o envio do teste de um WebHook","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_read"]}],"parameters":[],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"subscriptionId":{"type":"string","example":"gklzq82g9l0daazesebit6hds"},"event":{"type":"string","example":"test.event_one"}}}}}},"responses":{"200":{"description":"Teste de webhook recebido com sucesso","content":{"application/json":{"examples":{"default":{"value":{"statusCode":200,"body":"{\"message\":\"Workflow was started\"}","timeTaken":322}}}}}},"404":{"description":"Falha ao receber webhook teste","content":{"application/json":{"examples":{"default":{"value":{"statusCode":404,"body":"{\"success\":false,\"error\":{\"message\":\"Token not found\",\"id\":null}}","timeTaken":356}}}}}}}}},"/webhook/v1/origin/sample/:event":{"get":{"operationId":"getwebhookv1originsampleevent","summary":"Lista de exemplos dos eventos de webhooks disponíveis em cada origem","tags":["Webhook"],"security":[{"eduzz_auth":[]}],"parameters":[{"name":"event","description":"Identificador do evento","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Exemplo do evento buscado","content":{"application/json":{"examples":{"default":{"value":{"id":"hus5jx72ktelexgvl79iojuoe","event":"nutror.lesson_watched","data":{"producer":{"email":"fulano@eduzz.com","name":"Fulano da Silva"},"learner":{"email":"learner@eduzz.com","name":"Ciclano da Silva"},"createdAt":"2023-09-25T19:18:29Z","course":{"hash":"4bba1d18c02755a13ee97521ae61958c3cf9e665","title":"Título do Curso"},"lesson":{"id":"3866","title":"Título da Aula"}},"sentDate":"2024-04-22T18:51:09.246Z"}}}}}}}}},"/webhook/v1/origin":{"get":{"operationId":"getwebhookv1origin","summary":"Listar origens de webhook","tags":["Webhook"],"security":[{"eduzz_auth":[]}],"parameters":[],"responses":{"200":{"description":"Lista de origens de webhooks","content":{"application/json":{"examples":{"default":{"value":[{"id":"guab3fmaixba8twqr7mrezg6u","name":"Nutror","prefix":"nutror","events":[{"name":"nutror.lesson_rated","metadata":["producerId","learnerEmail","lessonId","courseId"],"description":"Aluno avaliou uma aula"},{"name":"nutror.lesson_watched","metadata":["producerId","learnerEmail","lessonId","courseId"],"description":"Aluno terminou uma aula"}]},{"id":"p3lxcu1yfbtzh7qsa8bbwrn9q","name":"Blinket","prefix":"blinket","events":[{"name":"blinket.attendance_added","metadata":["eventId","email","name","batchId"],"description":"Novo Participante"},{"name":"blinket.attendance_assigned","metadata":["eventId","name","email"],"description":"Ingresso atribuído"}]}]}}}}}}}},"/webhook/v1/secret":{"get":{"operationId":"getwebhookv1secret","summary":"Retorna a secret de validação de webhooks criados pelo App","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_read"]}],"parameters":[],"responses":{"200":{"description":"Dados da secret","content":{"application/json":{"examples":{"default":{"value":{"id":"o01re8ty3kanab3ufi5ref0s3","name":"APP: 5accd2e8-869f-41d2-ae0d-3e314236f395","appId":"5accd2e8-869f-41d2-ae0d-3e314236f395","secret":"edzwgd_T9fKNbk0MG6jNRFUcyIcjknSCd6K0M7Z4xbojWnoj8xPQeWKuX","default":false}}}}}}}}}},"components":{"securitySchemes":{"eduzz_auth":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.eduzz.com/oauth/authorize","scopes":{}}}}}}}