Texto do comentário
","example":"Texto do comentário
"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação do comentário","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"},"member":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do membro","sample":"Membro 1","example":"Membro 1"}},"required":["id","name"],"additionalProperties":false,"description":"Membro que fez o comentário"}},"required":["id","text","createdAt","member"],"additionalProperties":false,"description":"Detalhes dos comentários"},"description":"Comentários associados ao post"},"replies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id da resposta","sample":"4329","example":"4329"},"text":{"type":"string","description":"Texto da resposta","sample":"Texto da resposta
","example":"Texto da resposta
"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da resposta","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"},"member":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do membro","sample":"Membro 1","example":"Membro 1"}},"required":["id","name"],"additionalProperties":false,"description":"Membro que fez a resposta"}},"required":["id","text","createdAt","member"],"additionalProperties":false,"description":"Detalhes das respostas"},"description":"Respostas associadas ao post"}},"required":["id","title","createdAt","member","comments","replies"],"additionalProperties":false},"examples":{"default":{"value":{"id":1,"title":"Post 1","createdAt":"2024-10-21T18:02:22.000Z","member":{"id":1,"name":"Membro 1"},"comments":[{"id":1,"text":"Comentário 1","createdAt":"2024-10-21T18:02:22.000Z","member":{"id":1,"name":"Membro 1"}}],"replies":[{"id":1,"text":"Resposta 1","createdAt":"2024-10-21T18:02:22.000Z","member":{"id":1,"name":"Membro 1"}}]}}}}}}}}},"/heycamp/v1/invitations":{"post":{"operationId":"postheycampv1invitations","summary":"Cria o convite","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_write_invitations"]}],"parameters":[],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"communityId":{"type":"number","description":"Id da comunidade","sample":"1030","example":"1030"},"spaceId":{"type":"number","description":"Id do espaço associado à comunidade","sample":"18952","example":"18952"},"email":{"type":"string","description":"E-mail do usuário que será convidado","sample":"futuro.membro@test.com","example":"futuro.membro@test.com"}},"required":["communityId","spaceId","email"],"additionalProperties":false}}}},"responses":{"201":{"description":"Convite criado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do convite","sample":"4273","example":"4273"},"invitationUrl":{"type":"string","format":"uri","description":"Url do convite","sample":"http://teste/invitations/152d64c3-68cb-439e-bd07-840c341e928d","example":"http://teste/invitations/152d64c3-68cb-439e-bd07-840c341e928d"}},"required":["id","invitationUrl"],"additionalProperties":false},"examples":{"default":{"value":{"invitations":[{"id":4273,"invitationUrl":"http://teste.localhost/invitations/152d64c3-68cb-439e-bd07-840c341e928d"}]}}}}}}}}},"/heycamp/v1/invitations/:communityId":{"get":{"operationId":"getheycampv1invitationscommunityId","summary":"Listar convites","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_invitations"]}],"parameters":[{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja pesquisar por membros associados","schema":{"type":"string","description":"Id da comunidade que você deseja pesquisar por membros associados","sample":"3040","example":"3040"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"status","in":"query","required":true,"description":"Filtrar por status do convite","schema":{"type":"string","enum":["accepted","pending"],"enumDescriptions":{"accepted":"Convite aceito","pending":"Convite pendente"},"description":"Filtrar por status do convite"}}],"responses":{"200":{"description":"Lista de convites enviados","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do convite","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro convidado","sample":"test@test.com","example":"test@test.com"},"invitedBy":{"type":"number","description":"Id do responsável pelo convite","sample":"4329","example":"4329"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação/envio do convite","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"},"redeemedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data em que o convite foi aceito","sample":"2024-10-21T18:03:51.000Z","example":"2024-10-21T18:03:51.000Z"},"invitationUrl":{"type":"string","format":"uri","description":"Link do convite enviado","sample":"https://[domain]/invitations/[member-token]","example":"https://[domain]/invitations/[member-token]"}},"required":["id","email","invitedBy","createdAt","redeemedAt","invitationUrl"],"additionalProperties":false,"description":"Detalhes do convite"},"description":"Convites associados à comunidade"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"page":1,"pages":10,"itemsPerPage":2,"totalItems":30,"items":[{"id":4239,"email":"teste@test.com","invitedBy":3949,"createdAt":"2024-10-21T18:02:22.000Z","redeemedAt":"2024-10-21T18:03:51.000Z","invitationUrl":"https://[domain]/invitations/[member-token]"},{"id":4240,"email":"teste2@test.com","invitedBy":3949,"createdAt":"2024-10-21T22:29:32.000Z","redeemedAt":"2024-10-21T22:40:42.000Z","invitationUrl":"https://[domain]/invitations/[member-token]"}]}}}}}}}}},"/heycamp/v1/spaces/community/:communityId":{"get":{"operationId":"getheycampv1spacescommunitycommunityId","summary":"Listar espaços","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_spaces"]}],"parameters":[{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja pesquisar os espaços associados","schema":{"type":"string","description":"Id da comunidade que você deseja pesquisar os espaços associados","sample":"3040","example":"3040"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}}],"responses":{"200":{"description":"Lista de espaços","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do espaço","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do espaço associado a comunidade","sample":"Espaço","example":"Espaço"},"private":{"type":"boolean","description":"Informa se o espaço é público ou privado","sample":"true","example":"true"}},"required":["id","name","private"],"additionalProperties":false,"description":"Espaço associado a comunidade"},"description":"Espaços associados a comunidade"}},"required":["page","pages","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"page":1,"pages":2,"itemsPerPage":1,"totalItems":2,"items":[{"id":1234,"name":"Espaço","private":false},{"id":1020,"name":"Espaço NOVO","private":true}]}}}}}}}}},"/heycamp/v1/members/:memberId":{"put":{"operationId":"putheycampv1membersmemberId","summary":"Atualiza dados do membro","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_write_members"]}],"parameters":[{"name":"memberId","in":"path","required":true,"description":"ID do membro sobre o qual você deseja atualizar informações","schema":{"type":"string","description":"ID do membro sobre o qual você deseja atualizar informações","sample":"1030","example":"1030"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"E-mail do usuário que será convidado","sample":"futuro.membro@test.com","example":"futuro.membro@test.com"},"socialMedias":{"type":"object","properties":{"instagram":{"type":"string","format":"uri","description":"Url do instagram do membro","sample":"https://www.instagram.com/[PERFIL DO MEMBRO]","example":"https://www.instagram.com/[PERFIL DO MEMBRO]"},"facebook":{"type":"string","format":"uri","description":"Url do facebook do membro","sample":"https://www.facebook.com/[PERFIL DO MEMBRO]","example":"https://www.facebook.com/[PERFIL DO MEMBRO]"},"linkedin":{"type":"string","format":"uri","description":"Url do linkedin do membro","sample":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]","example":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]"},"x":{"type":"string","format":"uri","description":"Url do x(twitter) do membro","sample":"https://x.com/[PERFIL DO MEMBRO]","example":"https://x.com/[PERFIL DO MEMBRO]"}},"required":["instagram","facebook","linkedin","x"],"additionalProperties":false,"description":"Data de criação/aceite do convite"}},"required":["email","socialMedias"],"additionalProperties":false}}}},"responses":{"200":{"description":"Membro atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email do membro","sample":"test@test.com","example":"test@test.com"},"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do membro","sample":"Usuario de teste","example":"Usuario de teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação/aceite do convite","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"},"origin":{"type":"string","description":"Esta é a fonte de onde o usuário recebeu o convite","sample":"invitation","example":"invitation"},"referrerUrl":{"type":"string","format":"uri","description":"Esta é a url do SSO associado ao usuario","sample":"https://www.domains.com/SSO/","example":"https://www.domains.com/SSO/"},"socialMedias":{"type":"object","properties":{"instagram":{"type":"string","format":"uri","description":"Url do instagram do membro","sample":"https://www.instagram.com/[PERFIL DO MEMBRO]","example":"https://www.instagram.com/[PERFIL DO MEMBRO]"},"facebook":{"type":"string","format":"uri","description":"Url do facebook do membro","sample":"https://www.facebook.com/[PERFIL DO MEMBRO]","example":"https://www.facebook.com/[PERFIL DO MEMBRO]"},"linkedin":{"type":"string","format":"uri","description":"Url do linkedin do membro","sample":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]","example":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]"},"x":{"type":"string","format":"uri","description":"Url do x(twitter) do membro","sample":"https://x.com/[PERFIL DO MEMBRO]","example":"https://x.com/[PERFIL DO MEMBRO]"}},"required":["instagram","facebook","linkedin","x"],"additionalProperties":false,"description":"Data de criação/aceite do convite"}},"required":["email","id","name","createdAt","origin","referrerUrl","socialMedias"],"additionalProperties":false},"examples":{"default":{"value":{"id":3843,"email":"teste@test.com","name":"Teste","createdAt":"2024-10-21T17:10:54.000Z","origin":"invitations","referrerUrl":"https://www.domains.com/SSO/","socialMedias":{"instagram":"https://www.instagram.com/[PERFIL DO MEMBRO]","facebook":"https://www.facebook.com/[PERFIL DO MEMBRO]","linkedin":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]","x":"https://x.com/[PERFIL DO MEMBRO]"}}}}}}}}}},"/heycamp/v1/members/:memberId/community/:communityId":{"delete":{"operationId":"deleteheycampv1membersmemberIdcommunitycommunityId","summary":"Excluir membro específico de uma comunidade","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_write_members"]}],"parameters":[{"name":"memberId","in":"path","required":true,"description":"Id do membro","schema":{"type":"string","description":"Id do membro","sample":"1030","example":"1030"}},{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja excluir o membro associado","schema":{"type":"string","description":"Id da comunidade que você deseja excluir o membro associado","sample":"3040","example":"3040"}}],"responses":{"200":{"description":"Membro excluído com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem de confirmação de exclusão de membro","sample":"Member was deleted","example":"Member was deleted"}},"required":["message"],"additionalProperties":false},"examples":{"default":{"value":{"message":"Member was deleted"}}}}}}}},"get":{"operationId":"getheycampv1membersmemberIdcommunitycommunityId","summary":"Listar detalhes do membro associado à comunidade","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_members"]}],"parameters":[{"name":"memberId","in":"path","required":true,"description":"Id do membro sobre o qual você deseja pesquisar informações","schema":{"type":"string","description":"Id do membro sobre o qual você deseja pesquisar informações","sample":"1030","example":"1030"}},{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja pesquisar por membro associado","schema":{"type":"string","description":"Id da comunidade que você deseja pesquisar por membro associado","sample":"3040","example":"3040"}}],"responses":{"200":{"description":"Lista de membros associados à comunidade","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro","sample":"test@test.com","example":"test@test.com"},"name":{"type":"number","description":"Nome do membro","sample":"Usuario de teste","example":"Usuario de teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação/aceite do convite","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"}},"required":["id","email","name","createdAt"],"additionalProperties":false},"examples":{"default":{"value":{"id":3844,"email":"teste2@test.com","name":"Teste 2","createdAt":"2024-10-21T17:10:54.000Z"}}}}}}}}},"/heycamp/v1/members/bulk":{"delete":{"operationId":"deleteheycampv1membersbulk","summary":"Executa exclusão em massa de membros","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_write_members"]}],"parameters":[],"responses":{"200":{"description":"Membros excluídos com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem de confirmação de exclusão de membro","sample":"The member deletion process has been initiated, you will be notified by email","example":"The member deletion process has been initiated, you will be notified by email"}},"required":["message"],"additionalProperties":false},"examples":{"default":{"value":{"message":"The member deletion process has been initiated, you will be notified by email"}}}}}}}}},"/heycamp/v1/members/community/:communityId":{"get":{"operationId":"getheycampv1memberscommunitycommunityId","summary":"Listar os membros associados à comunidade","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_members"]}],"parameters":[{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja pesquisar por membros associados","schema":{"type":"string","description":"Id da comunidade que você deseja pesquisar por membros associados","sample":"3040","example":"3040"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data usada para definir o inicio do filtro com base na data de criação","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data usada para definir o inicio do filtro com base na data de criação"}},{"name":"endDate","in":"query","required":true,"description":"Data usada para definir o final do filtro com base na data de criação","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data usada para definir o final do filtro com base na data de criação"}},{"name":"status","in":"query","required":true,"description":"Status do membro","schema":{"type":"string","enum":["active","deleted"],"enumDescriptions":{"active":"Membro ativo","deleted":"Membro deletado"},"description":"Status do membro"}}],"responses":{"200":{"description":"Lista de membros associados","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro","sample":"test@test.com","example":"test@test.com"},"name":{"type":"string","description":"Nome do membro","sample":"Usuario de teste","example":"Usuario de teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação/aceite do convite","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"},"deletedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de exclusão do membro","sample":"2024-10-21T18:02:22.000Z","example":"2024-10-21T18:02:22.000Z"},"origin":{"type":"string","description":"Esta é a fonte de onde o usuário recebeu o convite","sample":"invitation","example":"invitation"},"referrerUrl":{"type":"string","format":"uri","description":"Esta é a url do SSO associado ao usuario","sample":"https://www.domains.com/SSO/","example":"https://www.domains.com/SSO/"},"socialMedias":{"type":"object","properties":{"instagram":{"type":"string","format":"uri","description":"Url do instagram do membro","sample":"https://www.instagram.com/[PERFIL DO MEMBRO]","example":"https://www.instagram.com/[PERFIL DO MEMBRO]"},"facebook":{"type":"string","format":"uri","description":"Url do facebook do membro","sample":"https://www.facebook.com/[PERFIL DO MEMBRO]","example":"https://www.facebook.com/[PERFIL DO MEMBRO]"},"linkedin":{"type":"string","format":"uri","description":"Url do linkedin do membro","sample":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]","example":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]"},"x":{"type":"string","format":"uri","description":"Url do x(twitter) do membro","sample":"https://x.com/[PERFIL DO MEMBRO]","example":"https://x.com/[PERFIL DO MEMBRO]"}},"required":["instagram","facebook","linkedin","x"],"additionalProperties":false,"description":"Lista com links das mídias sociais do membro"}},"required":["id","email","name","createdAt","deletedAt","origin","referrerUrl","socialMedias"],"additionalProperties":false,"description":"Membro"},"description":"Membros"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"page":1,"pages":2,"itemsPerPage":2,"totalItems":4,"items":[{"id":3843,"email":"teste@test.com","name":"Teste","createdAt":"2024-10-21T17:10:54.000Z","deletedAt":null,"origin":"invitations","referrerUrl":"https://www.domains.com/SSO/","socialMedias":{"instagram":"https://www.instagram.com/[PERFIL DO MEMBRO]","facebook":"https://www.facebook.com/[PERFIL DO MEMBRO]","linkedin":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]","x":"https://x.com/[PERFIL DO MEMBRO]"}},{"id":3844,"email":"teste2@test.com","name":"Teste 2","createdAt":"2024-10-21T17:10:54.000Z","deletedAt":null,"origin":"invitations","referrerUrl":"https://www.domains.com/SSO/","socialMedias":{"instagram":"https://www.instagram.com/[PERFIL DO MEMBRO]","facebook":"https://www.facebook.com/[PERFIL DO MEMBRO]","linkedin":"https://www.linkedin.com/in/[PERFIL DO MEMBRO]","x":"https://x.com/[PERFIL DO MEMBRO]"}}]}}}}}}}}},"/heycamp/v1/members/community/:communityId/comments":{"get":{"operationId":"getheycampv1memberscommunitycommunityIdcomments","summary":"Listar todos membros que comentaram em alguma publicação em um determinado período","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_members"]}],"parameters":[{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja pesquisar por membros associados","schema":{"type":"string","description":"Id da comunidade que você deseja pesquisar por membros associados","sample":"3040","example":"3040"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"days","in":"query","required":true,"description":"Quantidade de dias para busca por membros que fizeram comentários","schema":{"type":"number","description":"Quantidade de dias para busca por membros que fizeram comentários"}}],"responses":{"200":{"description":"Lista de membros que comentaram","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"10","example":"10"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do membro","sample":"Usuario de teste","example":"Usuario de teste"},"email":{"type":"string","description":"Email do membro","sample":"test@test.com","example":"test@test.com"},"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do post","sample":"4329","example":"4329"},"title":{"type":"string","description":"Título do post","sample":"Titulo do post","example":"Titulo do post"}},"required":["id","title"],"additionalProperties":false,"description":"Post"},"description":"Posts"}},"required":["id","name","email","posts"],"additionalProperties":false,"description":"Membro"},"description":"Membros"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":2,"totalItems":2,"items":[{"id":3843,"name":"Teste","email":"teste@test.com","posts":[{"id":3843,"title":"Post 1"}]},{"id":3844,"name":"Teste 2","email":"teste2@test.com","posts":[{"id":3844,"title":"Post 2"},{"id":3845,"title":"Post 3"}]}]}}}}}}}}},"/heycamp/v1/members/community/:communityId/likes":{"get":{"operationId":"getheycampv1memberscommunitycommunityIdlikes","summary":"Listar todos membros que curtiram alguma publicação em um determinado período","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_members"]}],"parameters":[{"name":"communityId","in":"path","required":true,"description":"Id da comunidade que você deseja pesquisar por membros associados","schema":{"type":"string","description":"Id da comunidade que você deseja pesquisar por membros associados","sample":"3040","example":"3040"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"days","in":"query","required":true,"description":"Quantidade de dias para busca por membros que curtiram alguma publicação","schema":{"type":"number","description":"Quantidade de dias para busca por membros que curtiram alguma publicação"}}],"responses":{"200":{"description":"Lista de membros que curtiram","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"10","example":"10"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do membro","sample":"Usuario de teste","example":"Usuario de teste"},"email":{"type":"string","description":"Email do membro","sample":"test@test.com","example":"test@test.com"},"posts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do post","sample":"4329","example":"4329"},"title":{"type":"string","description":"Título do post","sample":"Titulo do post","example":"Titulo do post"}},"required":["id","title"],"additionalProperties":false,"description":"Post"},"description":"Posts"}},"required":["id","name","email","posts"],"additionalProperties":false,"description":"Membro"},"description":"Membros"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":2,"totalItems":2,"items":[{"id":3843,"name":"Teste","email":"teste@test.com","posts":[{"id":3843,"title":"Post 1"}]},{"id":3844,"name":"Teste 2","email":"teste2@test.com","posts":[{"id":3844,"title":"Post 2"},{"id":3845,"title":"Post 3"}]}]}}}}}}}}},"/heycamp/v1/posts/:postId/community/:communityId":{"get":{"operationId":"getheycampv1postspostIdcommunitycommunityId","summary":"Buscar post de uma comunidade","tags":["HeyCamp"],"security":[{"eduzz_auth":["heycamp_read_posts"]}],"parameters":[{"name":"communityId","in":"path","required":true,"description":"Id da comunidade onde o post está associado","schema":{"type":"string","description":"Id da comunidade onde o post está associado","sample":"3040","example":"3040"}},{"name":"postId","in":"path","required":true,"description":"Id do post","schema":{"type":"string","description":"Id do post","sample":"1598","example":"1598"}}],"responses":{"200":{"description":"Buscar post","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do post","sample":"1598","example":"1598"},"title":{"type":"string","description":"Título do post","sample":"Espaço","example":"Espaço"},"content":{"type":"string","description":"Conteúdo do post","sample":"olá mundo!
","example":"olá mundo!
"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"totalComments":{"type":"number","description":"Total de comentários","sample":"1","example":"1"},"totalLikes":{"type":"number","description":"Total de likes","sample":"1","example":"1"},"member":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro","sample":"teste@example.com","example":"teste@example.com"}},"required":["id","email"],"additionalProperties":false,"description":"Informações do membro que criou o post"},"space":{"type":"object","properties":{"id":{"type":"number","description":"Id do espaço","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do espaço","sample":"Espaço 1","example":"Espaço 1"}},"required":["id","name"],"additionalProperties":false,"description":"Informações do espaço associado ao post"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Tags associadas ao post"}},"required":["id","title","content","createdAt","updatedAt","totalComments","totalLikes","member","space","tags"],"additionalProperties":false},"examples":{"default":{"value":[{"id":1598,"title":"Post 1","content":"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","in":"path","required":true,"description":"Id da comunidade onde os posts estão associados","schema":{"type":"string","description":"Id da comunidade onde os posts estão associados","sample":"3040","example":"3040"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}}],"responses":{"200":{"description":"Listar posts associados à comunidade","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do post","sample":"1598","example":"1598"},"title":{"type":"string","description":"Título do post","sample":"Espaço","example":"Espaço"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"totalComments":{"type":"number","description":"Total de comentários","sample":"1","example":"1"},"totalLikes":{"type":"number","description":"Total de likes","sample":"1","example":"1"},"member":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro","sample":"teste@example.com","example":"teste@example.com"}},"required":["id","email"],"additionalProperties":false,"description":"Informações do membro que criou o post"},"space":{"type":"object","properties":{"id":{"type":"number","description":"Id do espaço","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do espaço","sample":"Espaço 1","example":"Espaço 1"}},"required":["id","name"],"additionalProperties":false,"description":"Informações do espaço associado ao post"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Tags associadas ao post"}},"required":["id","title","createdAt","updatedAt","totalComments","totalLikes","member","space","tags"],"additionalProperties":false,"description":"Detalhes do post"},"description":"Lista de posts"}},"required":["page","pages","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da comunidade onde os posts estão associados","schema":{"type":"string","description":"Id da comunidade onde os posts estão associados","sample":"3040","example":"3040"}},{"name":"days","in":"query","required":true,"description":"Número de dias para buscar os posts mais comentados","schema":{"type":"number","description":"Número de dias para buscar os posts mais comentados"}}],"responses":{"200":{"description":"Listar posts associados à comunidade","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do post","sample":"1598","example":"1598"},"title":{"type":"string","description":"Nome do post","sample":"Espaço","example":"Espaço"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"totalComments":{"type":"number","description":"Total de comentários","sample":"1","example":"1"},"totalLikes":{"type":"number","description":"Total de likes","sample":"1","example":"1"},"member":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro","sample":"teste@example.com","example":"teste@example.com"}},"required":["id","email"],"additionalProperties":false,"description":"Informações do membro que criou o post"},"space":{"type":"object","properties":{"id":{"type":"number","description":"Id do espaço","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do espaço","sample":"Espaço 1","example":"Espaço 1"}},"required":["id","name"],"additionalProperties":false,"description":"Informações do espaço associado ao post"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Tags associadas ao post"}},"required":["id","title","createdAt","updatedAt","totalComments","totalLikes","member","space","tags"],"additionalProperties":false,"description":"Detalhes do post"},"description":"Lista de posts"}},"required":["items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da comunidade onde os posts estão associados","schema":{"type":"string","description":"Id da comunidade onde os posts estão associados","sample":"3040","example":"3040"}},{"name":"days","in":"query","required":true,"description":"Número de dias para buscar os posts mais curtidos","schema":{"type":"number","description":"Número de dias para buscar os posts mais curtidos"}}],"responses":{"200":{"description":"Listar posts associados à comunidade","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do post","sample":"1598","example":"1598"},"title":{"type":"string","description":"Nome do post","sample":"Espaço","example":"Espaço"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização","sample":"2021-08-10T15:00:00Z","example":"2021-08-10T15:00:00Z"},"totalComments":{"type":"number","description":"Total de comentários","sample":"1","example":"1"},"totalLikes":{"type":"number","description":"Total de likes","sample":"1","example":"1"},"member":{"type":"object","properties":{"id":{"type":"number","description":"Id do membro","sample":"4329","example":"4329"},"email":{"type":"string","description":"Email do membro","sample":"teste@example.com","example":"teste@example.com"}},"required":["id","email"],"additionalProperties":false,"description":"Informações do membro que criou o post"},"space":{"type":"object","properties":{"id":{"type":"number","description":"Id do espaço","sample":"4329","example":"4329"},"name":{"type":"string","description":"Nome do espaço","sample":"Espaço 1","example":"Espaço 1"}},"required":["id","name"],"additionalProperties":false,"description":"Informações do espaço associado ao post"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Tags associadas ao post"}},"required":["id","title","createdAt","updatedAt","totalComments","totalLikes","member","space","tags"],"additionalProperties":false,"description":"Detalhes do post"},"description":"Lista de posts"}},"required":["items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da comunidade que você deseja buscar o total de comentários","schema":{"type":"string","description":"Id da comunidade que você deseja buscar o total de comentários","sample":"3040","example":"3040"}},{"name":"days","in":"query","required":true,"description":"Número de dias para calcular os comentários realizados na comunidade","schema":{"type":"number","description":"Número de dias para calcular os comentários realizados na comunidade"}}],"responses":{"200":{"description":"Exibição do total de comentários","content":{"application/json":{"schema":{"type":"object","properties":{"totalComments":{"type":"number","description":"Número total de comentários realizados na comunidade","sample":"1","example":"1"}},"required":["totalComments"],"additionalProperties":false},"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":true,"description":"IDs dos produtos","schema":{"type":"string","description":"IDs dos produtos"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Quantidade de afiliados por página","schema":{"type":"number","description":"Quantidade de afiliados por página"}}],"responses":{"200":{"description":"Lista de afiliados do produtor","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Quantidade de afiliados por página"},"totalItems":{"type":"number","description":"Total de afiliados encontrados"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID da afiliação"},"status":{"type":"string","enum":["approved","canceled","pending","removed"],"enumDescriptions":{"approved":"Aprovado","canceled":"Cancelado","pending":"Pendente","removed":"Removido"},"description":"Status da afiliação"},"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da solicitação de afiliação"},"approvedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da aprovação de afiliação"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da ultima atualização de afiliação"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da criação de afiliação"},"product":{"type":"object","properties":{"name":{"type":"string","description":"Nome do produto"},"id":{"type":"string","description":"ID do produto"}},"required":["name","id"],"additionalProperties":false,"description":"Dados do produto associado à afiliação"},"customer":{"type":"object","properties":{"name":{"type":"string","description":"Nome do afiliado"},"id":{"type":"string","description":"ID da conta do afiliado na eduzz"}},"required":["name","id"],"additionalProperties":false,"description":"Dados do cliente associado à afiliação"}},"required":["id","status","requestedAt","approvedAt","updatedAt","createdAt","product","customer"],"additionalProperties":false,"description":"Afiliação"},"description":"Afiliados"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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/additional-charges":{"post":{"operationId":"postmyeduzzv1subscriptionsadditionalcharges","summary":"Permite ao produtor adicionar cobranças a um contrato já existente do cliente, que serão cobradas junto com a próxima fatura a ser paga","tags":["MyEduzz"],"security":[{"eduzz_auth":["myeduzz_subscriptions_write"]}],"parameters":[],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"subscriptionId":{"type":"string","description":"ID da assinatura","sample":"123456789","required":true,"example":"123456789"},"originKey":{"type":"string","description":"Seu ID da transação","sample":"example_tx_abc111101141","required":true,"example":"example_tx_abc111101141"},"referenceDate":{"type":"string","description":"Data de referência da cobrança adicional","sample":"2026-01-29","required":true,"example":"2026-01-29"},"paymentStatusCallbackUrl":{"type":"string","description":"URL de callback para status do pagamento","sample":"https://seusite.../api/callback/...","required":true,"example":"https://seusite.../api/callback/..."},"contentId":{"type":"string","description":"ID do conteúdo","sample":"896","required":true,"example":"896"},"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda","sample":"BRL","required":true,"example":"BRL"},"value":{"type":"number","description":"Valor","sample":"111.00","required":true,"example":"111.00"}},"required":true,"additionalProperties":false,"description":"Valor da cobrança adicional"},"description":{"type":"string","description":"Descrição da cobrança adicional","sample":"1 ativação avulsa email: fulano@aluno.com","required":true,"example":"1 ativação avulsa email: fulano@aluno.com"}},"required":["subscriptionId","originKey","referenceDate","paymentStatusCallbackUrl","contentId","price","description"],"additionalProperties":false}}}},"responses":{"200":{"description":"Adicionar cobrança adicional","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da cobrança adicional"},"originKey":{"type":"string","description":"Chave de origem da transação"},"subscriptionId":{"type":"string","description":"ID da assinatura"},"status":{"type":"string","enum":["pending","paid","canceled"],"enumDescriptions":{"pending":"Pendente","paid":"Pago","canceled":"Cancelado"},"description":"Status da cobrança adicional"}},"required":["id","originKey","subscriptionId","status"],"additionalProperties":false},"examples":{"default":{"value":{"id":"b6d77c10-64ae-4abd-93c7-754b36b65468","originKey":"example_tx_abc1111011141","subscriptionId":"123456789","status":"pending"}}}}}},"422":{"description":"Erro - Contrato PSL não permite adicionais","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da cobrança adicional"},"originKey":{"type":"string","description":"Chave de origem da transação"},"subscriptionId":{"type":"string","description":"ID da assinatura"},"status":{"type":"string","enum":["pending","paid","canceled"],"enumDescriptions":{"pending":"Pendente","paid":"Pago","canceled":"Cancelado"},"description":"Status da cobrança adicional"}},"required":["id","originKey","subscriptionId","status"],"additionalProperties":false},"examples":{"default":{"value":{"message":"O contrato é PSL e não é permitido fazer adicionais.","code":"SDC_010"}}}}}}}}},"/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","in":"path","required":true,"description":"Id da assinatura","schema":{"type":"string","description":"Id da assinatura","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"dueDateDay":{"type":"string","enum":["1","5","10","15","20","25"],"enumDescriptions":{"1":"1","5":"5","10":"10","15":"15","20":"20","25":"25"},"description":"Dia do vencimento a ser alterado no contrato.","sample":"Dia do vencimento a ser alterado no contrato.","example":"Dia do vencimento a ser alterado no contrato."},"motive":{"type":"string","enum":["Solicitação do cliente","Negociação comercial","Reorganização financeira do cliente","Mudança no método de pagamento","Problemas com a data atual de pagamento"],"enumDescriptions":{"Solicitação do cliente":"Solicitação do cliente","Negociação comercial":"Negociação comercial","Reorganização financeira do cliente":"Reorganização financeira do cliente","Mudança no método de pagamento":"Mudança no método de pagamento","Problemas com a data atual de pagamento":"Problemas com a data atual de pagamento"},"description":"Motivo da alteração do dia do vencimento.","sample":"Motivo da alteração do dia do vencimento.","example":"Motivo da alteração do dia do vencimento."}},"required":["dueDateDay","motive"],"additionalProperties":false}}}},"responses":{"200":{"description":"Alteração solicitada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false},"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","items":{"type":"string","sample":"123456789","example":"123456789"},"description":"Ids dos contratos a serem cancelados.","sample":"Ids dos contratos a serem cancelados.","example":"Ids dos contratos a serem cancelados."},"cancelReason":{"type":"string","description":"Motivo do cancelamento.","sample":"Problemas com o pagamento.","required":false,"example":"Problemas com o pagamento."}},"required":["subscriptions"],"additionalProperties":false}}}},"responses":{"202":{"description":"Contrato solicitado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da assinatura","schema":{"type":"string","description":"Id da assinatura","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Detalhes do contrato informado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da assinatura"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da assinatura"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da assinatura"},"status":{"type":"string","enum":["upToDate","awaitingPayment","late","canceled","defaulter","suspended","trial","finished","free"],"enumDescriptions":{"upToDate":"UpToDate","awaitingPayment":"AwaitingPayment","late":"Late","canceled":"Canceled","defaulter":"Defaulter","suspended":"Suspended","trial":"Trial","finished":"Finished","free":"Free"},"description":"Status da assinatura"},"firstInvoiceId":{"type":"string","description":"Id da primeira fatura da assinatura"},"isFinite":{"type":"boolean","description":"Indica se a assinatura é finita"},"isUnlimitedInstallments":{"type":"boolean","description":"Indica se a assinatura é parcelamento sem limites"},"hasNegotiation":{"type":"boolean","description":"Indica se a assinatura possui alguma fatura negociada"},"interruption":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da interrupção"},"type":{"type":"string","enum":["cancel","suspend"],"enumDescriptions":{"cancel":"Cancel","suspend":"Suspend"},"description":"Tipo da interrupção"},"removeAccessDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de remoção do acesso"},"reason":{"type":"string","description":"Motivo da interrupção"},"origin":{"type":"string","description":"Origem da interrupção"},"previousStatus":{"type":"string","enum":["upToDate","awaitingPayment","late","canceled","defaulter","suspended","trial","finished","free"],"enumDescriptions":{"upToDate":"UpToDate","awaitingPayment":"AwaitingPayment","late":"Late","canceled":"Canceled","defaulter":"Defaulter","suspended":"Suspended","trial":"Trial","finished":"Finished","free":"Free"},"description":"Status anterior"},"responsible":{"type":"string","description":"Responsável pela interrupção"}},"required":["createdAt","type","removeAccessDate","reason","origin","previousStatus","responsible"],"additionalProperties":false,"description":"Informações sobre a interrupção (suspensão ou cancelamento) da assinatura"},"recurrence":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início da recorrência"},"nextDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Próxima data de vencimento"},"currentDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de vencimento atual"},"finalDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do último vencimento"},"finishesAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de finalização da recorrência"},"frequency":{"type":"object","properties":{"type":{"type":"string","enum":["daily","weekly","monthly","yearly"],"enumDescriptions":{"daily":"Daily","weekly":"Weekly","monthly":"Monthly","yearly":"Yearly"},"description":"Tipo da frequência"},"value":{"type":"number","description":"Período da frequência"}},"required":["type","value"],"additionalProperties":false,"description":"Frequência da recorrência"}},"required":["startsAt","nextDueDate","currentDueDate","finalDueDate","finishesAt","frequency"],"additionalProperties":false,"description":"Informações sobre a recorrência da assinatura"},"charges":{"type":"object","properties":{"total":{"type":"number","description":"Total de cobranças"},"current":{"type":"number","description":"Em qual cobrança está atualmente"},"paid":{"type":"number","description":"Cobranças pagas"},"pending":{"type":"number","description":"Cobranças pendentes"},"negotiated":{"type":"number","description":"Cobranças negociadas"}},"required":["total","current","paid","pending","negotiated"],"additionalProperties":false,"description":"Informações sobre as cobranças da assinatura"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"title":{"type":"string","description":"Nome do produto"},"hasMembershipFee":{"type":"boolean","description":"Indica se o produto possui taxa de adesão"},"membershipFee":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda da taxa de adesão"},"value":{"type":"number","description":"Valor da taxa de adesão"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre a taxa de adesão"},"deliveries":{"type":"array","items":{"type":"string","sample":"files","example":"files"},"description":"Tipos de entrega do produto"}},"required":["id","title","hasMembershipFee","membershipFee","deliveries"],"additionalProperties":false,"description":"Informações sobre um produto"},"description":"Produtos da assinatura"},"payment":{"type":"object","properties":{"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do preço"},"value":{"type":"number","description":"Valor do preço"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre o preço"},"method":{"type":"string","enum":["bankslip","creditcard","pix","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditcard":"Creditcard","pix":"Pix","unknown":"Unknown"},"description":"Método de pagamento"},"installments":{"type":"number","description":"Número de parcelas"}},"required":["price","method","installments"],"additionalProperties":false,"description":"Informações sobre o pagamento da assinatura"},"client":{"type":"object","properties":{"name":{"type":"string","description":"Nome do cliente"},"email":{"type":"string","description":"E-mail do cliente"},"phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Código do país (ddi)"},"areaCode":{"type":"string","description":"Código de área (ddd)"},"number":{"type":"string","description":"Número do telefone"}},"required":["countryCode","areaCode","number"],"additionalProperties":false,"description":"Informações sobre o telefone do cliente"}},"required":["name","email","phone"],"additionalProperties":false,"description":"Informações sobre o cliente"}},"required":["id","createdAt","updatedAt","status","firstInvoiceId","isFinite","isUnlimitedInstallments","hasNegotiation","interruption","recurrence","charges","products","payment","client"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":false,"description":"Quantidade de itens por página","schema":{"type":"number","description":"Quantidade de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data de início do intervalo de busca (inclusive)","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início do intervalo de busca (inclusive)"}},{"name":"endDate","in":"query","required":true,"description":"Data de término do intervalo de busca (inclusive)","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término do intervalo de busca (inclusive)"}},{"name":"filterBy","in":"query","required":true,"description":"Filtra os resultados por tipo de alteração (criação ou atualização)","schema":{"type":"string","enum":["creation","update"],"enumDescriptions":{"creation":"Creation","update":"Update"},"description":"Filtra os resultados por tipo de alteração (criação ou atualização)"}}],"responses":{"200":{"description":"Detalhes da assinatura","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da assinatura"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da assinatura"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da assinatura"},"status":{"type":"string","enum":["upToDate","awaitingPayment","late","canceled","defaulter","suspended","trial","finished","free"],"enumDescriptions":{"upToDate":"UpToDate","awaitingPayment":"AwaitingPayment","late":"Late","canceled":"Canceled","defaulter":"Defaulter","suspended":"Suspended","trial":"Trial","finished":"Finished","free":"Free"},"description":"Status da assinatura"},"firstInvoiceId":{"type":"string","description":"Id da primeira fatura da assinatura"},"isFinite":{"type":"boolean","description":"Indica se a assinatura é finita"},"isUnlimitedInstallments":{"type":"boolean","description":"Indica se a assinatura é parcelamento sem limites"},"hasNegotiation":{"type":"boolean","description":"Indica se a assinatura possui alguma fatura negociada"},"interruption":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da interrupção"},"type":{"type":"string","enum":["cancel","suspend"],"enumDescriptions":{"cancel":"Cancel","suspend":"Suspend"},"description":"Tipo da interrupção"},"removeAccessDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de remoção do acesso"},"reason":{"type":"string","description":"Motivo da interrupção"},"origin":{"type":"string","description":"Origem da interrupção"},"previousStatus":{"type":"string","enum":["upToDate","awaitingPayment","late","canceled","defaulter","suspended","trial","finished","free"],"enumDescriptions":{"upToDate":"UpToDate","awaitingPayment":"AwaitingPayment","late":"Late","canceled":"Canceled","defaulter":"Defaulter","suspended":"Suspended","trial":"Trial","finished":"Finished","free":"Free"},"description":"Status anterior"},"responsible":{"type":"string","description":"Responsável pela interrupção"}},"required":["createdAt","type","removeAccessDate","reason","origin","previousStatus","responsible"],"additionalProperties":false,"description":"Informações sobre a interrupção (suspensão ou cancelamento) da assinatura"},"recurrence":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início da recorrência"},"nextDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Próxima data de vencimento"},"currentDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de vencimento atual"},"finalDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do último vencimento"},"finishesAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de finalização da recorrência"},"frequency":{"type":"object","properties":{"type":{"type":"string","enum":["daily","weekly","monthly","yearly"],"enumDescriptions":{"daily":"Daily","weekly":"Weekly","monthly":"Monthly","yearly":"Yearly"},"description":"Tipo da frequência"},"value":{"type":"number","description":"Período da frequência"}},"required":["type","value"],"additionalProperties":false,"description":"Frequência da recorrência"}},"required":["startsAt","nextDueDate","currentDueDate","finalDueDate","finishesAt","frequency"],"additionalProperties":false,"description":"Informações sobre a recorrência da assinatura"},"charges":{"type":"object","properties":{"total":{"type":"number","description":"Total de cobranças"},"current":{"type":"number","description":"Em qual cobrança está atualmente"},"paid":{"type":"number","description":"Cobranças pagas"},"pending":{"type":"number","description":"Cobranças pendentes"},"negotiated":{"type":"number","description":"Cobranças negociadas"}},"required":["total","current","paid","pending","negotiated"],"additionalProperties":false,"description":"Informações sobre as quantidades de cobranças da assinatura"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"title":{"type":"string","description":"Nome do produto"},"hasMembershipFee":{"type":"boolean","description":"Indica se o produto possui taxa de adesão"},"membershipFee":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda da taxa de adesão"},"value":{"type":"number","description":"Valor da taxa de adesão"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre a taxa de adesão"},"deliveries":{"type":"array","items":{"type":"string","sample":"files","example":"files"},"description":"Tipos de entrega do produto"}},"required":["id","title","hasMembershipFee","membershipFee","deliveries"],"additionalProperties":false,"description":"Informações sobre um produto"},"description":"Produtos da assinatura"},"payment":{"type":"object","properties":{"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do preço"},"value":{"type":"number","description":"Valor do preço"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre o preço"},"method":{"type":"string","enum":["bankslip","creditcard","pix","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditcard":"Creditcard","pix":"Pix","unknown":"Unknown"},"description":"Método de pagamento"},"installments":{"type":"number","description":"Número de parcelas"}},"required":["price","method","installments"],"additionalProperties":false,"description":"Informações sobre o pagamento da assinatura"},"client":{"type":"object","properties":{"name":{"type":"string","description":"Nome do cliente"},"email":{"type":"string","description":"E-mail do cliente"},"phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Código do país (ddi)"},"areaCode":{"type":"string","description":"Código de área (ddd)"},"number":{"type":"string","description":"Número do telefone"}},"required":["countryCode","areaCode","number"],"additionalProperties":false,"description":"Informações sobre o telefone do cliente"}},"required":["name","email","phone"],"additionalProperties":false,"description":"Informações sobre o cliente"}},"required":["id","createdAt","updatedAt","status","firstInvoiceId","isFinite","isUnlimitedInstallments","hasNegotiation","interruption","recurrence","charges","products","payment","client"],"additionalProperties":false},"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","in":"path","required":true,"description":"E-mail do cliente","schema":{"type":"string","description":"E-mail do cliente","sample":"fulanodetal@eduzz.com","example":"fulanodetal@eduzz.com"}}],"responses":{"200":{"description":"Detalhes do cliente informado","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do cliente"},"email":{"type":"string","description":"E-mail do cliente"},"phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Código do pais"},"areaCode":{"type":"string","description":"Código de área"},"number":{"type":"string","description":"Número"}},"required":["countryCode","areaCode","number"],"additionalProperties":false,"description":"Informações de telefone do cliente"},"subscriptions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da assinatura"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da assinatura"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da assinatura"},"status":{"type":"string","enum":["upToDate","awaitingPayment","late","canceled","defaulter","suspended","trial","finished","free"],"enumDescriptions":{"upToDate":"UpToDate","awaitingPayment":"AwaitingPayment","late":"Late","canceled":"Canceled","defaulter":"Defaulter","suspended":"Suspended","trial":"Trial","finished":"Finished","free":"Free"},"description":"Status da assinatura"},"firstInvoiceId":{"type":"string","description":"Id da primeira assinatura"},"isFinite":{"type":"boolean","description":"Indica se a assinatura é finita"},"isUnlimitedInstallments":{"type":"boolean","description":"Indica se a assinatura é parcelamento sem limites"},"hasNegotiation":{"type":"boolean","description":"Indica se a assinatura possui alguma fatura negociada"},"interruption":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da interrupção"},"type":{"type":"string","enum":["cancel","suspend"],"enumDescriptions":{"cancel":"Cancel","suspend":"Suspend"},"description":"Tipo da interrupção"},"removeAccessDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de remoção do acesso"},"reason":{"type":"string","description":"Motivo da interrupção"},"origin":{"type":"string","description":"Origem da interrupção"},"previousStatus":{"type":"string","enum":["upToDate","awaitingPayment","late","canceled","defaulter","suspended","trial","finished","free"],"enumDescriptions":{"upToDate":"UpToDate","awaitingPayment":"AwaitingPayment","late":"Late","canceled":"Canceled","defaulter":"Defaulter","suspended":"Suspended","trial":"Trial","finished":"Finished","free":"Free"},"description":"Status anterior"},"responsible":{"type":"string","description":"Responsável pela interrupção"}},"required":["createdAt","type","removeAccessDate","reason","origin","previousStatus","responsible"],"additionalProperties":false,"description":"Informações sobre a interrupção (suspensão ou cancelamento) da assinatura"},"recurrence":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início da recorrência"},"nextDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Próxima data de vencimento"},"currentDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de vencimento atual"},"finalDueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do último vencimento"},"finishesAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de finalização da recorrência"},"frequency":{"type":"object","properties":{"type":{"type":"string","enum":["daily","weekly","monthly","yearly"],"enumDescriptions":{"daily":"Daily","weekly":"Weekly","monthly":"Monthly","yearly":"Yearly"},"description":"Tipo da frequência"},"value":{"type":"number","description":"Período da frequência"}},"required":["type","value"],"additionalProperties":false,"description":"Frequência da recorrência"}},"required":["startsAt","nextDueDate","currentDueDate","finalDueDate","finishesAt","frequency"],"additionalProperties":false,"description":"Informações sobre a recorrência da assinatura"},"charges":{"type":"object","properties":{"total":{"type":"number","description":"Total de cobranças"},"current":{"type":"number","description":"Em qual cobrança está atualmente"},"paid":{"type":"number","description":"Cobranças pagas"},"pending":{"type":"number","description":"Cobranças pendentes"},"negotiated":{"type":"number","description":"Cobranças negociadas"}},"required":["total","current","paid","pending","negotiated"],"additionalProperties":false,"description":"Informações sobre as cobranças da assinatura"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"title":{"type":"string","description":"Nome do produto"},"hasMembershipFee":{"type":"boolean","description":"Indica se o produto possui taxa de adesão"},"membershipFee":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda da taxa de adesão"},"value":{"type":"number","description":"Valor da taxa de adesão"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre a taxa de adesão"}},"required":["id","title","hasMembershipFee","membershipFee"],"additionalProperties":false,"description":"Informações sobre um produto"},"description":"Produtos da assinatura"},"payment":{"type":"object","properties":{"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do preço"},"value":{"type":"number","description":"Valor do preço"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre o preço"},"method":{"type":"string","enum":["bankslip","creditcard","pix","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditcard":"Creditcard","pix":"Pix","unknown":"Unknown"},"description":"Método de pagamento"},"installments":{"type":"number","description":"Número de parcelas"}},"required":["price","method","installments"],"additionalProperties":false,"description":"Informações sobre o pagamento da assinatura"},"client":{"type":"object","properties":{"name":{"type":"string","description":"Nome do cliente"},"email":{"type":"string","description":"E-mail do cliente"},"phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Código do país (ddi)"},"areaCode":{"type":"string","description":"Código de área (ddd)"},"number":{"type":"string","description":"Número do telefone"}},"required":["countryCode","areaCode","number"],"additionalProperties":false,"description":"Informações sobre o telefone do cliente"}},"required":["name","email","phone"],"additionalProperties":false,"description":"Informações sobre o cliente"}},"required":["id","createdAt","updatedAt","status","firstInvoiceId","isFinite","isUnlimitedInstallments","hasNegotiation","interruption","recurrence","charges","products","payment","client"],"additionalProperties":false,"description":"Informações de uma assinatura"},"description":"Informações de assinaturas"}},"required":["name","email","phone","subscriptions"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da assinatura","schema":{"type":"string","description":"Id da assinatura","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Lista de faturas do contrato","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da fatura"},"subscriptionId":{"type":"string","description":"Id da assinatura"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da fatura"},"dueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de pagamento da fatura"},"coupon":{"type":"string","description":"Cupom utilizado"},"hasAffiliate":{"type":"boolean","description":"Indica se a fatura tem afiliado"},"status":{"type":"string","enum":["open","processing","paid","canceled","waitingDocuments","waitingRefund","refunded","analysing","duplicated","expired","recovering","internal","trial","deleted","waitingPayment","refused","overdue","scheduled","negotiated","partialRefund"],"enumDescriptions":{"open":"Fatura aberta","processing":"Pagamento em processamento","paid":"Fatura paga","canceled":"Fatura cancelada","waitingDocuments":"Aguardando envio de documentos","waitingRefund":"Aguardando reembolso","refunded":"Fatura reembolsada","analysing":"Pagamento em análise","duplicated":"Fatura duplicada","expired":"Fatura expirada","recovering":"Em recuperação","internal":"Uso interno","trial":"Período de teste (trial)","deleted":"Fatura deletada","waitingPayment":"Aguardando pagamento","refused":"Pagamento recusado","overdue":"Fatura vencida","scheduled":"Pagamento agendado","negotiated":"Fatura negociada","partialRefund":"Reembolso parcial"},"description":"Status da fatura"},"payment":{"type":"object","properties":{"amount":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda de pagamento"},"value":{"type":"number","description":"Valor do pagamento"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre o pagamento"},"link":{"type":"string","description":"Link de pagamento da fatura (Apenas quando está aberta)"},"method":{"type":"string","enum":["bankslip","creditcard","pix","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditcard":"Creditcard","pix":"Pix","unknown":"Unknown"},"description":"Método de pagamento"}},"required":["amount","link","method"],"additionalProperties":false,"description":"Informações sobre o pagamento da fatura"},"items":{"type":"array","items":{"type":"object","properties":{"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"title":{"type":"string","description":"Titulo do produto"}},"required":["id","title"],"additionalProperties":false,"description":"Id da assinatura"},"description":{"type":"string","description":"Descrição do produto"},"amount":{"type":"object","properties":{"amount":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do produto"},"value":{"type":"number","description":"Valor do produto"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre valor do produto"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do produto"},"value":{"type":"number","description":"Valor do produto"}},"required":["currency","value"],"additionalProperties":false,"description":"Informações sobre valor total do produto na fatura"}},"required":["amount","total"],"additionalProperties":false,"description":"Informações sobre valor do produto"},"quantity":{"type":"number","description":"Indica a quantidade desse produto na fatura"}},"required":["product","description","amount","quantity"],"additionalProperties":false,"description":"Informação do item da fatura"},"description":"Informações dos itens da fatura"}},"required":["id","subscriptionId","createdAt","dueDate","coupon","hasAffiliate","status","payment","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da assinatura","schema":{"type":"string","description":"Id da assinatura","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Contrato reativado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da assinatura","schema":{"type":"string","description":"Id da assinatura","sample":"12345","example":"12345"}}],"responses":{"202":{"description":"Alteração solicitada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"E-mail do comprador que se deseja obter os detalhes","schema":{"type":"string","description":"E-mail do comprador que se deseja obter os detalhes","sample":"buyer@teste.com","example":"buyer@teste.com"}}],"responses":{"200":{"description":"Detalhes do comprador","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id do comprador","sample":"123456","example":"123456"},"name":{"type":"string","description":"Nome do comprador","sample":"John Doe","example":"John Doe"},"email":{"type":"string","description":"E-mail do comprador","sample":"buyer@teste.com","example":"buyer@teste.com"},"phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Código do país"},"areaCode":{"type":"string","description":"Código de área"},"number":{"type":"string","description":"Número do telefone"}},"required":["countryCode","areaCode","number"],"additionalProperties":false,"description":"Informações de telefone do comprador"},"address":{"type":"object","properties":{"street":{"nullable":true,"type":"string","description":"Rua"},"number":{"nullable":true,"type":"string","description":"Número"},"supplement":{"nullable":true,"type":"string","description":"Complemento"},"cep":{"nullable":true,"type":"string","description":"CEP"},"state":{"nullable":true,"type":"string","description":"Estado"},"country":{"nullable":true,"type":"string","description":"País"}},"required":["street","number","supplement","cep","state","country"],"additionalProperties":false,"description":"Informações de endereço do comprador"}},"required":["id","name","email","phone","address"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"order","in":"query","required":true,"description":"Ordenação dos resultados (ascendente ou descendente)","schema":{"type":"string","enum":["asc","desc"],"enumDescriptions":{"asc":"Ascendente","desc":"Descendente"},"description":"Ordenação dos resultados (ascendente ou descendente)"}},{"name":"startDate","in":"query","required":true,"description":"Data de início do período","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início do período"}},{"name":"endDate","in":"query","required":true,"description":"Data de término do período","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término do período"}}],"responses":{"200":{"description":"Lista de compradores","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"2","example":"2"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"20","example":"20"},"totalItems":{"type":"number","description":"Número total de items","sample":"29","example":"29"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do comprador","sample":"123456","example":"123456"},"name":{"type":"string","description":"Nome do comprador","sample":"John Doe","example":"John Doe"},"email":{"type":"string","description":"E-mail do comprador","sample":"buyer@teste.com","example":"buyer@teste.com"},"phone":{"type":"object","properties":{"countryCode":{"type":"string","description":"Código do país"},"areaCode":{"type":"string","description":"Código de área"},"number":{"type":"string","description":"Número"}},"required":["countryCode","areaCode","number"],"additionalProperties":false,"description":"Informações de telefone do comprador"},"purchaseHistoryOverview":{"type":"object","properties":{"productsQuantity":{"type":"number","description":"Quantidade de produtos vendidos para o cliente"},"net":{"type":"object","properties":{"currency":{"type":"string","enum":["BRL"],"enumDescriptions":{"BRL":"Real Brasileiro"},"description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total de ganhos líquidos em vendas para o cliente"},"gross":{"type":"object","properties":{"currency":{"type":"string","enum":["BRL"],"enumDescriptions":{"BRL":"Real Brasileiro"},"description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total de ganhos brutos em vendas para o cliente"}},"required":["productsQuantity","net","gross"],"additionalProperties":false,"description":"Visão geral do histórico de compras do cliente"}},"required":["id","name","email","phone","purchaseHistoryOverview"],"additionalProperties":false,"description":"Informações de cada comprador"},"description":"Lista de compradores"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do documento fiscal","schema":{"type":"string","description":"Id do documento fiscal","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["new","pending","waitingDocument","canceled","processed","approved","fileGenerated","processing","deleted"],"enumDescriptions":{"new":"Novo","pending":"Pendente","waitingDocument":"Aguardando documento","canceled":"Cancelado","processed":"Processado","approved":"Aprovado","fileGenerated":"Arquivo gerado","processing":"Processando","deleted":"Deletado"},"description":"Status do documento fiscal","required":true}},"required":["status"],"additionalProperties":false}}}},"responses":{"200":{"description":"Documento fiscal atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"boolean"}},"required":["updated"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do documento fiscal","schema":{"type":"string","description":"Id do documento fiscal","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["new","pending","waitingDocument","canceled","processed","approved","fileGenerated","processing","deleted"],"enumDescriptions":{"new":"Novo","pending":"Pendente","waitingDocument":"Aguardando documento","canceled":"Cancelado","processed":"Processado","approved":"Aprovado","fileGenerated":"Arquivo gerado","processing":"Processando","deleted":"Deletado"},"description":"Status do documento fiscal","required":true}},"required":["status"],"additionalProperties":false}}}},"responses":{"200":{"description":"Documento fiscal atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"boolean"}},"required":["updated"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data de início do período","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início do período","required":true}},{"name":"endDate","in":"query","required":true,"description":"Data de término do período","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término do período","required":true}},{"name":"saleId","in":"query","required":true,"description":"Id da venda","schema":{"type":"number","description":"Id da venda"}}],"responses":{"200":{"description":"Detalhes do extrato financeiro","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página"},"totalItems":{"type":"number","description":"Número total de items"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do extrato"},"creditDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da crédito no extrato"},"description":{"type":"string","description":"Descrição do extrato"},"saleId":{"type":"string","description":"Id da venda"},"type":{"type":"string","enum":["affiliante_sale","sale","refund","bonus","fee","product_payment","anticipation","anticipation_direct","chargeback_blocked","chargerback_success","recurrence_credit","conciliation"],"enumDescriptions":{"affiliante_sale":"Affiliante sale","sale":"Sale","refund":"Refund","bonus":"Bonus","fee":"Fee","product_payment":"Product payment","anticipation":"Anticipation","anticipation_direct":"Anticipation direct","chargeback_blocked":"Chargeback blocked","chargerback_success":"Chargerback success","recurrence_credit":"Recurrence credit","conciliation":"Conciliation"},"description":"Tipo do extrato"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor do extrato"}},"required":["id","creditDate","description","saleId","type","value"],"additionalProperties":false,"description":"Item de extrato"},"description":"Itens do extrato"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data de início (máximo 5 meses antes da data final)","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início (máximo 5 meses antes da data final)","required":true}},{"name":"endDate","in":"query","required":true,"description":"Data de término (máximo 5 meses após a data de início)","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término (máximo 5 meses após a data de início)","required":true}},{"name":"status","in":"query","required":true,"description":"Status do documento fiscal","schema":{"type":"string","enum":["new","pending","waitingDocument","canceled","processed","approved","fileGenerated","processing","deleted"],"enumDescriptions":{"new":"Novo","pending":"Pendente","waitingDocument":"Aguardando documento","canceled":"Cancelado","processed":"Processado","approved":"Aprovado","fileGenerated":"Arquivo gerado","processing":"Processando","deleted":"Deletado"},"description":"Status do documento fiscal"}},{"name":"name","in":"query","required":true,"description":"Nome do cliente","schema":{"type":"string","description":"Nome do cliente"}},{"name":"email","in":"query","required":true,"description":"Email do cliente","schema":{"type":"string","description":"Email do cliente"}},{"name":"saleId","in":"query","required":true,"description":"Id da venda","schema":{"type":"string","description":"Id da venda"}},{"name":"productId","in":"query","required":true,"description":"Id do produto","schema":{"type":"string","description":"Id do produto"}},{"name":"documentId","in":"query","required":true,"description":"Id do documento","schema":{"type":"string","description":"Id do documento"}}],"responses":{"200":{"description":"Listagem de Documentos Fiscais","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página"},"totalItems":{"type":"number","description":"Número total de itens"},"items":{"type":"array","items":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"string","description":"Id do documento fiscal"},"name":{"type":"string","description":"Nome do documento fiscal"},"status":{"type":"string","description":"Status do documento fiscal"},"type":{"type":"string","description":"Tipo do documento fiscal"},"baseValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor base do documento fiscal"},"emissionDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de emissão do documento fiscal"},"referenceDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de referência do documento fiscal"},"processingDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de processamento do documento fiscal"},"fileStatus":{"type":"string","description":"Status do Arquivo enviado no documento"},"taxBase":{"type":"number","description":"Taxa base enviada no documento"},"basePercent":{"type":"number","description":"Percentual base enviado no documento"},"taxValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor da taxa enviada no documento"}},"required":["id","name","status","type","baseValue","emissionDate","referenceDate","processingDate","fileStatus","taxBase","basePercent","taxValue"],"additionalProperties":false,"description":"Informações do documento fiscal"},"source":{"type":"object","properties":{"taxType":{"nullable":true,"type":"string","description":"Tipo de imposto da fonte"},"companyName":{"type":"string","description":"Nome da empresa de origem"},"document":{"type":"string","description":"Documento da fonte"},"ie":{"type":"string","description":"Inscrição estadual da fonte"},"im":{"nullable":true,"type":"string","description":"Inscrição municipal da fonte"},"email":{"type":"string","description":"Email da fonte"},"tel":{"nullable":true,"type":"string","description":"Telefone da fonte"},"tel2":{"type":"string","description":"Telefone 2 da fonte"},"cell":{"nullable":true,"type":"string","description":"Celular da fonte"},"address":{"type":"object","properties":{"street":{"type":"string","description":"Rua da fonte"},"number":{"type":"string","description":"Número da rua da fonte"},"complement":{"type":"string","description":"Complemento da fonte"},"district":{"type":"string","description":"Bairro da fonte"},"zipCode":{"type":"string","description":"CEP da fonte"},"city":{"type":"string","description":"Cidade da fonte"},"uf":{"type":"string","description":"UF da fonte"}},"required":["street","number","complement","district","zipCode","city","uf"],"additionalProperties":false,"description":"Informações de endereço da fonte"}},"required":["taxType","companyName","document","ie","im","email","tel","tel2","cell","address"],"additionalProperties":false,"description":"Informações da fonte"},"destination":{"type":"object","properties":{"companyName":{"type":"string","description":"Nome da empresa de destino"},"taxType":{"type":"string","description":"Tipo de imposto do destino"},"taxId":{"type":"string","description":"Id do imposto do destino"},"ie":{"type":"string","description":"Inscrição estadual do destino"},"im":{"nullable":true,"type":"string","description":"Inscrição municipal do destino"},"email":{"type":"string","description":"Email do destino"},"tel":{"nullable":true,"type":"string","description":"Telefone do destino"},"tel2":{"nullable":true,"type":"string","description":"Telefone 2 do destino"},"cell":{"type":"string","description":"Celular do destino"},"address":{"type":"object","properties":{"street":{"nullable":true,"type":"string","description":"Rua do destino"},"number":{"nullable":true,"type":"string","description":"Número da rua do destino"},"complement":{"nullable":true,"type":"string","description":"Complemento do destino"},"district":{"nullable":true,"type":"string","description":"Bairro do destino"},"zipCode":{"type":"string","description":"CEP do destino"},"countryForeign":{"nullable":true,"type":"string","description":"País estrangeiro do destino"},"city":{"nullable":true,"type":"string","description":"Cidade do destino"},"uf":{"nullable":true,"type":"string","description":"UF do destino"},"country":{"nullable":true,"type":"string","description":"País do destino"}},"required":["street","number","complement","district","zipCode","countryForeign","city","uf","country"],"additionalProperties":false,"description":"Informações de endereço do destino"}},"required":["companyName","taxType","taxId","ie","im","email","tel","tel2","cell","address"],"additionalProperties":false,"description":"Informações do destino"},"sale":{"type":"object","properties":{"id":{"type":"string","description":"Id da venda"},"paymentDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do pagamento"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da Venda"}},"required":["id","paymentDate","total"],"additionalProperties":false,"description":"Informações da venda"},"client":{"type":"object","properties":{"id":{"type":"string","description":"Id do cliente"},"name":{"type":"string","description":"Nome do cliente"},"document":{"type":"string","description":"Documento do cliente"},"email":{"type":"string","description":"Email do cliente"},"tel":{"nullable":true,"type":"string","description":"Telefone do cliente"},"tel2":{"nullable":true,"type":"string","description":"Telefone 2 do cliente"},"cell":{"type":"string","description":"Celular do cliente"},"address":{"type":"object","properties":{"street":{"nullable":true,"type":"string","description":"Rua do cliente"},"number":{"nullable":true,"type":"string","description":"Número do endereço do cliente"},"complement":{"nullable":true,"type":"string","description":"Complemento do endereço do cliente"},"neighborhood":{"nullable":true,"type":"string","description":"Bairro do cliente"},"zipCode":{"type":"string","description":"CEP do cliente"},"city":{"nullable":true,"type":"string","description":"Cidade do cliente"},"state":{"nullable":true,"type":"string","description":"Estado do cliente"}},"required":["street","number","complement","neighborhood","zipCode","city","state"],"additionalProperties":false,"description":"Informações de endereço do cliente"}},"required":["id","name","document","email","tel","tel2","cell","address"],"additionalProperties":false,"description":"Informações do cliente"},"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"title":{"type":"string","description":"Título do produto"}},"required":["id","title"],"additionalProperties":false,"description":"Informações do produto"}},"required":["document","source","destination","sale","client","product"],"additionalProperties":false,"description":"Item do documento fiscal"},"description":"Itens dos documentos fiscais"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data de início","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início","required":true}},{"name":"endDate","in":"query","required":true,"description":"Data de término","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término","required":true}},{"name":"status","in":"query","required":true,"description":"Status do documento fiscal","schema":{"type":"string","enum":["new","pending","waitingDocument","canceled","processed","approved","fileGenerated","processing","deleted"],"enumDescriptions":{"new":"Novo","pending":"Pendente","waitingDocument":"Aguardando documento","canceled":"Cancelado","processed":"Processado","approved":"Aprovado","fileGenerated":"Arquivo gerado","processing":"Processando","deleted":"Deletado"},"description":"Status do documento fiscal"}},{"name":"name","in":"query","required":true,"description":"Nome do cliente","schema":{"type":"string","description":"Nome do cliente"}},{"name":"email","in":"query","required":true,"description":"Email do cliente","schema":{"type":"string","description":"Email do cliente"}},{"name":"saleId","in":"query","required":true,"description":"Id da venda","schema":{"type":"string","description":"Id da venda"}},{"name":"productId","in":"query","required":true,"description":"Id do produto","schema":{"type":"string","description":"Id do produto"}},{"name":"documentId","in":"query","required":true,"description":"Id do documento","schema":{"type":"string","description":"Id do documento"}}],"responses":{"200":{"description":"Listagem de Documentos Fiscais","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página"},"totalItems":{"type":"number","description":"Número total de itens"},"items":{"type":"array","items":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"string","description":"Id do documento fiscal"},"name":{"type":"string","description":"Nome do documento fiscal"},"status":{"type":"string","description":"Status do documento fiscal"},"type":{"type":"string","description":"Tipo do documento fiscal"},"baseValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor base do documento fiscal"},"emissionDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de emissão do documento fiscal"},"referenceDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de referência do documento fiscal"},"processingDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de processamento do documento fiscal"},"taxation":{"type":"object","properties":{"nbs":{"type":"object","properties":{"code":{"type":"string","description":"Código NBS"},"description":{"type":"string","description":"Descrição do código NBS"}},"required":["code","description"],"additionalProperties":false,"description":"NBS (Nomenclatura Brasileira de Serviços)"},"taxClassification":{"type":"object","properties":{"code":{"type":"string","description":"Código de classificação tributária"},"description":{"type":"string","description":"Descrição do código de classificação tributária"}},"required":["code","description"],"additionalProperties":false,"description":"Classificação tributária"},"operationIndicator":{"type":"object","properties":{"code":{"type":"string","description":"Código de indicador de operação"},"description":{"type":"string","description":"Descrição do código de indicador de operação"}},"required":["code","description"],"additionalProperties":false,"description":"Indicador de operação"}},"required":["nbs","taxClassification","operationIndicator"],"additionalProperties":false,"description":"Informações de tributação do documento fiscal"}},"required":["id","name","status","type","baseValue","emissionDate","referenceDate","processingDate","taxation"],"additionalProperties":false,"description":"Informações do documento fiscal"},"source":{"type":"object","properties":{"taxType":{"nullable":true,"type":"string","description":"Tipo de imposto da fonte"},"companyName":{"type":"string","description":"Nome da empresa de origem"},"document":{"type":"string","description":"Documento da fonte"},"ie":{"type":"string","description":"Inscrição estadual da fonte"},"im":{"nullable":true,"type":"string","description":"Inscrição municipal da fonte"},"email":{"type":"string","description":"Email da fonte"},"tel":{"nullable":true,"type":"string","description":"Telefone da fonte"},"tel2":{"type":"string","description":"Telefone 2 da fonte"},"cell":{"nullable":true,"type":"string","description":"Celular da fonte"},"address":{"type":"object","properties":{"street":{"type":"string","description":"Rua da fonte"},"number":{"type":"string","description":"Número da rua da fonte"},"complement":{"type":"string","description":"Complemento da fonte"},"district":{"type":"string","description":"Bairro da fonte"},"zipCode":{"type":"string","description":"CEP da fonte"},"city":{"type":"string","description":"Cidade da fonte"},"uf":{"type":"string","description":"UF da fonte"}},"required":["street","number","complement","district","zipCode","city","uf"],"additionalProperties":false,"description":"Informações de endereço da fonte"}},"required":["taxType","companyName","document","ie","im","email","tel","tel2","cell","address"],"additionalProperties":false,"description":"Informações da fonte"},"destination":{"type":"object","properties":{"companyName":{"type":"string","description":"Nome da empresa de destino"},"taxType":{"type":"string","description":"Tipo de imposto do destino"},"taxId":{"type":"string","description":"Id do imposto do destino"},"ie":{"type":"string","description":"Inscrição estadual do destino"},"im":{"nullable":true,"type":"string","description":"Inscrição municipal do destino"},"email":{"type":"string","description":"Email do destino"},"tel":{"nullable":true,"type":"string","description":"Telefone do destino"},"tel2":{"nullable":true,"type":"string","description":"Telefone 2 do destino"},"cell":{"type":"string","description":"Celular do destino"},"address":{"type":"object","properties":{"street":{"nullable":true,"type":"string","description":"Rua do destino"},"number":{"nullable":true,"type":"string","description":"Número da rua do destino"},"complement":{"nullable":true,"type":"string","description":"Complemento do destino"},"district":{"nullable":true,"type":"string","description":"Bairro do destino"},"zipCode":{"type":"string","description":"CEP do destino"},"countryForeign":{"nullable":true,"type":"string","description":"País estrangeiro do destino"},"city":{"nullable":true,"type":"string","description":"Cidade do destino"},"uf":{"nullable":true,"type":"string","description":"UF do destino"},"country":{"nullable":true,"type":"string","description":"País do destino"}},"required":["street","number","complement","district","zipCode","countryForeign","city","uf","country"],"additionalProperties":false,"description":"Informações de endereço do destino"}},"required":["companyName","taxType","taxId","ie","im","email","tel","tel2","cell","address"],"additionalProperties":false,"description":"Informações do destino"},"sale":{"type":"object","properties":{"id":{"type":"string","description":"Id da venda"},"paymentDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do pagamento"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da Venda"}},"required":["id","paymentDate","total"],"additionalProperties":false,"description":"Informações da venda"},"client":{"type":"object","properties":{"id":{"type":"string","description":"Id do cliente"},"name":{"type":"string","description":"Nome do cliente"},"document":{"type":"string","description":"Documento do cliente"},"email":{"type":"string","description":"Email do cliente"},"telephone":{"nullable":true,"type":"string","description":"Telefone do cliente"},"telephone2":{"nullable":true,"type":"string","description":"Telefone 2 do cliente"},"cellphone":{"type":"string","description":"Celular do cliente"},"address":{"type":"object","properties":{"street":{"nullable":true,"type":"string","description":"Rua do cliente"},"number":{"nullable":true,"type":"string","description":"Número do endereço do cliente"},"complement":{"nullable":true,"type":"string","description":"Complemento do endereço do cliente"},"neighborhood":{"nullable":true,"type":"string","description":"Bairro do cliente"},"zipCode":{"type":"string","description":"CEP do cliente"},"city":{"nullable":true,"type":"string","description":"Cidade do cliente"},"state":{"nullable":true,"type":"string","description":"Estado do cliente"}},"required":["street","number","complement","neighborhood","zipCode","city","state"],"additionalProperties":false,"description":"Informações de endereço do cliente"}},"required":["id","name","document","email","telephone","telephone2","cellphone","address"],"additionalProperties":false,"description":"Informações do cliente"},"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"title":{"type":"string","description":"Título do produto"}},"required":["id","title"],"additionalProperties":false,"description":"Informações do produto"},"generatedByNewSystem":{"type":"boolean","description":"Gerado pelo novo sistema"}},"required":["document","source","destination","sale","client","product","generatedByNewSystem"],"additionalProperties":false,"description":"Item do documento fiscal"},"description":"Itens dos documentos fiscais"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","taxation":{"nbs":{"code":"1234567","description":"Descrição do código NBS"},"taxClassification":{"code":"1234567","description":"Descrição do código de classificação tributária"},"operationIndicator":{"code":"1234567","description":"Descrição do código de indicador de operação"}}},"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","taxation":{"nbs":{"code":"1234567","description":"Descrição do código NBS"},"taxClassification":{"code":"1234567","description":"Descrição do código de classificação tributária"},"operationIndicator":{"code":"1234567","description":"Descrição do código de indicador de operação"}}},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}}],"responses":{"200":{"description":"Listagem de transferências","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página"},"totalItems":{"type":"number","description":"Número total de items"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da transferência"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor da transferência"},"requestedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de solicitação da transferência"},"completedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de conclusão da transferência"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da transferência"},"status":{"type":"string","enum":["confirmed","canceled","returnedMessage","pending","awaitingBankReturn","inProgress","blocked","awaitingTransfer","inProcess","inQueue","failed","registeringInvoices"],"enumDescriptions":{"confirmed":"Confirmed","canceled":"Canceled","returnedMessage":"Returned message","pending":"Pending","awaitingBankReturn":"Awaiting bank return","inProgress":"In progress","blocked":"Blocked","awaitingTransfer":"Awaiting transfer","inProcess":"In process","inQueue":"In queue","failed":"Failed","registeringInvoices":"Registering invoices"},"description":"Status da transferência"},"details":{"nullable":true,"type":"string","description":"Detalhes da transferência"},"bankAccount":{"type":"object","properties":{"type":{"nullable":true,"type":"string","enum":["checkingAccount","savingsAccount"],"enumDescriptions":{"checkingAccount":"Checking account","savingsAccount":"Savings account"},"description":"Tipo da conta bancária"},"bankCode":{"type":"string","description":"Código do banco da conta bancária"},"agency":{"type":"string","description":"Agência da conta bancária"},"account":{"type":"string","description":"Conta da conta bancária"}},"required":["type","bankCode","agency","account"],"additionalProperties":false,"description":"Conta bancária de destino da transferência"}},"required":["id","value","requestedAt","completedAt","createdAt","status","details","bankAccount"],"additionalProperties":false,"description":"Item de transferência"},"description":"Itens das transferências"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do produto que se deseja obter as campanhas","schema":{"type":"string","description":"Id do produto que se deseja obter as campanhas"}}],"responses":{"200":{"description":"Lista de campanhas do produto","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da campanha"},"key":{"type":"string","description":"Chave da campanha"},"title":{"type":"string","description":"Título da campanha"},"url":{"type":"string","description":"URL da campanha"},"resultPerClick":{"type":"object","properties":{"affiliate":{"type":"number","description":"Resultado por click na campanha através de afiliados"},"producer":{"type":"number","description":"Resultado por click na campanha através de produtor"}},"required":["affiliate","producer"],"additionalProperties":false,"description":"Resultados por click de produtor e afiliado"},"isInfinityFunnel":{"type":"boolean","description":"Indica se o funil infinito está ativo para a campanha"},"isActive":{"type":"boolean","description":"Status de atividade da campanha"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da campanha"}},"required":["id","key","title","url","resultPerClick","isInfinityFunnel","isActive","createdAt"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual","sample":"1","example":"1"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página","sample":"20","example":"20"}}],"responses":{"200":{"description":"Lista de produtos do produtor","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"2","example":"2"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"20","example":"20"},"totalItems":{"type":"number","description":"Número total de items","sample":"29","example":"29"},"items":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Código do cupom","sample":"CUPOM123","example":"CUPOM123"},"description":{"type":"string","description":"Descrição do cupom","sample":"Cupom básico","example":"Cupom básico"},"value":{"type":"number","description":"Valor do desconto","sample":"10","example":"10"},"type":{"type":"string","enum":["value","percentage"],"enumDescriptions":{"value":"Valor","percentage":"Porcentagem"},"description":"Tipo de desconto","sample":"value","example":"value"},"quantity":{"type":"number","description":"Quantidade de cupons disponibilizados","sample":"1000","example":"1000"},"limitDate":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de validade do cupom","sample":"2018-03-20T16:24:47.180Z","example":"2018-03-20T16:24:47.180Z"},"products":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto","sample":"1000","example":"1000"},"title":{"type":"string","description":"Título do produto","sample":"Produto Simples","example":"Produto Simples"},"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do preço","sample":"BRL","example":"BRL"},"value":{"type":"number","description":"Valor do produto","sample":"10","example":"10"}},"required":["currency","value"],"additionalProperties":false,"description":"Preço do produto"},"priceWithDiscount":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda do preço","sample":"BRL","example":"BRL"},"value":{"type":"number","description":"Valor do produto","sample":"10","example":"10"}},"required":["currency","value"],"additionalProperties":false,"description":"Preço do produto"},"link":{"type":"string","description":"Link do produto com o cupom aplicado","sample":"https://linkdevenda/produto?cupom=CUPOM123","example":"https://linkdevenda/produto?cupom=CUPOM123"}},"required":["id","title","price","priceWithDiscount","link"],"additionalProperties":false,"description":"Detalhes do produto"},"description":"Produtos aos quais o cupom se aplica"}},"required":["code","description","value","type","quantity","limitDate","products"],"additionalProperties":false,"description":"Detalhes do cupom"},"description":"Cupons de produtos cadastrados na conta do produtor"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do produto que se deseja obter os detalhes","schema":{"type":"string","description":"Id do produto que se deseja obter os detalhes","sample":"47998","example":"47998"}}],"responses":{"200":{"description":"Detalhes do produto solicitado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto","sample":"47998","example":"47998"},"name":{"type":"string","description":"Nome do produto","sample":"Produto Digital Básico","example":"Produto Digital Básico"},"description":{"type":"string","description":"Descrição do produto","sample":"Produto digital básico para teste e validação do sistema.","example":"Produto digital básico para teste e validação do sistema."},"producerId":{"type":"string","description":"Id do produtor","sample":"1234","example":"1234"},"type":{"type":"string","enum":["digital","physical","service","ticket","ecommerce","package","project"],"enumDescriptions":{"digital":"Digital","physical":"Physical","service":"Service","ticket":"Ticket","ecommerce":"E-commerce","package":"Package","project":"Project"},"description":"Tipo do produto"},"status":{"type":"string","enum":["active","inactive"],"enumDescriptions":{"active":"Ativo","inactive":"Inativo"},"description":"Status do produto"},"author":{"type":"string","description":"Autor do produto","sample":"Eduzz","example":"Eduzz"},"moderation":{"type":"string","enum":["new","approved","pending","refused"],"enumDescriptions":{"new":"Novo","approved":"Aprovado","pending":"Pendente","refused":"Recusado"},"description":"Status de moderação do produto"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação do produto","sample":"2018-03-20T16:24:47.180Z","example":"2018-03-20T16:24:47.180Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da última atualização do produto","sample":"2023-05-15T18:46:44.647Z","example":"2023-05-15T18:46:44.647Z"},"payment":{"type":"object","properties":{"type":{"type":"string","enum":["oneTime","subscription","free","open"],"enumDescriptions":{"oneTime":"One-time","subscription":"Subscription","free":"Free","open":"Open"},"description":"Tipo de pagamento"},"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda usada no produto","sample":"BRL","example":"BRL"},"value":{"type":"number","description":"Valor do produto","sample":"100","example":"100"}},"required":["currency","value"],"additionalProperties":false,"description":"Preço do produto"},"methods":{"type":"object","properties":{"bankslip":{"type":"boolean","description":"Boleto disponível","sample":"true","example":"true"},"pix":{"type":"boolean","description":"PIX disponível","sample":"true","example":"true"},"card":{"type":"boolean","description":"Cartão de crédito disponível","sample":"true","example":"true"},"multipleCards":{"type":"boolean","description":"Número de cartões múltiplos permitidos","sample":"true","example":"true"}},"required":["bankslip","pix","card","multipleCards"],"additionalProperties":false,"description":"Métodos de pagamento disponíveis"}},"required":["type","price","methods"],"additionalProperties":false,"description":"Informações de pagamento do produto"},"imageUrl":{"type":"string","description":"URL da imagem do produto","sample":"https://cdn.eduzzcdn.com/xpto.jpg","example":"https://cdn.eduzzcdn.com/xpto.jpg"}},"required":["id","name","description","producerId","type","status","author","moderation","createdAt","updatedAt","payment","imageUrl"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual","sample":"1","example":"1"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página","sample":"20","example":"20"}}],"responses":{"200":{"description":"Lista de produtos do produtor","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"2","example":"2"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"20","example":"20"},"totalItems":{"type":"number","description":"Número total de items","sample":"29","example":"29"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto","sample":"47998","example":"47998"},"name":{"type":"string","description":"Nome do produto","sample":"Produto Digital Básico","example":"Produto Digital Básico"},"description":{"type":"string","description":"Descrição do produto","sample":"Produto digital básico para teste e validação do sistema.","example":"Produto digital básico para teste e validação do sistema."},"producerId":{"type":"string","description":"Id do produtor","sample":"1234","example":"1234"},"type":{"type":"string","enum":["digital","physical","service","ticket","ecommerce","package","project"],"enumDescriptions":{"digital":"Digital","physical":"Physical","service":"Service","ticket":"Ticket","ecommerce":"E-commerce","package":"Package","project":"Project"},"description":"Tipo do produto"},"status":{"type":"string","enum":["active","inactive"],"enumDescriptions":{"active":"Ativo","inactive":"Inativo"},"description":"Status do produto"},"author":{"type":"string","description":"Autor do produto","sample":"Eduzz","example":"Eduzz"},"moderation":{"type":"string","enum":["new","approved","pending","refused"],"enumDescriptions":{"new":"Novo","approved":"Aprovado","pending":"Pendente","refused":"Recusado"},"description":"Status de moderação do produto"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação do produto","sample":"2018-03-20T16:24:47.180Z","example":"2018-03-20T16:24:47.180Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da última atualização do produto","sample":"2023-05-15T18:46:44.647Z","example":"2023-05-15T18:46:44.647Z"},"payment":{"type":"object","properties":{"type":{"type":"string","enum":["oneTime","subscription","free","open"],"enumDescriptions":{"oneTime":"One-time","subscription":"Subscription","free":"Free","open":"Open"},"description":"Tipo de pagamento"},"price":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda usada no produto","sample":"BRL","example":"BRL"},"value":{"type":"number","description":"Valor do produto","sample":"100","example":"100"}},"required":["currency","value"],"additionalProperties":false,"description":"Preço do produto"},"methods":{"type":"object","properties":{"bankslip":{"type":"boolean","description":"Boleto disponível","sample":"true","example":"true"},"pix":{"type":"boolean","description":"PIX disponível","sample":"true","example":"true"},"card":{"type":"boolean","description":"Cartão de crédito disponível","sample":"true","example":"true"},"multipleCards":{"type":"boolean","description":"Número de cartões múltiplos permitidos","sample":"true","example":"true"}},"required":["bankslip","pix","card","multipleCards"],"additionalProperties":false,"description":"Métodos de pagamento disponíveis"}},"required":["type","price","methods"],"additionalProperties":false,"description":"Informações de pagamento do produto"},"imageUrl":{"type":"string","description":"URL da imagem do produto","sample":"https://cdn.eduzzcdn.com/xpto.jpg","example":"https://cdn.eduzzcdn.com/xpto.jpg"}},"required":["id","name","description","producerId","type","status","author","moderation","createdAt","updatedAt","payment","imageUrl"],"additionalProperties":false,"description":"Detalhe do produto"},"description":"Produtos cadastrados na conta do produtor"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do produto que se deseja obter as ofertas","schema":{"type":"string","description":"Id do produto que se deseja obter as ofertas"}}],"responses":{"200":{"description":"Lista de ofertas do produto","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da oferta"},"isDefault":{"type":"boolean","description":"Indica se a oferta é a oferta padrão do produto"},"name":{"type":"string","description":"Nome da oferta"},"isVisibleToAffiliates":{"type":"boolean","description":"Indica se a oferta está visível para afiliados"},"checkoutUrl":{"type":"string","description":"URL do checkout da oferta"},"defaultPrice":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Preço padrão da oferta"},"prices":{"type":"array","items":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Preço"},"description":"Lista de preços da oferta"}},"required":["id","isDefault","name","isVisibleToAffiliates","checkoutUrl","defaultPrice","prices"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do produto que se deseja obter os parceiros","schema":{"type":"string","description":"Id do produto que se deseja obter os parceiros"}}],"responses":{"200":{"description":"Lista de parceiros do produtor","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id do parceiro"},"name":{"type":"string","description":"Nome do parceiro"},"email":{"type":"string","description":"Email do parceiro"},"commission":{"type":"object","properties":{"type":{"type":"string","enum":["percentage","value"],"enumDescriptions":{"percentage":"Porcentagem","value":"Valor"},"description":"Tipo de comissão"},"value":{"type":"number","description":"Valor da comissão"},"onlyByAffiliate":{"type":"boolean","description":"Indica se a comissão é apenas por afiliado"}},"required":["type","value","onlyByAffiliate"],"additionalProperties":false,"description":"Detalhes da comissão do parceiro"},"permission":{"type":"object","properties":{"canManageAffiliates":{"type":"boolean","description":"Permissão para gerenciar afiliados"},"canRefund":{"type":"boolean","description":"Permissão para gerenciar reembolsos"},"canViewCustomerData":{"type":"boolean","description":"Permissão para visualizar dados dos clientes"}},"required":["canManageAffiliates","canRefund","canViewCustomerData"],"additionalProperties":false,"description":"Permissões do parceiro"}},"required":["id","name","email","commission","permission"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da venda que se deseja obter os detalhes","schema":{"type":"string","description":"Id da venda que se deseja obter os detalhes","sample":"123456","example":"123456"}}],"responses":{"200":{"description":"Detalhes da venda","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da venda"},"contractId":{"nullable":true,"type":"string","description":"Id do contrato da venda"},"status":{"type":"string","enum":["open","processing","paid","canceled","waitingRefund","refunded","duplicated","expired","recovering","waitingPayment","scheduled","negotiated"],"enumDescriptions":{"open":"Open","processing":"Processing","paid":"Paid","canceled":"Canceled","waitingRefund":"Waiting refund","refunded":"Refunded","duplicated":"Duplicated","expired":"Expired","recovering":"Recovering","waitingPayment":"Waiting payment","scheduled":"Scheduled","negotiated":"Negotiated"},"description":"Status da venda"},"grossGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho bruto da venda"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido da venda"},"partnersGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de parceiros da venda"},"affiliatesGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de afiliados da venda"},"fee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa da venda"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da venda"},"totalInterest":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total com juros da venda"},"installments":{"type":"number","description":"Número de parcelas da venda"},"alumyFee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa Alumy da venda"},"installmentSettlementFee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa de Liquidação do Parcelamento da venda"},"others":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Outras taxas da venda"},"currency":{"type":"string","description":"Moeda da venda"},"locale":{"type":"string","description":"Localidade da venda"},"dueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de vencimento da venda"},"paidAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de pagamento da venda"},"creditDate":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de crédito da venda"},"isInfiniteFunnel":{"type":"boolean","description":"Indica se a venda é de um funil infinito"},"recoveringStatus":{"type":"string","enum":["inactive","active","canceled"],"enumDescriptions":{"inactive":"Inativo","active":"Ativo","canceled":"Cancelado"},"description":"Status de recuperação da venda"},"tracker":{"nullable":true,"type":"string","description":"Rastreador da venda"},"tracker2":{"nullable":true,"type":"string","description":"Rastreador 2 da venda"},"tracker3":{"nullable":true,"type":"string","description":"Rastreador 3 da venda"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da venda"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da última atualização da venda"},"payment":{"type":"object","properties":{"method":{"type":"string","enum":["bankslip","creditCard","pix","combinedPayment","installmentBankslip","eWallet","eduzzBalance","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditCard":"Credit Card","pix":"Pix","combinedPayment":"Combined Payment","installmentBankslip":"Installment Bankslip","eWallet":"E-Wallet","eduzzBalance":"Eduzz Balance","unknown":"Unknown"},"description":"Método"},"detail":{"type":"string","enum":["bankslip","cefBankslip","creditCard","amexCreditCard","dinersCreditCard","discoverCreditCard","eloCreditCard","hipercardCreditCard","hiperCreditCard","jcbCreditCard","mastercardCreditCard","unionpayCreditCard","visaCreditCard","pagdividido","multipleCards","pix","automaticPix","combinedPayment","installmentBankslip","paypal","eduzzBalance","unknown"],"enumDescriptions":{"bankslip":"Bankslip","cefBankslip":"CEF Bankslip","creditCard":"Credit Card","amexCreditCard":"Amex Credit Card","dinersCreditCard":"Diners Credit Card","discoverCreditCard":"Discover Credit Card","eloCreditCard":"Elo Credit Card","hipercardCreditCard":"Hipercard Credit Card","hiperCreditCard":"Hiper Credit Card","jcbCreditCard":"JCB Credit Card","mastercardCreditCard":"Mastercard Credit Card","unionpayCreditCard":"UnionPay Credit Card","visaCreditCard":"Visa Credit Card","pagdividido":"PagDividido","multipleCards":"Multiple Cards","pix":"Pix","automaticPix":"Pix Automático","combinedPayment":"Combined Payment","installmentBankslip":"Installment Bankslip","paypal":"Paypal","eduzzBalance":"Eduzz Balance","unknown":"Unknown"},"description":"Detalhe"},"link":{"nullable":true,"type":"string","description":"URL de pagamento (ex.: checkout, boleto ou Pix)"}},"required":["method","detail","link"],"additionalProperties":false,"description":"Método de pagamento da venda"},"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"name":{"type":"string","description":"Nome do produto"},"type":{"type":"string","enum":["digital","physical","service","ticket","ecommerce","package","project"],"enumDescriptions":{"digital":"Digital","physical":"Physical","service":"Service","ticket":"Ticket","ecommerce":"E-commerce","package":"Package","project":"Project"},"description":"Tipo do produto"},"billingType":{"type":"string","enum":["recurrence","single","free","other","unknown"],"enumDescriptions":{"recurrence":"Recurrence","single":"Single","free":"Free","other":"Other","unknown":"Unknown"},"description":"Tipo de cobrança"},"sku":{"nullable":true,"type":"string","description":"Sku do produto"}},"required":["id","name","type","billingType","sku"],"additionalProperties":false,"description":"Dados do produto"},"refund":{"nullable":true,"type":"object","properties":{"type":{"type":"string","enum":["common","partial"],"enumDescriptions":{"common":"Common","partial":"Partial"},"description":"Tipo do reembolso"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor do reembolso"},"partialValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor parcial do reembolso"},"refundedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do reembolso"},"requestedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de solicitação do reembolso"},"motive":{"nullable":true,"type":"string","description":"Motivo da solicitação do reembolso"},"requesterName":{"nullable":true,"type":"string","description":"Nome do solicitante do reembolso"}},"required":["type","value","partialValue","refundedAt","requestedAt","motive","requesterName"],"additionalProperties":false,"description":"Dados do reembolso"},"affiliate":{"nullable":true,"type":"object","properties":{"id":{"type":"string","description":"Id do afiliado"},"name":{"type":"string","description":"Nome do afiliado"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do afiliado"},"recipient":{"type":"object","properties":{"id":{"type":"string","description":"Id do recebedor"},"name":{"type":"string","description":"Nome do recebedor"},"email":{"type":"string","description":"Email do recebedor"},"document":{"type":"string","description":"Documento do recebedor"},"phone":{"type":"string","description":"Telefone do recebedor"}},"required":["id","name","email","document","phone"],"additionalProperties":false,"description":"Dados do recebedor"},"buyer":{"type":"object","properties":{"id":{"type":"string","description":"Id do comprador"},"name":{"type":"string","description":"Nome do comprador"},"email":{"type":"string","description":"Email do comprador"},"document":{"type":"string","description":"Documento do comprador"},"phone":{"type":"string","description":"Telefone do comprador"},"phone2":{"nullable":true,"type":"string","description":"Telefone 2 do comprador"},"phone3":{"nullable":true,"type":"string","description":"Telefone 3 do comprador"},"address":{"type":"object","properties":{"zipCode":{"type":"string","description":"Cep do endereço"},"street":{"type":"string","description":"Rua do endereço"},"number":{"nullable":true,"type":"string","description":"Número do endereço"},"complement":{"nullable":true,"type":"string","description":"Complemeto do endereço"},"neighborhood":{"type":"string","description":"Bairro do endereço"},"city":{"type":"string","description":"Cidade do endereço"},"state":{"type":"string","description":"Estado do endereço"}},"required":["zipCode","street","number","complement","neighborhood","city","state"],"additionalProperties":false,"description":"Dados do endereço"}},"required":["id","name","email","document","phone","phone2","phone3","address"],"additionalProperties":false,"description":"Dados do comprador"},"producer":{"type":"object","properties":{"id":{"type":"string","description":"Id do produtor"},"name":{"type":"string","description":"Nome do produtor"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do produtor"},"affiliates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do afiliado"},"name":{"type":"string","description":"Nome do afiliado"},"email":{"type":"string","description":"Email do afiliado"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido do afiliado"}},"required":["id","name","email","netGain"],"additionalProperties":false,"description":"Afiliado"},"description":"Dados dos afiliados"},"partners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do parceiro"},"name":{"type":"string","description":"Nome do parceiro"},"email":{"type":"string","description":"Email do parceiro"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido do parceiro"}},"required":["id","name","email","netGain"],"additionalProperties":false,"description":"Parceiro"},"description":"Dados dos parceiros"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do item"},"productId":{"type":"string","description":"Id do produto do item"},"description":{"type":"string","description":"Descrição do item"},"unitValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor unitário do item"},"quantity":{"type":"number","description":"Quantidade do item"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor total do item"},"discount":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Desconto do item"},"freightType":{"nullable":true,"type":"string","description":"Tipo de frete do item"},"freightDeadline":{"nullable":true,"type":"string","description":"Prazo de entrega do item"},"trackingCode":{"nullable":true,"type":"string","description":"Código de rastreamento do item"}},"required":["id","productId","description","unitValue","quantity","value","discount","freightType","freightDeadline","trackingCode"],"additionalProperties":false,"description":"Item"},"description":"Itens da venda"},"offer":{"type":"object","properties":{"name":{"nullable":true,"type":"string","description":"Nome da oferta"}},"required":["name"],"additionalProperties":false,"description":"Dados da oferta"},"utm":{"nullable":true,"type":"object","properties":{"source":{"nullable":true,"type":"string","description":"Fonte utm"},"campaign":{"nullable":true,"type":"string","description":"Campanha utm"},"medium":{"nullable":true,"type":"string","description":"Meio utm"},"content":{"nullable":true,"type":"string","description":"Conteúdo utm"},"term":{"nullable":true,"type":"string","description":"Termo utm"}},"required":["source","campaign","medium","content","term"],"additionalProperties":false,"description":"Dados dos parâmetros utm recebidos no checkout por queryString"},"orderBump":{"type":"object","properties":{"has":{"type":"boolean","description":"Indica se a fatura é parte de uma venda com OrderBump"},"isMainSale":{"type":"boolean","description":"Indica se a fatura é a principal (não é um OrderBump)"},"mainSaleId":{"nullable":true,"type":"number","description":"ID da fatura principal, caso a atual seja um OrderBump"}},"required":["has","isMainSale","mainSaleId"],"additionalProperties":false,"description":"Dados relacionados à OrderBump"}},"required":["id","contractId","status","grossGain","netGain","partnersGain","affiliatesGain","fee","total","totalInterest","installments","alumyFee","installmentSettlementFee","others","currency","locale","dueDate","paidAt","creditDate","isInfiniteFunnel","recoveringStatus","tracker","tracker2","tracker3","createdAt","updatedAt","payment","product","refund","affiliate","recipient","buyer","producer","affiliates","partners","items","offer","utm","orderBump"],"additionalProperties":false},"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},"installmentSettlementFee":{"currency":"BRL","value":1.99},"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":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da venda"},"contractId":{"nullable":true,"type":"string","description":"Id do contrato da venda"},"status":{"type":"string","enum":["open","processing","paid","canceled","waitingRefund","refunded","duplicated","expired","recovering","waitingPayment","scheduled","negotiated"],"enumDescriptions":{"open":"Open","processing":"Processing","paid":"Paid","canceled":"Canceled","waitingRefund":"Waiting refund","refunded":"Refunded","duplicated":"Duplicated","expired":"Expired","recovering":"Recovering","waitingPayment":"Waiting payment","scheduled":"Scheduled","negotiated":"Negotiated"},"description":"Status da venda"},"grossGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho bruto da venda"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido da venda"},"partnersGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de parceiros da venda"},"affiliatesGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de afiliados da venda"},"fee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa da venda"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da venda"},"totalInterest":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total com juros da venda"},"installments":{"type":"number","description":"Número de parcelas da venda"},"alumyFee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa Alumy da venda"},"installmentSettlementFee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa de Liquidação do Parcelamento da venda"},"others":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Outras taxas da venda"},"currency":{"type":"string","description":"Moeda da venda"},"locale":{"type":"string","description":"Localidade da venda"},"dueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de vencimento da venda"},"paidAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de pagamento da venda"},"creditDate":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de crédito da venda"},"isInfiniteFunnel":{"type":"boolean","description":"Indica se a venda é de um funil infinito"},"recoveringStatus":{"type":"string","enum":["inactive","active","canceled"],"enumDescriptions":{"inactive":"Inativo","active":"Ativo","canceled":"Cancelado"},"description":"Status de recuperação da venda"},"tracker":{"nullable":true,"type":"string","description":"Rastreador da venda"},"tracker2":{"nullable":true,"type":"string","description":"Rastreador 2 da venda"},"tracker3":{"nullable":true,"type":"string","description":"Rastreador 3 da venda"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da venda"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da última atualização da venda"},"payment":{"type":"object","properties":{"method":{"type":"string","enum":["bankslip","creditCard","pix","combinedPayment","installmentBankslip","eWallet","eduzzBalance","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditCard":"Credit Card","pix":"Pix","combinedPayment":"Combined Payment","installmentBankslip":"Installment Bankslip","eWallet":"E-Wallet","eduzzBalance":"Eduzz Balance","unknown":"Unknown"},"description":"Método"},"detail":{"type":"string","enum":["bankslip","cefBankslip","creditCard","amexCreditCard","dinersCreditCard","discoverCreditCard","eloCreditCard","hipercardCreditCard","hiperCreditCard","jcbCreditCard","mastercardCreditCard","unionpayCreditCard","visaCreditCard","pagdividido","multipleCards","pix","automaticPix","combinedPayment","installmentBankslip","paypal","eduzzBalance","unknown"],"enumDescriptions":{"bankslip":"Bankslip","cefBankslip":"CEF Bankslip","creditCard":"Credit Card","amexCreditCard":"Amex Credit Card","dinersCreditCard":"Diners Credit Card","discoverCreditCard":"Discover Credit Card","eloCreditCard":"Elo Credit Card","hipercardCreditCard":"Hipercard Credit Card","hiperCreditCard":"Hiper Credit Card","jcbCreditCard":"JCB Credit Card","mastercardCreditCard":"Mastercard Credit Card","unionpayCreditCard":"UnionPay Credit Card","visaCreditCard":"Visa Credit Card","pagdividido":"PagDividido","multipleCards":"Multiple Cards","pix":"Pix","automaticPix":"Pix Automático","combinedPayment":"Combined Payment","installmentBankslip":"Installment Bankslip","paypal":"Paypal","eduzzBalance":"Eduzz Balance","unknown":"Unknown"},"description":"Detalhe"},"link":{"nullable":true,"type":"string","description":"URL de pagamento (ex.: checkout, boleto ou Pix)"}},"required":["method","detail","link"],"additionalProperties":false,"description":"Método de pagamento da venda"},"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"name":{"type":"string","description":"Nome do produto"},"type":{"type":"string","enum":["digital","physical","service","ticket","ecommerce","package","project"],"enumDescriptions":{"digital":"Digital","physical":"Physical","service":"Service","ticket":"Ticket","ecommerce":"E-commerce","package":"Package","project":"Project"},"description":"Tipo do produto"},"billingType":{"type":"string","enum":["recurrence","single","free","other","unknown"],"enumDescriptions":{"recurrence":"Recurrence","single":"Single","free":"Free","other":"Other","unknown":"Unknown"},"description":"Tipo de cobrança"},"sku":{"nullable":true,"type":"string","description":"Sku do produto"}},"required":["id","name","type","billingType","sku"],"additionalProperties":false,"description":"Dados do produto"},"refund":{"nullable":true,"type":"object","properties":{"type":{"type":"string","enum":["common","partial"],"enumDescriptions":{"common":"Common","partial":"Partial"},"description":"Tipo do reembolso"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor do reembolso"},"partialValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor parcial do reembolso"},"refundedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do reembolso"},"requestedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de solicitação do reembolso"},"motive":{"nullable":true,"type":"string","description":"Motivo da solicitação do reembolso"},"requesterName":{"nullable":true,"type":"string","description":"Nome do solicitante do reembolso"}},"required":["type","value","partialValue","refundedAt","requestedAt","motive","requesterName"],"additionalProperties":false,"description":"Dados do reembolso"},"affiliate":{"nullable":true,"type":"object","properties":{"id":{"type":"string","description":"Id do afiliado"},"name":{"type":"string","description":"Nome do afiliado"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do afiliado"},"recipient":{"type":"object","properties":{"id":{"type":"string","description":"Id do recebedor"},"name":{"type":"string","description":"Nome do recebedor"},"email":{"type":"string","description":"Email do recebedor"},"document":{"type":"string","description":"Documento do recebedor"},"phone":{"type":"string","description":"Telefone do recebedor"}},"required":["id","name","email","document","phone"],"additionalProperties":false,"description":"Dados do recebedor"},"buyer":{"type":"object","properties":{"id":{"type":"string","description":"Id do comprador"},"name":{"type":"string","description":"Nome do comprador"},"email":{"type":"string","description":"Email do comprador"},"document":{"type":"string","description":"Documento do comprador"},"phone":{"type":"string","description":"Telefone do comprador"},"phone2":{"nullable":true,"type":"string","description":"Telefone 2 do comprador"},"phone3":{"nullable":true,"type":"string","description":"Telefone 3 do comprador"},"address":{"type":"object","properties":{"zipCode":{"type":"string","description":"Cep do endereço"},"street":{"type":"string","description":"Rua do endereço"},"number":{"nullable":true,"type":"string","description":"Número do endereço"},"complement":{"nullable":true,"type":"string","description":"Complemeto do endereço"},"neighborhood":{"type":"string","description":"Bairro do endereço"},"city":{"type":"string","description":"Cidade do endereço"},"state":{"type":"string","description":"Estado do endereço"}},"required":["zipCode","street","number","complement","neighborhood","city","state"],"additionalProperties":false,"description":"Dados do endereço"}},"required":["id","name","email","document","phone","phone2","phone3","address"],"additionalProperties":false,"description":"Dados do comprador"},"producer":{"type":"object","properties":{"id":{"type":"string","description":"Id do produtor"},"name":{"type":"string","description":"Nome do produtor"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do produtor"},"affiliates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do afiliado"},"name":{"type":"string","description":"Nome do afiliado"},"email":{"type":"string","description":"Email do afiliado"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido do afiliado"}},"required":["id","name","email","netGain"],"additionalProperties":false,"description":"Afiliado"},"description":"Dados dos afiliados"},"partners":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do parceiro"},"name":{"type":"string","description":"Nome do parceiro"},"email":{"type":"string","description":"Email do parceiro"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido do parceiro"}},"required":["id","name","email","netGain"],"additionalProperties":false,"description":"Parceiro"},"description":"Dados dos parceiros"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do item"},"productId":{"type":"string","description":"Id do produto do item"},"description":{"type":"string","description":"Descrição do item"},"unitValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor unitário do item"},"quantity":{"type":"number","description":"Quantidade do item"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor total do item"},"discount":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Desconto do item"},"freightType":{"nullable":true,"type":"string","description":"Tipo de frete do item"},"freightDeadline":{"nullable":true,"type":"string","description":"Prazo de entrega do item"},"trackingCode":{"nullable":true,"type":"string","description":"Código de rastreamento do item"}},"required":["id","productId","description","unitValue","quantity","value","discount","freightType","freightDeadline","trackingCode"],"additionalProperties":false,"description":"Item"},"description":"Itens da venda"},"offer":{"type":"object","properties":{"name":{"nullable":true,"type":"string","description":"Nome da oferta"}},"required":["name"],"additionalProperties":false,"description":"Dados da oferta"},"utm":{"nullable":true,"type":"object","properties":{"source":{"nullable":true,"type":"string","description":"Fonte utm"},"campaign":{"nullable":true,"type":"string","description":"Campanha utm"},"medium":{"nullable":true,"type":"string","description":"Meio utm"},"content":{"nullable":true,"type":"string","description":"Conteúdo utm"},"term":{"nullable":true,"type":"string","description":"Termo utm"}},"required":["source","campaign","medium","content","term"],"additionalProperties":false,"description":"Dados dos parâmetros utm recebidos no checkout por queryString"},"orderBump":{"type":"object","properties":{"has":{"type":"boolean","description":"Indica se a fatura é parte de uma venda com OrderBump"},"isMainSale":{"type":"boolean","description":"Indica se a fatura é a principal (não é um OrderBump)"},"mainSaleId":{"nullable":true,"type":"number","description":"ID da fatura principal, caso a atual seja um OrderBump"}},"required":["has","isMainSale","mainSaleId"],"additionalProperties":false,"description":"Dados relacionados à OrderBump"}},"required":["id","contractId","status","grossGain","netGain","partnersGain","affiliatesGain","fee","total","totalInterest","installments","alumyFee","installmentSettlementFee","others","currency","locale","dueDate","paidAt","creditDate","isInfiniteFunnel","recoveringStatus","tracker","tracker2","tracker3","createdAt","updatedAt","payment","product","refund","affiliate","recipient","buyer","producer","affiliates","partners","items","offer","utm","orderBump"],"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data de início das vendas","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início das vendas","required":true}},{"name":"endDate","in":"query","required":true,"description":"Data de término das vendas","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término das vendas","required":true}},{"name":"referenceDate","in":"query","required":true,"description":"Campo de data de referência para consultar as vendas","schema":{"type":"string","enum":["dueDate","paidAt","createdAt","updatedAt"],"enumDescriptions":{"dueDate":"DueDate","paidAt":"PaidAt","createdAt":"CreatedAt","updatedAt":"UpdatedAt"},"description":"Campo de data de referência para consultar as vendas"}},{"name":"contractId","in":"query","required":true,"description":"Id do contrato","schema":{"type":"number","description":"Id do contrato"}},{"name":"status","in":"query","required":true,"description":"Status da venda","schema":{"type":"string","enum":["open","processing","paid","canceled","waitingRefund","refunded","duplicated","expired","recovering","waitingPayment","scheduled","negotiated"],"enumDescriptions":{"open":"Open","processing":"Processing","paid":"Paid","canceled":"Canceled","waitingRefund":"Waiting refund","refunded":"Refunded","duplicated":"Duplicated","expired":"Expired","recovering":"Recovering","waitingPayment":"Waiting payment","scheduled":"Scheduled","negotiated":"Negotiated"},"description":"Status da venda"}},{"name":"productId","in":"query","required":true,"description":"Id do produto","schema":{"type":"number","description":"Id do produto"}},{"name":"affiliateId","in":"query","required":true,"description":"Id do afiliado","schema":{"type":"number","description":"Id do afiliado"}},{"name":"buyerEmail","in":"query","required":true,"description":"Email do comprador","schema":{"type":"string","description":"Email do comprador"}},{"name":"buyerDocument","in":"query","required":true,"description":"CPF ou CNPJ do comprador","schema":{"type":"string","description":"CPF ou CNPJ do comprador"}}],"responses":{"200":{"description":"Lista de vendas","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página"},"totalItems":{"type":"number","description":"Número total de items"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da venda"},"contractId":{"nullable":true,"type":"string","description":"Id do contrato da venda"},"status":{"type":"string","enum":["open","processing","paid","canceled","waitingRefund","refunded","duplicated","expired","recovering","waitingPayment","scheduled","negotiated"],"enumDescriptions":{"open":"Open","processing":"Processing","paid":"Paid","canceled":"Canceled","waitingRefund":"Waiting refund","refunded":"Refunded","duplicated":"Duplicated","expired":"Expired","recovering":"Recovering","waitingPayment":"Waiting payment","scheduled":"Scheduled","negotiated":"Negotiated"},"description":"Status da venda"},"grossGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho bruto da venda"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido da venda"},"partnersGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de parceiros da venda"},"affiliatesGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de afiliados da venda"},"fee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa da venda"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da venda"},"totalInterest":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total com juros da venda"},"installments":{"type":"number","description":"Número de parcelas da venda"},"alumyFee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa Alumy da venda"},"installmentSettlementFee":{"nullable":true,"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa de Liquidação do Parcelamento da venda"},"others":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Outras taxas da venda"},"currency":{"type":"string","description":"Moeda da venda"},"locale":{"type":"string","description":"Localidade da venda"},"dueDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de vencimento da venda"},"paidAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de pagamento da venda"},"creditDate":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de crédito da venda"},"isInfiniteFunnel":{"type":"boolean","description":"Indica se a venda é de um funil infinito"},"recoveringStatus":{"type":"string","enum":["inactive","active","canceled"],"enumDescriptions":{"inactive":"Inativo","active":"Ativo","canceled":"Cancelado"},"description":"Status de recuperação da venda"},"tracker":{"nullable":true,"type":"string","description":"Rastreador da venda"},"tracker2":{"nullable":true,"type":"string","description":"Rastreador 2 da venda"},"tracker3":{"nullable":true,"type":"string","description":"Rastreador 3 da venda"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da venda"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da última atualização da venda"},"payment":{"type":"object","properties":{"method":{"type":"string","enum":["bankslip","creditCard","pix","combinedPayment","installmentBankslip","eWallet","eduzzBalance","unknown"],"enumDescriptions":{"bankslip":"Bankslip","creditCard":"Credit Card","pix":"Pix","combinedPayment":"Combined Payment","installmentBankslip":"Installment Bankslip","eWallet":"E-Wallet","eduzzBalance":"Eduzz Balance","unknown":"Unknown"},"description":"Método"},"detail":{"type":"string","enum":["bankslip","cefBankslip","creditCard","amexCreditCard","dinersCreditCard","discoverCreditCard","eloCreditCard","hipercardCreditCard","hiperCreditCard","jcbCreditCard","mastercardCreditCard","unionpayCreditCard","visaCreditCard","pagdividido","multipleCards","pix","automaticPix","combinedPayment","installmentBankslip","paypal","eduzzBalance","unknown"],"enumDescriptions":{"bankslip":"Bankslip","cefBankslip":"CEF Bankslip","creditCard":"Credit Card","amexCreditCard":"Amex Credit Card","dinersCreditCard":"Diners Credit Card","discoverCreditCard":"Discover Credit Card","eloCreditCard":"Elo Credit Card","hipercardCreditCard":"Hipercard Credit Card","hiperCreditCard":"Hiper Credit Card","jcbCreditCard":"JCB Credit Card","mastercardCreditCard":"Mastercard Credit Card","unionpayCreditCard":"UnionPay Credit Card","visaCreditCard":"Visa Credit Card","pagdividido":"PagDividido","multipleCards":"Multiple Cards","pix":"Pix","automaticPix":"Pix Automático","combinedPayment":"Combined Payment","installmentBankslip":"Installment Bankslip","paypal":"Paypal","eduzzBalance":"Eduzz Balance","unknown":"Unknown"},"description":"Detalhe"},"link":{"nullable":true,"type":"string","description":"URL de pagamento (ex.: checkout, boleto ou Pix)"}},"required":["method","detail","link"],"additionalProperties":false,"description":"Método de pagamento da venda"},"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"name":{"type":"string","description":"Nome do produto"},"type":{"type":"string","enum":["digital","physical","service","ticket","ecommerce","package","project"],"enumDescriptions":{"digital":"Digital","physical":"Physical","service":"Service","ticket":"Ticket","ecommerce":"E-commerce","package":"Package","project":"Project"},"description":"Tipo do produto"},"billingType":{"type":"string","enum":["recurrence","single","free","other","unknown"],"enumDescriptions":{"recurrence":"Recurrence","single":"Single","free":"Free","other":"Other","unknown":"Unknown"},"description":"Tipo de cobrança"},"sku":{"nullable":true,"type":"string","description":"Sku do produto"}},"required":["id","name","type","billingType","sku"],"additionalProperties":false,"description":"Dados do produto"},"refund":{"nullable":true,"type":"object","properties":{"type":{"type":"string","enum":["common","partial"],"enumDescriptions":{"common":"Common","partial":"Partial"},"description":"Tipo do reembolso"},"value":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor do reembolso"},"partialValue":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Valor parcial do reembolso"},"refundedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data do reembolso"}},"required":["type","value","partialValue","refundedAt"],"additionalProperties":false,"description":"Dados do reembolso"},"affiliate":{"nullable":true,"type":"object","properties":{"id":{"type":"string","description":"Id do afiliado"},"name":{"type":"string","description":"Nome do afiliado"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do afiliado"},"recipient":{"type":"object","properties":{"id":{"type":"string","description":"Id do recebedor"},"name":{"type":"string","description":"Nome do recebedor"},"email":{"type":"string","description":"Email do recebedor"},"document":{"type":"string","description":"Documento do recebedor"},"phone":{"type":"string","description":"Telefone do recebedor"}},"required":["id","name","email","document","phone"],"additionalProperties":false,"description":"Dados do recebedor"},"buyer":{"type":"object","properties":{"id":{"type":"string","description":"Id do comprador"},"name":{"type":"string","description":"Nome do comprador"},"email":{"type":"string","description":"Email do comprador"},"document":{"type":"string","description":"Documento do comprador"},"phone":{"type":"string","description":"Telefone do comprador"}},"required":["id","name","email","document","phone"],"additionalProperties":false,"description":"Dados do comprador"},"producer":{"type":"object","properties":{"id":{"type":"string","description":"Id do produtor"},"name":{"type":"string","description":"Nome do produtor"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do produtor"},"offer":{"type":"object","properties":{"name":{"nullable":true,"type":"string","description":"Nome da oferta"}},"required":["name"],"additionalProperties":false,"description":"Dados da oferta"},"utm":{"nullable":true,"type":"object","properties":{"source":{"nullable":true,"type":"string","description":"Fonte utm"},"campaign":{"nullable":true,"type":"string","description":"Campanha utm"},"medium":{"nullable":true,"type":"string","description":"Meio utm"},"content":{"nullable":true,"type":"string","description":"Conteúdo utm"},"term":{"nullable":true,"type":"string","description":"Termo utm"}},"required":["source","campaign","medium","content","term"],"additionalProperties":false,"description":"Dados dos parâmetros utm recebidos no checkout por queryString"},"orderBump":{"type":"object","properties":{"has":{"type":"boolean","description":"Indica se a fatura é parte de uma venda com OrderBump"},"isMainSale":{"type":"boolean","description":"Indica se a fatura é a principal (não é um OrderBump)"},"mainSaleId":{"nullable":true,"type":"number","description":"ID da fatura principal, caso a atual seja um OrderBump"}},"required":["has","isMainSale","mainSaleId"],"additionalProperties":false,"description":"Dados relacionados à OrderBump"}},"required":["id","contractId","status","grossGain","netGain","partnersGain","affiliatesGain","fee","total","totalInterest","installments","alumyFee","installmentSettlementFee","others","currency","locale","dueDate","paidAt","creditDate","isInfiniteFunnel","recoveringStatus","tracker","tracker2","tracker3","createdAt","updatedAt","payment","product","refund","affiliate","recipient","buyer","producer","offer","utm","orderBump"],"additionalProperties":false,"description":"Item de venda"},"description":"Itens de venda"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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},"installmentSettlementFee":{"currency":"BRL","value":1.99},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"startDate","in":"query","required":true,"description":"Data de início dos chargebacks","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início dos chargebacks","required":true}},{"name":"endDate","in":"query","required":true,"description":"Data de término dos chargebacks","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término dos chargebacks","required":true}},{"name":"id","in":"query","required":true,"description":"Id da venda","schema":{"type":"number","description":"Id da venda"}},{"name":"chargebackStatus","in":"query","required":true,"description":"Status do chargeback","schema":{"type":"string","enum":["new","won","lost","waitingDocuments","inAnalysis"],"enumDescriptions":{"new":"New","won":"Won","lost":"Lost","waitingDocuments":"Waiting documents","inAnalysis":"In analysis"},"description":"Status do chargeback"}},{"name":"buyerEmail","in":"query","required":true,"description":"Email do comprador","schema":{"type":"string","description":"Email do comprador"}}],"responses":{"200":{"description":"Lista de vendas","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas"},"page":{"type":"number","description":"Página atual"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página"},"totalItems":{"type":"number","description":"Número total de items"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da venda"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da venda"},"chargeback":{"type":"object","properties":{"requestedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de solicitação do chargeback"},"limitDate":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data limite do chargeback"},"documentsUploadedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de upload dos documentos comprovantes do chargeback"},"status":{"type":"string","enum":["new","won","lost","waitingDocuments","inAnalysis"],"enumDescriptions":{"new":"New","won":"Won","lost":"Lost","waitingDocuments":"Waiting documents","inAnalysis":"In analysis"},"description":"Status do chargeback"}},"required":["requestedAt","limitDate","documentsUploadedAt","status"],"additionalProperties":false,"description":"Dados do chargeback"},"affiliate":{"nullable":true,"type":"object","properties":{"id":{"type":"string","description":"Id do afiliado"},"name":{"type":"string","description":"Nome do afiliado"}},"required":["id","name"],"additionalProperties":false,"description":"Dados do afiliado"},"product":{"type":"object","properties":{"id":{"type":"string","description":"Id do produto"},"name":{"type":"string","description":"Nome do produto"},"type":{"type":"string","enum":["digital","physical","service","ticket","ecommerce","package","project"],"enumDescriptions":{"digital":"Digital","physical":"Physical","service":"Service","ticket":"Ticket","ecommerce":"E-commerce","package":"Package","project":"Project"},"description":"Tipo do produto"},"sku":{"nullable":true,"type":"string","description":"Sku do produto"}},"required":["id","name","type","sku"],"additionalProperties":false,"description":"Dados do produto"},"buyer":{"type":"object","properties":{"id":{"type":"string","description":"Id do comprador"},"name":{"type":"string","description":"Nome do comprador"},"email":{"type":"string","description":"Email do comprador"},"document":{"type":"string","description":"Documento do comprador"},"phone":{"type":"string","description":"Telefone do comprador"}},"required":["id","name","email","document","phone"],"additionalProperties":false,"description":"Dados do comprador"}},"required":["id","total","chargeback","affiliate","product","buyer"],"additionalProperties":false,"description":"Item de venda"},"description":"Itens de venda"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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":true,"description":"Data de início das vendas","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de início das vendas","required":true}},{"name":"endDate","in":"query","required":true,"description":"Data de término das vendas","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de término das vendas","required":true}},{"name":"contractId","in":"query","required":true,"description":"Id do contrato","schema":{"type":"number","description":"Id do contrato"}},{"name":"productId","in":"query","required":true,"description":"Id do produto","schema":{"type":"number","description":"Id do produto"}},{"name":"affiliateId","in":"query","required":true,"description":"Id do afiliado","schema":{"type":"number","description":"Id do afiliado"}},{"name":"status","in":"query","required":true,"description":"Status da venda","schema":{"type":"string","enum":["open","processing","paid","canceled","waitingRefund","refunded","duplicated","expired","recovering","waitingPayment","scheduled","negotiated"],"enumDescriptions":{"open":"Open","processing":"Processing","paid":"Paid","canceled":"Canceled","waitingRefund":"Waiting refund","refunded":"Refunded","duplicated":"Duplicated","expired":"Expired","recovering":"Recovering","waitingPayment":"Waiting payment","scheduled":"Scheduled","negotiated":"Negotiated"},"description":"Status da venda"}}],"responses":{"200":{"description":"Resumo das vendas","content":{"application/json":{"schema":{"type":"object","properties":{"discount":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Descontos da venda"},"grossGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho bruto da venda"},"netGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganho líquido da venda"},"partnersGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de parceiros da venda"},"affiliatesGain":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Ganhos de afiliados da venda"},"fee":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa da venda"},"installmentSettlementFee":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Taxa de Liquidação do Parcelamento somada para o período"},"others":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Outras taxas da venda"},"total":{"type":"object","properties":{"currency":{"type":"string","description":"Moeda"},"value":{"type":"number","description":"Valor"}},"required":["currency","value"],"additionalProperties":false,"description":"Total da venda"}},"required":["discount","grossGain","netGain","partnersGain","affiliatesGain","fee","installmentSettlementFee","others","total"],"additionalProperties":false},"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},"installmentSettlementFee":{"currency":"BRL","value":1.99},"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","in":"path","required":true,"description":"Id do comentário","schema":{"type":"string","description":"Id do comentário","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"isFixed":{"type":"boolean","description":"Se está fixado ou não","sample":"true","required":false,"example":"true"},"isApproved":{"type":"boolean","description":"Se está aprovado ou não","sample":"false","required":false,"example":"false"},"isRead":{"type":"boolean","description":"Se está lido ou não","sample":"true","required":false,"example":"true"},"isFavorite":{"type":"boolean","description":"Se é favorito ou não","sample":"false","required":false,"example":"false"}},"additionalProperties":false}}}},"responses":{"204":{"description":"Comentário alterado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id do comentário","schema":{"type":"string","description":"Id do comentário","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Dados do comentário","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do comentário","sample":"12345","example":"12345"},"text":{"type":"string","description":"Texto do comentário","sample":"Esse é um comentário","example":"Esse é um comentário"},"isRead":{"type":"boolean","description":"Comentário lido ou não lido","sample":"true","example":"true"},"isFavorite":{"type":"boolean","description":"Comentário favoritado ou não favoritado","sample":"false","example":"false"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação do comentário","sample":"2023-04-28T20:47:32Z","example":"2023-04-28T20:47:32Z"},"isFixed":{"type":"boolean","description":"Comentário está fixado ou não fixado","sample":"true","example":"true"},"status":{"type":"string","enum":["approved","rejected","inModeration"],"enumDescriptions":{"approved":"Aprovado","rejected":"Reprovado","inModeration":"Em moderação"},"description":"Status do comentário","sample":"rejected","example":"rejected"},"type":{"type":"string","enum":["html","text"],"enumDescriptions":{"html":"Formato HTML","text":"Formato texto"},"description":"Formato do comentário"},"author":{"type":"string","description":"Autor do comentário","sample":"João Neves","example":"João Neves"},"lessonId":{"type":"number","description":"Aula que o comentário pertence","sample":"54321","example":"54321"},"isAnswered":{"type":"boolean","description":"Comentário respondido ou não respondido","sample":"true","example":"true"}},"required":["id","text","isRead","isFavorite","createdAt","isFixed","status","type","author","lessonId","isAnswered"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do comentário","sample":"12345","example":"12345"},"text":{"type":"string","description":"Texto do comentário","sample":"Esse é um comentário","example":"Esse é um comentário"},"isRead":{"type":"boolean","description":"Comentário lido ou não lido","sample":"true","example":"true"},"isFavorite":{"type":"boolean","description":"Comentário favoritado ou não favoritado","sample":"false","example":"false"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação do comentário","sample":"2023-04-28T20:47:32Z","example":"2023-04-28T20:47:32Z"},"isFixed":{"type":"boolean","description":"Comentário está fixado ou não fixado","sample":"true","example":"true"},"status":{"type":"string","enum":["approved","rejected","inModeration"],"enumDescriptions":{"approved":"Aprovado","rejected":"Reprovado","inModeration":"Em moderação"},"description":"Status do comentário","sample":"rejected","example":"rejected"},"type":{"type":"string","enum":["html","text"],"enumDescriptions":{"html":"Formato HTML","text":"Formato texto"},"description":"Formato do comentário"},"author":{"type":"string","description":"Autor do comentário","sample":"João Neves","example":"João Neves"},"lessonId":{"type":"number","description":"Aula que o comentário pertence","sample":"54321","example":"54321"},"isAnswered":{"type":"boolean","description":"Comentário respondido ou não respondido","sample":"true","example":"true"}},"required":["id","text","isRead","isFavorite","createdAt","isFixed","status","type","author","lessonId","isAnswered"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do comentário","schema":{"type":"string","description":"Id do comentário","sample":"12345","example":"12345"}}],"responses":{"204":{"description":"Comentário excluído com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id da resposta","schema":{"type":"string","description":"Id da resposta","sample":"12345","example":"12345"}}],"responses":{"204":{"description":"Exclusão de resposta","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Resposta não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual","sample":"1","required":true,"example":"1"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página","sample":"10","required":true,"example":"10"}},{"name":"courseId","in":"query","required":true,"description":"Filtra comentários pelo id do curso","schema":{"type":"number","description":"Filtra comentários pelo id do curso"}},{"name":"lessonId","in":"query","required":true,"description":"Filtra comentários pelo id da aula","schema":{"type":"number","description":"Filtra comentários pelo id da aula"}},{"name":"status","in":"query","required":true,"description":"Filtra comentários pelo status","schema":{"type":"string","enum":["approved","rejected","inModeration"],"enumDescriptions":{"approved":"Aprovado","rejected":"Reprovado","inModeration":"Em moderação"},"description":"Filtra comentários pelo status"}},{"name":"favorite","in":"query","required":true,"description":"Filtra comentários favoritados ou não favoritados","schema":{"type":"boolean","description":"Filtra comentários favoritados ou não favoritados"}},{"name":"answered","in":"query","required":true,"description":"Filtra comentários respondidos ou não respondidos","schema":{"type":"boolean","description":"Filtra comentários respondidos ou não respondidos"}},{"name":"read","in":"query","required":true,"description":"Filtra comentários lidos ou não lidos","schema":{"type":"boolean","description":"Filtra comentários lidos ou não lidos"}},{"name":"fixed","in":"query","required":true,"description":"Filtra comentários fixados ou não","schema":{"type":"boolean","description":"Filtra comentários fixados ou não"}},{"name":"email","in":"query","required":true,"description":"Filtra comentários pelo e-mail","schema":{"type":"string","description":"Filtra comentários pelo e-mail"}}],"responses":{"200":{"description":"Lista de comentários","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id do comentário","sample":"12345","example":"12345"},"text":{"type":"string","description":"Texto do comentário","sample":"false","example":"false"},"isRead":{"type":"boolean","description":"Comentário lido ou não lido","sample":"true","example":"true"},"isFavorite":{"type":"boolean","description":"Comentário favoritado ou não favoritado","sample":"false","example":"false"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação do comentário","sample":"2023-04-28T20:47:32Z","example":"2023-04-28T20:47:32Z"},"isFixed":{"type":"boolean","description":"Comentário está fixado ou não fixado","sample":"true","example":"true"},"status":{"type":"string","enum":["approved","rejected","inModeration"],"enumDescriptions":{"approved":"Aprovado","rejected":"Reprovado","inModeration":"Em moderação"},"description":"Status do comentário","sample":"inModeration","example":"inModeration"},"type":{"type":"string","enum":["html","text"],"enumDescriptions":{"html":"Formato HTML","text":"Formato texto"},"description":"Formato do comentário"},"author":{"type":"string","description":"Autor do comentário","sample":"João Neves","example":"João Neves"},"lessonId":{"type":"number","description":"Aula que o comentário pertence","sample":"54321","example":"54321"},"isAnswered":{"type":"boolean","description":"Comentário respondido ou não respondido","sample":"true","example":"true"}},"required":["id","text","isRead","isFavorite","createdAt","isFixed","status","type","author","lessonId","isAnswered"],"additionalProperties":false,"description":"Comentário"},"description":"Comentários"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do comentário","schema":{"type":"string","description":"Id do comentário","sample":"12345","example":"12345"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual","sample":"1","required":true,"example":"1"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página","sample":"10","required":true,"example":"10"}}],"responses":{"200":{"description":"Sem respostas","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"2","example":"2"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"20","example":"20"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id da resposta","sample":"12345","example":"12345"},"text":{"type":"string","description":"Texto da resposta","sample":"Essa é uma resposta","example":"Essa é uma resposta"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da resposta","sample":"2023-04-28T20:47:32Z","example":"2023-04-28T20:47:32Z"},"status":{"type":"string","enum":["approved","rejected"],"enumDescriptions":{"approved":"Aprovado","rejected":"Reprovado"},"description":"Status da resposta","sample":"approved","example":"approved"},"type":{"type":"string","enum":["html","text"],"enumDescriptions":{"html":"Formato HTML","text":"Formato texto"},"description":"Formato da resposta"},"author":{"type":"string","description":"Autor da resposta","sample":"João Paulo","example":"João Paulo"}},"required":["id","text","createdAt","status","type","author"],"additionalProperties":false,"description":"Resposta"},"description":"Respostas"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":50,"totalItems":1,"items":[]}}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"2","example":"2"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"20","example":"20"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Id da resposta","sample":"12345","example":"12345"},"text":{"type":"string","description":"Texto da resposta","sample":"Essa é uma resposta","example":"Essa é uma resposta"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da resposta","sample":"2023-04-28T20:47:32Z","example":"2023-04-28T20:47:32Z"},"status":{"type":"string","enum":["approved","rejected"],"enumDescriptions":{"approved":"Aprovado","rejected":"Reprovado"},"description":"Status da resposta","sample":"approved","example":"approved"},"type":{"type":"string","enum":["html","text"],"enumDescriptions":{"html":"Formato HTML","text":"Formato texto"},"description":"Formato da resposta"},"author":{"type":"string","description":"Autor da resposta","sample":"João Paulo","example":"João Paulo"}},"required":["id","text","createdAt","status","type","author"],"additionalProperties":false,"description":"Resposta"},"description":"Respostas"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do comentário","schema":{"type":"string","description":"Id do comentário","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"Texto da resposta","required":true}},"required":["text"],"additionalProperties":false}}}},"responses":{"201":{"description":"Resposta ao comentário","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Comentário não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Dados do curso específico","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do curso","sample":"12351","example":"12351"},"title":{"type":"string","description":"Nome do curso","sample":"Novo curso!","example":"Novo curso!"},"description":{"type":"string","description":"Descrição do curso","sample":"Este é curso dedicado para especialistas","example":"Este é curso dedicado para especialistas"},"published":{"type":"boolean","description":"Status que identifica se o curso foi publicado","sample":"true","example":"true"},"replyEmail":{"nullable":true,"type":"string","description":"O e-mail atrelado a este campo receberá notificações de interações dos alunos,como comentários ou mensagens diretas relacionadas ao curso","sample":"email_produtor_reply@gmail.com","example":"email_produtor_reply@gmail.com"},"daysAvailable":{"nullable":true,"type":"number","description":"Define a quantidade de dias em que o aluno terá acesso ao curso. Este período sempre considera a partir da data em que o curso foi liberado para o aluno","sample":"365","example":"365"},"releaseDate":{"type":"string","description":"Define a data em que o curso estará disponível para os alunos","sample":"2024-08-27","example":"2024-08-27"},"progressBar":{"type":"boolean","description":"Define se a barra de progresso do curso será exibida para os alunos","sample":"true","example":"true"},"pixelFacebook":{"nullable":true,"type":"string","description":"Pixel do Facebook","sample":"123456789","example":"123456789"},"pixelGoogleAnalytics":{"nullable":true,"type":"string","description":"Google Analytics","sample":"UA-123456789","example":"UA-123456789"},"duration":{"nullable":true,"type":"number","description":"Carga horária do curso","sample":"2400","example":"2400"},"certificateProgress":{"nullable":true,"type":"number","description":"Porcentagem necessária para obter o certificado","sample":"100","example":"100"},"certificateEnabled":{"type":"boolean","description":"Indica se a emissão de certificados está ativa para o curso","sample":"true","example":"true"},"supportExternalUrl":{"nullable":true,"type":"string","description":"Url que direciona para uma página de suporte externo","sample":"https://www.minha-pagina-de-ajuda.com","example":"https://www.minha-pagina-de-ajuda.com"},"allowMultipleAccess":{"type":"boolean","description":"Permite múltiplos acessos de um mesmo usuário no curso","sample":"false","example":"false"},"secretaryStatus":{"type":"boolean","description":"Status de utilização do plugin de secretaria","sample":"true","example":"true"},"secretaryUrl":{"nullable":true,"type":"string","description":"Url da secretaria","sample":"https://www.example.com","example":"https://www.example.com"},"customization":{"type":"object","properties":{"background":{"type":"string","description":"Imagem de fundo para tema escuro","sample":"https://www.minha-imagem.com/card.jpg","example":"https://www.minha-imagem.com/card.jpg"},"backgroundLight":{"type":"string","description":"Imagem de fundo para tema claro","sample":"https://www.minha-imagem.com/card.jpg","example":"https://www.minha-imagem.com/card.jpg"},"modulesDefaultImage":{"type":"string","description":"Imagem padrão para ser utilizada em todos os módulos","sample":"https://www.minha-imagem.com/module/image.jpg","example":"https://www.minha-imagem.com/module/image.jpg"},"lessonsDefaultImage":{"type":"string","description":"Imagem padrão para ser utilizada em todas as aulas","sample":"https://www.minha-imagem.com/lesson/image.jpg","example":"https://www.minha-imagem.com/lesson/image.jpg"}},"required":["background","backgroundLight","modulesDefaultImage","lessonsDefaultImage"],"additionalProperties":false,"description":"Customizações do curso"}},"required":["id","title","description","published","replyEmail","daysAvailable","releaseDate","progressBar","pixelFacebook","pixelGoogleAnalytics","duration","certificateProgress","certificateEnabled","supportExternalUrl","allowMultipleAccess","secretaryStatus","secretaryUrl","customization"],"additionalProperties":false},"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,"certificateEnabled":true,"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do curso","sample":"12351","example":"12351"},"title":{"type":"string","description":"Nome do curso","sample":"Novo curso!","example":"Novo curso!"},"description":{"type":"string","description":"Descrição do curso","sample":"Este é curso dedicado para especialistas","example":"Este é curso dedicado para especialistas"},"published":{"type":"boolean","description":"Status que identifica se o curso foi publicado","sample":"true","example":"true"},"replyEmail":{"nullable":true,"type":"string","description":"O e-mail atrelado a este campo receberá notificações de interações dos alunos,como comentários ou mensagens diretas relacionadas ao curso","sample":"email_produtor_reply@gmail.com","example":"email_produtor_reply@gmail.com"},"daysAvailable":{"nullable":true,"type":"number","description":"Define a quantidade de dias em que o aluno terá acesso ao curso. Este período sempre considera a partir da data em que o curso foi liberado para o aluno","sample":"365","example":"365"},"releaseDate":{"type":"string","description":"Define a data em que o curso estará disponível para os alunos","sample":"2024-08-27","example":"2024-08-27"},"progressBar":{"type":"boolean","description":"Define se a barra de progresso do curso será exibida para os alunos","sample":"true","example":"true"},"pixelFacebook":{"nullable":true,"type":"string","description":"Pixel do Facebook","sample":"123456789","example":"123456789"},"pixelGoogleAnalytics":{"nullable":true,"type":"string","description":"Google Analytics","sample":"UA-123456789","example":"UA-123456789"},"duration":{"nullable":true,"type":"number","description":"Carga horária do curso","sample":"2400","example":"2400"},"certificateProgress":{"nullable":true,"type":"number","description":"Porcentagem necessária para obter o certificado","sample":"100","example":"100"},"certificateEnabled":{"type":"boolean","description":"Indica se a emissão de certificados está ativa para o curso","sample":"true","example":"true"},"supportExternalUrl":{"nullable":true,"type":"string","description":"Url que direciona para uma página de suporte externo","sample":"https://www.minha-pagina-de-ajuda.com","example":"https://www.minha-pagina-de-ajuda.com"},"allowMultipleAccess":{"type":"boolean","description":"Permite múltiplos acessos de um mesmo usuário no curso","sample":"false","example":"false"},"secretaryStatus":{"type":"boolean","description":"Status de utilização do plugin de secretaria","sample":"true","example":"true"},"secretaryUrl":{"nullable":true,"type":"string","description":"Url da secretaria","sample":"https://www.example.com","example":"https://www.example.com"},"customization":{"type":"object","properties":{"background":{"type":"string","description":"Imagem de fundo para tema escuro","sample":"https://www.minha-imagem.com/card.jpg","example":"https://www.minha-imagem.com/card.jpg"},"backgroundLight":{"type":"string","description":"Imagem de fundo para tema claro","sample":"https://www.minha-imagem.com/card.jpg","example":"https://www.minha-imagem.com/card.jpg"},"modulesDefaultImage":{"type":"string","description":"Imagem padrão para ser utilizada em todos os módulos","sample":"https://www.minha-imagem.com/module/image.jpg","example":"https://www.minha-imagem.com/module/image.jpg"},"lessonsDefaultImage":{"type":"string","description":"Imagem padrão para ser utilizada em todas as aulas","sample":"https://www.minha-imagem.com/lesson/image.jpg","example":"https://www.minha-imagem.com/lesson/image.jpg"}},"required":["background","backgroundLight","modulesDefaultImage","lessonsDefaultImage"],"additionalProperties":false,"description":"Customizações do curso"}},"required":["id","title","description","published","replyEmail","daysAvailable","releaseDate","progressBar","pixelFacebook","pixelGoogleAnalytics","duration","certificateProgress","certificateEnabled","supportExternalUrl","allowMultipleAccess","secretaryStatus","secretaryUrl","customization"],"additionalProperties":false},"examples":{"default":{"value":{"message":"Este usuário não tem permissão","code":11}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do curso","sample":"12351","example":"12351"},"title":{"type":"string","description":"Nome do curso","sample":"Novo curso!","example":"Novo curso!"},"description":{"type":"string","description":"Descrição do curso","sample":"Este é curso dedicado para especialistas","example":"Este é curso dedicado para especialistas"},"published":{"type":"boolean","description":"Status que identifica se o curso foi publicado","sample":"true","example":"true"},"replyEmail":{"nullable":true,"type":"string","description":"O e-mail atrelado a este campo receberá notificações de interações dos alunos,como comentários ou mensagens diretas relacionadas ao curso","sample":"email_produtor_reply@gmail.com","example":"email_produtor_reply@gmail.com"},"daysAvailable":{"nullable":true,"type":"number","description":"Define a quantidade de dias em que o aluno terá acesso ao curso. Este período sempre considera a partir da data em que o curso foi liberado para o aluno","sample":"365","example":"365"},"releaseDate":{"type":"string","description":"Define a data em que o curso estará disponível para os alunos","sample":"2024-08-27","example":"2024-08-27"},"progressBar":{"type":"boolean","description":"Define se a barra de progresso do curso será exibida para os alunos","sample":"true","example":"true"},"pixelFacebook":{"nullable":true,"type":"string","description":"Pixel do Facebook","sample":"123456789","example":"123456789"},"pixelGoogleAnalytics":{"nullable":true,"type":"string","description":"Google Analytics","sample":"UA-123456789","example":"UA-123456789"},"duration":{"nullable":true,"type":"number","description":"Carga horária do curso","sample":"2400","example":"2400"},"certificateProgress":{"nullable":true,"type":"number","description":"Porcentagem necessária para obter o certificado","sample":"100","example":"100"},"certificateEnabled":{"type":"boolean","description":"Indica se a emissão de certificados está ativa para o curso","sample":"true","example":"true"},"supportExternalUrl":{"nullable":true,"type":"string","description":"Url que direciona para uma página de suporte externo","sample":"https://www.minha-pagina-de-ajuda.com","example":"https://www.minha-pagina-de-ajuda.com"},"allowMultipleAccess":{"type":"boolean","description":"Permite múltiplos acessos de um mesmo usuário no curso","sample":"false","example":"false"},"secretaryStatus":{"type":"boolean","description":"Status de utilização do plugin de secretaria","sample":"true","example":"true"},"secretaryUrl":{"nullable":true,"type":"string","description":"Url da secretaria","sample":"https://www.example.com","example":"https://www.example.com"},"customization":{"type":"object","properties":{"background":{"type":"string","description":"Imagem de fundo para tema escuro","sample":"https://www.minha-imagem.com/card.jpg","example":"https://www.minha-imagem.com/card.jpg"},"backgroundLight":{"type":"string","description":"Imagem de fundo para tema claro","sample":"https://www.minha-imagem.com/card.jpg","example":"https://www.minha-imagem.com/card.jpg"},"modulesDefaultImage":{"type":"string","description":"Imagem padrão para ser utilizada em todos os módulos","sample":"https://www.minha-imagem.com/module/image.jpg","example":"https://www.minha-imagem.com/module/image.jpg"},"lessonsDefaultImage":{"type":"string","description":"Imagem padrão para ser utilizada em todas as aulas","sample":"https://www.minha-imagem.com/lesson/image.jpg","example":"https://www.minha-imagem.com/lesson/image.jpg"}},"required":["background","backgroundLight","modulesDefaultImage","lessonsDefaultImage"],"additionalProperties":false,"description":"Customizações do curso"}},"required":["id","title","description","published","replyEmail","daysAvailable","releaseDate","progressBar","pixelFacebook","pixelGoogleAnalytics","duration","certificateProgress","certificateEnabled","supportExternalUrl","allowMultipleAccess","secretaryStatus","secretaryUrl","customization"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Exclusão feita com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do status da resposta","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso deletado com sucesso","example":"Curso deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":null,"message":"Curso deletado com sucesso"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do status da resposta","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso deletado com sucesso","example":"Curso deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do status da resposta","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso deletado com sucesso","example":"Curso deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"Título do curso","sample":"Curso de Nutrição","required":true,"example":"Curso de Nutrição"},"description":{"type":"string","description":"Descrição do curso","sample":"Curso de nutrição para iniciantes","required":true,"example":"Curso de nutrição para iniciantes"},"authorId":{"type":"number","description":"Id do autor do curso","sample":"1","example":"1"},"published":{"type":"boolean","description":"Status de publicação do curso","sample":"true","required":true,"example":"true"}},"required":["title","description","authorId","published"],"additionalProperties":false}}}},"responses":{"200":{"description":"Curso atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":null,"message":"Curso atualizado com sucesso"}}}}}},"400":{"description":"Erro de validação","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}},{"name":"moduleId","in":"path","required":true,"description":"Id do módulo","schema":{"type":"string","description":"Id do módulo","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Dados do módulo","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do módulo","sample":"12351","example":"12351"},"courseId":{"type":"string","description":"Título do módulo","sample":"Novo curso!","example":"Novo curso!"},"title":{"type":"string","description":"Hash do módulo","sample":"53bc09b45b1s","example":"53bc09b45b1s"},"daysLocked":{"nullable":true,"type":"number","description":"Quantidade de dias após a matrícula/compra do aluno em que este módulo estará visível","sample":"7","example":"7"},"isDraft":{"type":"boolean","description":"Indica se o módulo está em rascunho","sample":"false","example":"false"},"availableDays":{"nullable":true,"type":"number","description":"Quantidade de dias em que o módulo ficará disponível após matrícula/compra do aluno","sample":"3","example":"3"},"releaseDate":{"nullable":true,"type":"string","description":"Data em que o módulo será lançado","sample":"2024-10-15","example":"2024-10-15"},"sequence":{"type":"number","description":"Sequência em que o módulo aparecerá na listagem para o aluno","sample":"0","example":"0"},"isFree":{"type":"boolean","description":"Indica se o módulo é gratuito","sample":"false","example":"false"},"createdAt":{"type":"string","description":"Data de criação do módulo","sample":"2024-08-01 16:24:04.0000000","example":"2024-08-01 16:24:04.0000000"},"banner":{"type":"string","description":"Imagem de capa do módulo","sample":"https://www.example.com/image.jpg","example":"https://www.example.com/image.jpg"}},"required":["id","courseId","title","daysLocked","isDraft","availableDays","releaseDate","sequence","isFree","createdAt","banner"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do módulo","sample":"12351","example":"12351"},"courseId":{"type":"string","description":"Título do módulo","sample":"Novo curso!","example":"Novo curso!"},"title":{"type":"string","description":"Hash do módulo","sample":"53bc09b45b1s","example":"53bc09b45b1s"},"daysLocked":{"nullable":true,"type":"number","description":"Quantidade de dias após a matrícula/compra do aluno em que este módulo estará visível","sample":"7","example":"7"},"isDraft":{"type":"boolean","description":"Indica se o módulo está em rascunho","sample":"false","example":"false"},"availableDays":{"nullable":true,"type":"number","description":"Quantidade de dias em que o módulo ficará disponível após matrícula/compra do aluno","sample":"3","example":"3"},"releaseDate":{"nullable":true,"type":"string","description":"Data em que o módulo será lançado","sample":"2024-10-15","example":"2024-10-15"},"sequence":{"type":"number","description":"Sequência em que o módulo aparecerá na listagem para o aluno","sample":"0","example":"0"},"isFree":{"type":"boolean","description":"Indica se o módulo é gratuito","sample":"false","example":"false"},"createdAt":{"type":"string","description":"Data de criação do módulo","sample":"2024-08-01 16:24:04.0000000","example":"2024-08-01 16:24:04.0000000"},"banner":{"type":"string","description":"Imagem de capa do módulo","sample":"https://www.example.com/image.jpg","example":"https://www.example.com/image.jpg"}},"required":["id","courseId","title","daysLocked","isDraft","availableDays","releaseDate","sequence","isFree","createdAt","banner"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do módulo","sample":"12351","example":"12351"},"courseId":{"type":"string","description":"Título do módulo","sample":"Novo curso!","example":"Novo curso!"},"title":{"type":"string","description":"Hash do módulo","sample":"53bc09b45b1s","example":"53bc09b45b1s"},"daysLocked":{"nullable":true,"type":"number","description":"Quantidade de dias após a matrícula/compra do aluno em que este módulo estará visível","sample":"7","example":"7"},"isDraft":{"type":"boolean","description":"Indica se o módulo está em rascunho","sample":"false","example":"false"},"availableDays":{"nullable":true,"type":"number","description":"Quantidade de dias em que o módulo ficará disponível após matrícula/compra do aluno","sample":"3","example":"3"},"releaseDate":{"nullable":true,"type":"string","description":"Data em que o módulo será lançado","sample":"2024-10-15","example":"2024-10-15"},"sequence":{"type":"number","description":"Sequência em que o módulo aparecerá na listagem para o aluno","sample":"0","example":"0"},"isFree":{"type":"boolean","description":"Indica se o módulo é gratuito","sample":"false","example":"false"},"createdAt":{"type":"string","description":"Data de criação do módulo","sample":"2024-08-01 16:24:04.0000000","example":"2024-08-01 16:24:04.0000000"},"banner":{"type":"string","description":"Imagem de capa do módulo","sample":"https://www.example.com/image.jpg","example":"https://www.example.com/image.jpg"}},"required":["id","courseId","title","daysLocked","isDraft","availableDays","releaseDate","sequence","isFree","createdAt","banner"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}},{"name":"moduleId","in":"path","required":true,"description":"Id do módulo","schema":{"type":"string","description":"Id do módulo","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Exclusão feita com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo deletado com sucesso","example":"Módulo deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":null,"message":"Módulo deletado com sucesso"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo deletado com sucesso","example":"Módulo deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Módulo não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo deletado com sucesso","example":"Módulo deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados"}}}}}},"500":{"description":"Erro ao deletar os dados","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo deletado com sucesso","example":"Módulo deletado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}},{"name":"moduleId","in":"path","required":true,"description":"Id do módulo","schema":{"type":"string","description":"Id do módulo","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"Título do módulo","sample":"Novo curso","required":true,"example":"Novo curso"},"daysLocked":{"type":"number","description":"Quantidade de dias após a matrícula/compra do aluno em que este módulo estará visível","sample":"14","example":"14"},"isDraft":{"type":"boolean","description":"Status que identifica se o módulo está em rascunho","sample":"false","required":true,"example":"false"},"availableDays":{"type":"number","description":"Quantidade de dias em que o módulo ficará disponível após matrícula/compra do aluno","sample":"30","example":"30"},"releaseDate":{"type":"string","description":"Data em que o módulo será lançado","sample":"2024-10-15","example":"2024-10-15"},"sequence":{"type":"number","description":"Numeração da ordem em que o módulo aparece na listagem","sample":"1","example":"1"},"isFree":{"type":"boolean","description":"Status que indica se o módulo é gratuito","sample":"false","required":true,"example":"false"}},"required":["title","daysLocked","isDraft","availableDays","releaseDate","sequence","isFree"],"additionalProperties":false}}}},"responses":{"200":{"description":"Módulo atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo atualizado com sucesso","example":"Módulo atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":null,"message":"Módulo atualizado com sucesso"}}}}}},"400":{"description":"Erro de validação ao atualizar os dados","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo atualizado com sucesso","example":"Módulo atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":22,"message":"Erro ao atualizar os dados"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo atualizado com sucesso","example":"Módulo atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Dados não encontrados","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Módulo atualizado com sucesso","example":"Módulo atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"daysAvailable":{"type":"number","description":"Dias disponíveis para acesso ao curso após a compra","sample":"365","example":"365"},"releaseDate":{"type":"string","description":"Define a data em que o curso estará disponível para os alunos","sample":"2024-08-27","example":"2024-08-27"},"progressBar":{"type":"boolean","description":"Define se a barra de progresso do curso será exibida para os alunos","sample":"true","required":true,"example":"true"},"pixelFacebook":{"type":"string","description":"Pixel do Facebook","sample":"123456789","example":"123456789"},"pixelGoogleAnalytics":{"type":"string","description":"Google Analytics","sample":"UA-123456789","example":"UA-123456789"},"duration":{"type":"number","description":"Carga horária do curso","sample":"2400","example":"2400"},"certificateProgress":{"type":"number","description":"Porcentagem necessária para obter o certificado","sample":"100","example":"100"},"certificateEnabled":{"type":"boolean","description":"Controla se a emissão de certificados está ativa. Progresso e carga horária não são alterados ao desligar","sample":"true","example":"true"},"supportExternalUrl":{"type":"string","description":"Url que direciona para uma página de suporte externo","sample":"https://www.minha-pagina-de-ajuda.com","example":"https://www.minha-pagina-de-ajuda.com"},"allowMultipleAccess":{"type":"boolean","description":"Permite múltiplos acessos de um mesmo usuário no curso","sample":"false","required":true,"example":"false"},"secretaryStatus":{"type":"boolean","description":"Status de utilização do plugin de secretaria","sample":"false","example":"false"},"secretaryUrl":{"type":"string","description":"Url da secretaria","sample":"https://www.example.com","example":"https://www.example.com"}},"required":["daysAvailable","releaseDate","progressBar","pixelFacebook","pixelGoogleAnalytics","duration","certificateProgress","certificateEnabled","supportExternalUrl","allowMultipleAccess","secretaryStatus","secretaryUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"Curso atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":null,"message":"Curso atualizado com sucesso"}}}}}},"400":{"description":"Erro de validação","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Curso não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"lessonsDefaultImage":{"type":"string","description":"Imagem padrão das lições do curso","sample":"https://example.com/image.jpg","example":"https://example.com/image.jpg"},"modulesDefaultImage":{"type":"string","description":"Imagem padrão dos módulos do curso","sample":"https://example.com/image.jpg","example":"https://example.com/image.jpg"},"background":{"type":"string","description":"Imagem de fundo do curso","sample":"https://example.com/image.jpg","example":"https://example.com/image.jpg"}},"required":["lessonsDefaultImage","modulesDefaultImage","background"],"additionalProperties":false}}}},"responses":{"200":{"description":"Curso atualizado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":null,"message":"Curso atualizado com sucesso"}}}}}},"400":{"description":"Erro ao atualizar os dados do curso","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"examples":{"default":{"value":{"code":22,"message":"Erro ao atualizar os dados"}}}}}},"403":{"description":"Erro de permissão","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"nullable":true,"type":"number","description":"Código do erro","sample":"null","example":"null"},"message":{"type":"string","description":"Mensagem de retorno da requisição","sample":"Curso atualizado com sucesso","example":"Curso atualizado com sucesso"}},"required":["code","message"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do curso","sample":"12351","example":"12351"},"title":{"type":"string","description":"Nome do curso","sample":"Novo curso!","example":"Novo curso!"},"hash":{"type":"string","description":"Hash do curso","sample":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9","example":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9"},"createdAt":{"type":"string","description":"Data de criação do curso","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"updatedAt":{"type":"string","description":"Data de atualização do curso","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"published":{"type":"boolean","description":"Status que identifica se o curso foi publicado","sample":"true","example":"true"},"myEduzzAssociation":{"nullable":true,"type":"object","properties":{"contentId":{"type":"string","description":"Id do produto","sample":"Produto 1","example":"Produto 1"},"title":{"type":"string","description":"Título do produto","sample":"Produto 1","example":"Produto 1"}},"required":["contentId","title"],"additionalProperties":false,"description":"Associação do curso com um produto do MyEduzz","sample":"Produto do MyEduzz associado ao curso","example":"Produto do MyEduzz associado ao curso"},"category":{"type":"object","properties":{"id":{"type":"number","description":"Id da categoria","sample":"1","example":"1"},"name":{"type":"string","description":"Nome da categoria","sample":"Categoria 1","example":"Categoria 1"}},"required":["id","name"],"additionalProperties":false,"description":"Categoria em que o curso está atrelada"}},"required":["id","title","hash","createdAt","updatedAt","published","myEduzzAssociation","category"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do curso","sample":"12351","example":"12351"},"title":{"type":"string","description":"Nome do curso","sample":"Novo curso!","example":"Novo curso!"},"hash":{"type":"string","description":"Hash do curso","sample":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9","example":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9"},"createdAt":{"type":"string","description":"Data de criação do curso","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"updatedAt":{"type":"string","description":"Data de atualização do curso","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"published":{"type":"boolean","description":"Status que identifica se o curso foi publicado","sample":"true","example":"true"},"myEduzzAssociation":{"nullable":true,"type":"object","properties":{"contentId":{"type":"string","description":"Id do produto","sample":"Produto 1","example":"Produto 1"},"title":{"type":"string","description":"Título do produto","sample":"Produto 1","example":"Produto 1"}},"required":["contentId","title"],"additionalProperties":false,"description":"Associação do curso com um produto do MyEduzz","sample":"Produto do MyEduzz associado ao curso","example":"Produto do MyEduzz associado ao curso"},"category":{"type":"object","properties":{"id":{"type":"number","description":"Id da categoria","sample":"1","example":"1"},"name":{"type":"string","description":"Nome da categoria","sample":"Categoria 1","example":"Categoria 1"}},"required":["id","name"],"additionalProperties":false,"description":"Categoria em que o curso está atrelada"}},"required":["id","title","hash","createdAt","updatedAt","published","myEduzzAssociation","category"],"additionalProperties":false},"examples":{"default":{"value":{"code":11,"message":"Este usuário não tem permissão"}}}}}},"404":{"description":"Dados não encontrados","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do curso","sample":"12351","example":"12351"},"title":{"type":"string","description":"Nome do curso","sample":"Novo curso!","example":"Novo curso!"},"hash":{"type":"string","description":"Hash do curso","sample":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9","example":"53bc09b45b1sdsdf438fc2ea87ac04d8faabb8d9"},"createdAt":{"type":"string","description":"Data de criação do curso","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"updatedAt":{"type":"string","description":"Data de atualização do curso","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"published":{"type":"boolean","description":"Status que identifica se o curso foi publicado","sample":"true","example":"true"},"myEduzzAssociation":{"nullable":true,"type":"object","properties":{"contentId":{"type":"string","description":"Id do produto","sample":"Produto 1","example":"Produto 1"},"title":{"type":"string","description":"Título do produto","sample":"Produto 1","example":"Produto 1"}},"required":["contentId","title"],"additionalProperties":false,"description":"Associação do curso com um produto do MyEduzz","sample":"Produto do MyEduzz associado ao curso","example":"Produto do MyEduzz associado ao curso"},"category":{"type":"object","properties":{"id":{"type":"number","description":"Id da categoria","sample":"1","example":"1"},"name":{"type":"string","description":"Nome da categoria","sample":"Categoria 1","example":"Categoria 1"}},"required":["id","name"],"additionalProperties":false,"description":"Categoria em que o curso está atrelada"}},"required":["id","title","hash","createdAt","updatedAt","published","myEduzzAssociation","category"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do curso","schema":{"type":"string","description":"Id do curso","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Lista de módulos do curso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do módulo","sample":"12351","example":"12351"},"courseId":{"type":"string","description":"Título do módulo","sample":"Novo curso!","example":"Novo curso!"},"title":{"type":"string","description":"Hash do módulo","sample":"53bc09b45b1s","example":"53bc09b45b1s"},"daysLocked":{"nullable":true,"type":"number","description":"Quantidade de dias após a matrícula/compra do aluno em que este módulo estará visível","sample":"7","example":"7"},"isDraft":{"type":"boolean","description":"Indica se o módulo está em rascunho","sample":"false","example":"false"},"availableDays":{"nullable":true,"type":"number","description":"Quantidade de dias em que o módulo ficará disponível após matrícula/compra do aluno","sample":"30","example":"30"},"releaseDate":{"nullable":true,"type":"string","description":"Data em que o módulo será lançado","sample":"2024-10-15","example":"2024-10-15"},"sequence":{"type":"number","description":"Sequência em que o módulo aparecerá na listagem para o aluno","sample":"1","example":"1"},"isFree":{"type":"boolean","description":"Indica se o módulo é gratuito","sample":"false","example":"false"},"createdAt":{"type":"string","description":"Data de criação do módulo","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"banner":{"type":"string","description":"Imagem de capa do módulo","sample":"https://www.example.com/image.jpg","example":"https://www.example.com/image.jpg"}},"required":["id","courseId","title","daysLocked","isDraft","availableDays","releaseDate","sequence","isFree","createdAt","banner"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"Id do módulo","sample":"12351","example":"12351"},"courseId":{"type":"string","description":"Título do módulo","sample":"Novo curso!","example":"Novo curso!"},"title":{"type":"string","description":"Hash do módulo","sample":"53bc09b45b1s","example":"53bc09b45b1s"},"daysLocked":{"nullable":true,"type":"number","description":"Quantidade de dias após a matrícula/compra do aluno em que este módulo estará visível","sample":"7","example":"7"},"isDraft":{"type":"boolean","description":"Indica se o módulo está em rascunho","sample":"false","example":"false"},"availableDays":{"nullable":true,"type":"number","description":"Quantidade de dias em que o módulo ficará disponível após matrícula/compra do aluno","sample":"30","example":"30"},"releaseDate":{"nullable":true,"type":"string","description":"Data em que o módulo será lançado","sample":"2024-10-15","example":"2024-10-15"},"sequence":{"type":"number","description":"Sequência em que o módulo aparecerá na listagem para o aluno","sample":"1","example":"1"},"isFree":{"type":"boolean","description":"Indica se o módulo é gratuito","sample":"false","example":"false"},"createdAt":{"type":"string","description":"Data de criação do módulo","sample":"2024-08-29T18:14:53Z","example":"2024-08-29T18:14:53Z"},"banner":{"type":"string","description":"Imagem de capa do módulo","sample":"https://www.example.com/image.jpg","example":"https://www.example.com/image.jpg"}},"required":["id","courseId","title","daysLocked","isDraft","availableDays","releaseDate","sequence","isFree","createdAt","banner"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da matrícula","schema":{"type":"string","description":"Id da matrícula","sample":"12345","example":"12345"}}],"responses":{"201":{"description":"Aluno bloqueado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Matrícula não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}},"411":{"description":"Sem permissão","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id da matrícula","schema":{"type":"string","description":"Id da matrícula","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"expiredAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Nova data de expiração","sample":"2025-01-22","required":true,"example":"2025-01-22"}},"required":["expiredAt"],"additionalProperties":false}}}},"responses":{"201":{"description":"Acesso extendido","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"400":{"description":"Dados incorretos","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"code":12,"message":"Usuário não encontrado","errors":[]}}}}}},"409":{"description":"Sem permissão","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id do aluno","schema":{"type":"string","description":"Id do aluno","sample":"12345","example":"12345"}}],"responses":{"204":{"description":"Aluno excluído com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id do aluno","schema":{"type":"string","description":"Id do aluno","sample":"12345","example":"12345"}}],"responses":{"200":{"description":"Perfil do aluno","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id do aluno","sample":"123","example":"123"},"name":{"type":"string","description":"Nome do aluno","sample":"Jão","example":"Jão"},"email":{"type":"string","description":"Email do aluno","sample":"test@test.com","example":"test@test.com"},"avatar":{"type":"string","format":"uri","description":"Avatar do aluno","sample":"https://www.example.com/avatar.jpg","example":"https://www.example.com/avatar.jpg"}},"required":["id","name","email","avatar"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da matrícula","schema":{"type":"string","description":"Id da matrícula","sample":"12345","example":"12345"}}],"responses":{"201":{"description":"Módulos liberados com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"code":12,"message":"Usuário não encontrado","errors":[]}}}}}},"409":{"description":"Matrícula bloqueada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}},{"name":"id","in":"query","required":true,"description":"Id do aluno","schema":{"type":"string","description":"Id do aluno"}},{"name":"email","in":"query","required":true,"description":"Email do aluno","schema":{"type":"string","description":"Email do aluno"}}],"responses":{"200":{"description":"Lista de alunos","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id do aluno","sample":"9b71e95310b7464bb6ca910ab3036372","example":"9b71e95310b7464bb6ca910ab3036372"},"name":{"type":"string","description":"Nome do aluno","sample":"João Carlos","example":"João Carlos"},"email":{"type":"string","description":"Email do aluno","sample":"test@test.com","example":"test@test.com"},"avatar":{"type":"string","format":"uri","description":"Avatar do aluno","sample":"https://www.example.com/avatar.jpg","example":"https://www.example.com/avatar.jpg"}},"required":["id","name","email","avatar"],"additionalProperties":false,"description":"Aluno"},"description":"Alunos"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do aluno","schema":{"type":"string","description":"Id do aluno","sample":"12345","example":"12345"}},{"name":"page","in":"query","required":true,"description":"Página atual","schema":{"type":"number","description":"Página atual"}},{"name":"itemsPerPage","in":"query","required":true,"description":"Número de itens por página","schema":{"type":"number","description":"Número de itens por página"}}],"responses":{"200":{"description":"Sem matrículas","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da matrícula","sample":"20061","example":"20061"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da matrícula","sample":"2024-10-02T15:25:18+00:00","example":"2024-10-02T15:25:18+00:00"},"status":{"type":"string","enum":["active","inactive"],"enumDescriptions":{"active":"Matrícula ativa","inactive":"Matrícula inativa"},"description":"Status da matrícula","sample":"active","example":"active"},"allModulesReleased":{"nullable":true,"type":"boolean","description":"Todos os módulos foram entregues","sample":"true","example":"true"},"expiredAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de expiração da matrícula","sample":"2025-10-02T15:25:18+00:00","example":"2025-10-02T15:25:18+00:00"},"acceptedTermAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data que aceitou o termo da matrícula","sample":"2024-10-02T15:25:18+00:00","example":"2024-10-02T15:25:18+00:00"},"content":{"type":"object","properties":{"type":{"type":"string","enum":["course","package"],"enumDescriptions":{"course":"A matrícula é de um curso","package":"A matrícula é de um pacote"},"sample":"course","example":"course"},"courses":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Título do curso"},"hash":{"type":"string","description":"Hash do curso"}},"required":["title","hash"],"additionalProperties":false,"description":"Curso"},"description":"Cursos"}},"required":["type","courses"],"additionalProperties":false,"description":"Conteúdo da matrícula"},"progress":{"type":"number","description":"Progresso do aluno nessa matrícula"}},"required":["id","createdAt","status","allModulesReleased","expiredAt","acceptedTermAt","content","progress"],"additionalProperties":false,"description":"Informações da matrícula"},"description":"Lista de matrículas"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"examples":{"default":{"value":{"pages":1,"page":1,"itemsPerPage":50,"totalItems":0,"items":[]}}}}}},"404":{"description":"Aluno não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"number","description":"Número de páginas","sample":"1","example":"1"},"page":{"type":"number","description":"Página atual","sample":"1","example":"1"},"itemsPerPage":{"type":"number","description":"Número máximo de itens por página","sample":"10","example":"10"},"totalItems":{"type":"number","description":"Número total de items","sample":"1","example":"1"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Id da matrícula","sample":"20061","example":"20061"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data da matrícula","sample":"2024-10-02T15:25:18+00:00","example":"2024-10-02T15:25:18+00:00"},"status":{"type":"string","enum":["active","inactive"],"enumDescriptions":{"active":"Matrícula ativa","inactive":"Matrícula inativa"},"description":"Status da matrícula","sample":"active","example":"active"},"allModulesReleased":{"nullable":true,"type":"boolean","description":"Todos os módulos foram entregues","sample":"true","example":"true"},"expiredAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de expiração da matrícula","sample":"2025-10-02T15:25:18+00:00","example":"2025-10-02T15:25:18+00:00"},"acceptedTermAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data que aceitou o termo da matrícula","sample":"2024-10-02T15:25:18+00:00","example":"2024-10-02T15:25:18+00:00"},"content":{"type":"object","properties":{"type":{"type":"string","enum":["course","package"],"enumDescriptions":{"course":"A matrícula é de um curso","package":"A matrícula é de um pacote"},"sample":"course","example":"course"},"courses":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Título do curso"},"hash":{"type":"string","description":"Hash do curso"}},"required":["title","hash"],"additionalProperties":false,"description":"Curso"},"description":"Cursos"}},"required":["type","courses"],"additionalProperties":false,"description":"Conteúdo da matrícula"},"progress":{"type":"number","description":"Progresso do aluno nessa matrícula"}},"required":["id","createdAt","status","allModulesReleased","expiredAt","acceptedTermAt","content","progress"],"additionalProperties":false,"description":"Informações da matrícula"},"description":"Lista de matrículas"}},"required":["pages","page","itemsPerPage","totalItems","items"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da matrícula","schema":{"type":"string","description":"Id da matrícula","sample":"12345","example":"12345"}}],"responses":{"204":{"description":"Matrícula removida com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}},"404":{"description":"Matrícula não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"code":2,"message":"Dados não encontrados","errors":[]}}}}}},"411":{"description":"Sem permissão","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador da mídia","schema":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","items":{"type":"string","format":"uri","sample":"https://eduzz.com","example":"https://eduzz.com"},"description":"Domínios permitidos"}},"required":["domains"],"additionalProperties":false}}}},"responses":{"201":{"description":"Domínios alterados com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"link":""}}}}}},"400":{"description":"Requisição Inválida","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"status":400,"message":"Error: referrers must be an array"}}}}}},"401":{"description":"Não autorizado alterar dominios","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Não permitido alterar dominios","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador da mídia","schema":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}}],"responses":{"204":{"description":"Domínios removidos com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{}}}}}},"401":{"description":"Não autorizado a excluir domínios da mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para excluir domínios da mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador da mídia","schema":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","description":"Título da mídia"},"description":{"type":"string","description":"Descrição da mídia"}},"required":["title","description"],"additionalProperties":false}}}},"responses":{"204":{"description":"Mídia alterada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{}}}}}},"400":{"description":"Requisição Inválida","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":400,"message":"Error: title must be a string"}}}}}},"401":{"description":"Não autorizado a alterar mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para alterar mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador da mídia","schema":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}}],"responses":{"200":{"description":"Detalhes da mídia do produtor","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"userId":{"type":"string","description":"Identificador do usuário","sample":"66954fbd04f7a37bfd00a928","example":"66954fbd04f7a37bfd00a928"},"userEmail":{"type":"string","description":"Email do usuário","sample":"user@eduzz.com","example":"user@eduzz.com"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"filename":{"type":"string","description":"Nome do arquivo da mídia","sample":"698dc19d489c4e4db73e28a713eab07b.mp4","example":"698dc19d489c4e4db73e28a713eab07b.mp4"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"order":{"type":"number","description":"Ordem da mídia","sample":"1","example":"1"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Marcadores da mídia"},"storage":{"type":"string","description":"Armazenamento da mídia","sample":"r2","example":"r2"},"deletedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de exclusão da mídia","sample":"2000-05-21T00:30:33.645Z","example":"2000-05-21T00:30:33.645Z"},"description":{"type":"string","description":"Descrição da mídia","sample":"teste","example":"teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"source":{"type":"object","properties":{"filename":{"type":"string","description":"Nome do arquivo","sample":"0f1b96d0d534f111befbe4f69dd2c15a.mp4","example":"0f1b96d0d534f111befbe4f69dd2c15a.mp4"},"size":{"type":"number","description":"Tamanho do arquivo","sample":"123","example":"123"},"width":{"type":"number","description":"Largura da mídia","sample":"576","example":"576"},"height":{"type":"number","description":"Altura da mídia","sample":"1024","example":"1024"}},"required":["filename","size","width","height"],"additionalProperties":false,"description":"Origem da mídia"},"encoded":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string","description":"Formato","sample":"hls","example":"hls"},"codec":{"type":"string","description":"Codec","sample":"h264","example":"h264"},"size":{"type":"number","description":"Tamanho","sample":"14102453","example":"14102453"},"resolutions":{"type":"array","items":{"type":"object","properties":{"width":{"type":"number","description":"Largura","sample":"135","example":"135"},"height":{"type":"number","description":"Altura","sample":"240","example":"240"}},"required":["width","height"],"additionalProperties":false,"description":"Resolução"},"description":"Resoluções"}},"required":["format","codec","size","resolutions"],"additionalProperties":false,"description":"Formato"},"description":"Formatos"}},"required":["id","key","userId","userEmail","title","filename","status","duration","order","tags","storage","deletedAt","description","createdAt","updatedAt","source","encoded"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"userId":{"type":"string","description":"Identificador do usuário","sample":"66954fbd04f7a37bfd00a928","example":"66954fbd04f7a37bfd00a928"},"userEmail":{"type":"string","description":"Email do usuário","sample":"user@eduzz.com","example":"user@eduzz.com"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"filename":{"type":"string","description":"Nome do arquivo da mídia","sample":"698dc19d489c4e4db73e28a713eab07b.mp4","example":"698dc19d489c4e4db73e28a713eab07b.mp4"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"order":{"type":"number","description":"Ordem da mídia","sample":"1","example":"1"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Marcadores da mídia"},"storage":{"type":"string","description":"Armazenamento da mídia","sample":"r2","example":"r2"},"deletedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de exclusão da mídia","sample":"2000-05-21T00:30:33.645Z","example":"2000-05-21T00:30:33.645Z"},"description":{"type":"string","description":"Descrição da mídia","sample":"teste","example":"teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"source":{"type":"object","properties":{"filename":{"type":"string","description":"Nome do arquivo","sample":"0f1b96d0d534f111befbe4f69dd2c15a.mp4","example":"0f1b96d0d534f111befbe4f69dd2c15a.mp4"},"size":{"type":"number","description":"Tamanho do arquivo","sample":"123","example":"123"},"width":{"type":"number","description":"Largura da mídia","sample":"576","example":"576"},"height":{"type":"number","description":"Altura da mídia","sample":"1024","example":"1024"}},"required":["filename","size","width","height"],"additionalProperties":false,"description":"Origem da mídia"},"encoded":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string","description":"Formato","sample":"hls","example":"hls"},"codec":{"type":"string","description":"Codec","sample":"h264","example":"h264"},"size":{"type":"number","description":"Tamanho","sample":"14102453","example":"14102453"},"resolutions":{"type":"array","items":{"type":"object","properties":{"width":{"type":"number","description":"Largura","sample":"135","example":"135"},"height":{"type":"number","description":"Altura","sample":"240","example":"240"}},"required":["width","height"],"additionalProperties":false,"description":"Resolução"},"description":"Resoluções"}},"required":["format","codec","size","resolutions"],"additionalProperties":false,"description":"Formato"},"description":"Formatos"}},"required":["id","key","userId","userEmail","title","filename","status","duration","order","tags","storage","deletedAt","description","createdAt","updatedAt","source","encoded"],"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para mostrar detalhes da mídia","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"userId":{"type":"string","description":"Identificador do usuário","sample":"66954fbd04f7a37bfd00a928","example":"66954fbd04f7a37bfd00a928"},"userEmail":{"type":"string","description":"Email do usuário","sample":"user@eduzz.com","example":"user@eduzz.com"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"filename":{"type":"string","description":"Nome do arquivo da mídia","sample":"698dc19d489c4e4db73e28a713eab07b.mp4","example":"698dc19d489c4e4db73e28a713eab07b.mp4"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"order":{"type":"number","description":"Ordem da mídia","sample":"1","example":"1"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Marcadores da mídia"},"storage":{"type":"string","description":"Armazenamento da mídia","sample":"r2","example":"r2"},"deletedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de exclusão da mídia","sample":"2000-05-21T00:30:33.645Z","example":"2000-05-21T00:30:33.645Z"},"description":{"type":"string","description":"Descrição da mídia","sample":"teste","example":"teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"source":{"type":"object","properties":{"filename":{"type":"string","description":"Nome do arquivo","sample":"0f1b96d0d534f111befbe4f69dd2c15a.mp4","example":"0f1b96d0d534f111befbe4f69dd2c15a.mp4"},"size":{"type":"number","description":"Tamanho do arquivo","sample":"123","example":"123"},"width":{"type":"number","description":"Largura da mídia","sample":"576","example":"576"},"height":{"type":"number","description":"Altura da mídia","sample":"1024","example":"1024"}},"required":["filename","size","width","height"],"additionalProperties":false,"description":"Origem da mídia"},"encoded":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string","description":"Formato","sample":"hls","example":"hls"},"codec":{"type":"string","description":"Codec","sample":"h264","example":"h264"},"size":{"type":"number","description":"Tamanho","sample":"14102453","example":"14102453"},"resolutions":{"type":"array","items":{"type":"object","properties":{"width":{"type":"number","description":"Largura","sample":"135","example":"135"},"height":{"type":"number","description":"Altura","sample":"240","example":"240"}},"required":["width","height"],"additionalProperties":false,"description":"Resolução"},"description":"Resoluções"}},"required":["format","codec","size","resolutions"],"additionalProperties":false,"description":"Formato"},"description":"Formatos"}},"required":["id","key","userId","userEmail","title","filename","status","duration","order","tags","storage","deletedAt","description","createdAt","updatedAt","source","encoded"],"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"userId":{"type":"string","description":"Identificador do usuário","sample":"66954fbd04f7a37bfd00a928","example":"66954fbd04f7a37bfd00a928"},"userEmail":{"type":"string","description":"Email do usuário","sample":"user@eduzz.com","example":"user@eduzz.com"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"filename":{"type":"string","description":"Nome do arquivo da mídia","sample":"698dc19d489c4e4db73e28a713eab07b.mp4","example":"698dc19d489c4e4db73e28a713eab07b.mp4"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"order":{"type":"number","description":"Ordem da mídia","sample":"1","example":"1"},"tags":{"type":"array","items":{"type":"string","sample":"tag1","example":"tag1"},"description":"Marcadores da mídia"},"storage":{"type":"string","description":"Armazenamento da mídia","sample":"r2","example":"r2"},"deletedAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de exclusão da mídia","sample":"2000-05-21T00:30:33.645Z","example":"2000-05-21T00:30:33.645Z"},"description":{"type":"string","description":"Descrição da mídia","sample":"teste","example":"teste"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"source":{"type":"object","properties":{"filename":{"type":"string","description":"Nome do arquivo","sample":"0f1b96d0d534f111befbe4f69dd2c15a.mp4","example":"0f1b96d0d534f111befbe4f69dd2c15a.mp4"},"size":{"type":"number","description":"Tamanho do arquivo","sample":"123","example":"123"},"width":{"type":"number","description":"Largura da mídia","sample":"576","example":"576"},"height":{"type":"number","description":"Altura da mídia","sample":"1024","example":"1024"}},"required":["filename","size","width","height"],"additionalProperties":false,"description":"Origem da mídia"},"encoded":{"type":"array","items":{"type":"object","properties":{"format":{"type":"string","description":"Formato","sample":"hls","example":"hls"},"codec":{"type":"string","description":"Codec","sample":"h264","example":"h264"},"size":{"type":"number","description":"Tamanho","sample":"14102453","example":"14102453"},"resolutions":{"type":"array","items":{"type":"object","properties":{"width":{"type":"number","description":"Largura","sample":"135","example":"135"},"height":{"type":"number","description":"Altura","sample":"240","example":"240"}},"required":["width","height"],"additionalProperties":false,"description":"Resolução"},"description":"Resoluções"}},"required":["format","codec","size","resolutions"],"additionalProperties":false,"description":"Formato"},"description":"Formatos"}},"required":["id","key","userId","userEmail","title","filename","status","duration","order","tags","storage","deletedAt","description","createdAt","updatedAt","source","encoded"],"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador da mídia","schema":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}}],"responses":{"204":{"description":"Exclui uma mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{}}}}}},"400":{"description":"Requisição Inválida","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":400,"message":"Query Media Path Params Invalid"}}}}}},"401":{"description":"Não autorizado excluir mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Não permitido excluir mídia","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador da mídia","schema":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}}],"responses":{"200":{"description":"Link com embed para mídia","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"link":""}}}}}},"401":{"description":"Não autorizado a listar link com embed","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para listar link com embed","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Elemento iframe com o conteúdo para poder adicionar em seu site","sample":"","example":""}},"required":["link"],"additionalProperties":false},"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":true,"schema":{"type":"string","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"}},{"name":"title","in":"query","required":true,"schema":{"type":"string","sample":"Teste","example":"Teste"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","sample":"video","example":"video"}}],"responses":{"200":{"description":"Lista de mídias","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"thumbnail":{"type":"string","format":"uri","description":"Imagem da miniatura da mídia","sample":"https://domain/thumbs/1231ac545.jpg","example":"https://domain/thumbs/1231ac545.jpg"}},"required":["id","key","title","status","duration","createdAt","updatedAt","thumbnail"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"thumbnail":{"type":"string","format":"uri","description":"Imagem da miniatura da mídia","sample":"https://domain/thumbs/1231ac545.jpg","example":"https://domain/thumbs/1231ac545.jpg"}},"required":["id","key","title","status","duration","createdAt","updatedAt","thumbnail"],"additionalProperties":false},"examples":{"default":{"value":{"status":401,"message":"Unauthorized"}}}}}},"403":{"description":"Sem permissão para listar mídias","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"thumbnail":{"type":"string","format":"uri","description":"Imagem da miniatura da mídia","sample":"https://domain/thumbs/1231ac545.jpg","example":"https://domain/thumbs/1231ac545.jpg"}},"required":["id","key","title","status","duration","createdAt","updatedAt","thumbnail"],"additionalProperties":false},"examples":{"default":{"value":{"status":403,"message":"Forbbiden scope invalid"}}}}}},"404":{"description":"Mídia não encontrada","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador da mídia","sample":"6695366e04f7a37bfd00a926","example":"6695366e04f7a37bfd00a926"},"key":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Chave da mídia","sample":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6","example":"b0b40529-e25d-4496-9ffc-bf54be9dcfd6"},"title":{"type":"string","description":"Título da mídia","sample":"Teste","example":"Teste"},"status":{"type":"string","description":"Status da mídia","sample":"encoded","example":"encoded"},"duration":{"type":"number","description":"Duração da mídia","sample":"123.00","example":"123.00"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de criação da mídia","sample":"2024-05-21T00:30:33.645Z","example":"2024-05-21T00:30:33.645Z"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$","description":"Data de atualização da mídia","sample":"2024-05-21T00:57:59.498Z","example":"2024-05-21T00:57:59.498Z"},"thumbnail":{"type":"string","format":"uri","description":"Imagem da miniatura da mídia","sample":"https://domain/thumbs/1231ac545.jpg","example":"https://domain/thumbs/1231ac545.jpg"}},"required":["id","key","title","status","duration","createdAt","updatedAt","thumbnail"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id da configuração","schema":{"type":"string","description":"Id da configuração","sample":"gklzq82g9l0daazesebit6hds","example":"gklzq82g9l0daazesebit6hds"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome da inscrição","sample":"Aluno assistiu Aula","example":"Aluno assistiu Aula"},"url":{"type":"string","description":"URL do WebHook","sample":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do evento","sample":"nutror.lesson_watched","example":"nutror.lesson_watched"}},"required":["name"],"additionalProperties":false,"description":"Objeto que representa o evento"},"description":"Eventos que o WebHook irá receber"},"filters":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"string","description":"Nome do filtro","sample":"productId","example":"productId"},"values":{"type":"array","items":{"type":"string","description":"Valor do filtro","sample":"123456","example":"123456"},"description":"Valores para o filtro (sempre strings)"}},"required":["metadata","values"],"additionalProperties":false,"description":"Objeto que representa o filtro"},"description":"Filtros para os eventos"}},"required":["name","url","events","filters"],"additionalProperties":false}}}},"responses":{"200":{"description":"Configuração de WebHook alterada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da inscrição","sample":"yaeung4oaxt25pi0bzzycoezf","example":"yaeung4oaxt25pi0bzzycoezf"},"name":{"type":"string","description":"Nome da inscrição criada","sample":"Test for Doc","example":"Test for Doc"},"secretId":{"type":"string","description":"Id do Secret de WebHook","sample":"f87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180","example":"f87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do evento","sample":"nutror.lesson_watched","example":"nutror.lesson_watched"}},"required":["name"],"additionalProperties":false,"description":"Objeto que representa o evento"},"description":"Eventos inscritos"},"url":{"type":"string","description":"URL do WebHook","sample":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"status":{"type":"string","description":"Status da inscrição","sample":"disabled","example":"disabled"}},"required":["id","name","secretId","events","url","status"],"additionalProperties":false},"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","description":"Nome da inscrição","sample":"Aluno assistiu Aula","example":"Aluno assistiu Aula"},"url":{"type":"string","description":"URL do WebHook","sample":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do evento","sample":"nutror.lesson_watched","example":"nutror.lesson_watched"}},"required":["name"],"additionalProperties":false,"description":"Objeto que representa o evento"},"description":"Eventos que o WebHook irá receber"},"filters":{"type":"array","items":{"type":"object","properties":{"metadata":{"type":"string","description":"Nome do filtro","sample":"productId","example":"productId"},"values":{"type":"array","items":{"type":"string","description":"Valor do filtro","sample":"123456","example":"123456"},"description":"Valores para o filtro (sempre strings)"}},"required":["metadata","values"],"additionalProperties":false,"description":"Objeto que representa o filtro"},"description":"Filtros para os eventos"}},"required":["name","url","events","filters"],"additionalProperties":false}}}},"responses":{"200":{"description":"Configuração de WebHook criada com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da inscrição","sample":"yaeung4oaxt25pi0bzzycoezf","example":"yaeung4oaxt25pi0bzzycoezf"},"name":{"type":"string","description":"Nome da inscrição criada","sample":"Test for Doc","example":"Test for Doc"},"secretId":{"type":"string","description":"Id do Secret de WebHook","sample":"f87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180","example":"f87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do evento","sample":"nutror.lesson_watched","example":"nutror.lesson_watched"}},"required":["name"],"additionalProperties":false,"description":"Objeto que representa o evento"},"description":"Eventos inscritos"},"url":{"type":"string","description":"URL do WebHook","sample":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"status":{"type":"string","description":"Status da inscrição","sample":"disabled","example":"disabled"}},"required":["id","name","secretId","events","url","status"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{},"additionalProperties":false},"examples":{"default":{}}}}}}},"get":{"operationId":"getwebhookv1subscription","summary":"Lista Inscrições de Webhook","tags":["Webhook"],"security":[{"eduzz_auth":["webhook_read"]}],"parameters":[{"name":"id","in":"query","required":true,"description":"Id do contato","schema":{"type":"string","description":"Id do contato"}},{"name":"email","in":"query","required":true,"description":"Email do contato","schema":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$","description":"Email do contato"}}],"responses":{"200":{"description":"Lista inscrições com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da Inscrição","sample":"yaeung4oaxt25pi0bzzycoezf","example":"yaeung4oaxt25pi0bzzycoezf"},"secretId":{"type":"string","description":"Id do Secret","sample":"87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180","example":"87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180"},"name":{"type":"string","description":"Nome da Inscrição","sample":"luno Assistiu a Aula","example":"luno Assistiu a Aula"},"status":{"type":"string","description":"Status da Inscrição","sample":"active","example":"active"},"url":{"type":"string","description":"Url do Webhook","sample":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0","example":"https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0"},"events":{"type":"array","items":{"type":"string","sample":"nutror.lesson_watched","example":"nutror.lesson_watched"},"description":"Eventos do Webhook","sample":"eventos do contato","example":"eventos do contato"}},"required":["id","secretId","name","status","url","events"],"additionalProperties":false},"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","in":"path","required":true,"description":"Id do evento","schema":{"type":"string","description":"Id do evento","sample":"12345","example":"12345"}}],"responses":{"204":{"description":"Exclusão feita com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false},"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","in":"path","required":true,"description":"Id do evento","schema":{"type":"string","description":"Id do evento","sample":"12345","example":"12345"}}],"requestBody":{"description":"Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status a ser Setado","sample":"active","example":"active"}},"required":["status"],"additionalProperties":false}}}},"responses":{"200":{"description":"Webhook alterado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id do contato","sample":"123","example":"123"}},"required":["id"],"additionalProperties":false},"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","description":"Id da Configuração do WebHook","sample":"gklzq82g9l0daazesebit6hds","example":"gklzq82g9l0daazesebit6hds"},"event":{"type":"string","description":"Nome do Evento","sample":"test.event_one","example":"test.event_one"}},"required":["subscriptionId","event"],"additionalProperties":false}}}},"responses":{"200":{"description":"Teste de webhook recebido com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code do WebHook","sample":"200","example":"200"},"body":{"type":"string","description":"Body retornado pela URL do WebHook","sample":"200","example":"200"},"timeTaken":{"type":"number","description":"Latência do processo e envio de WebHook em milisegundos","sample":"317","example":"317"}},"required":["statusCode","body","timeTaken"],"additionalProperties":false},"examples":{"default":{"value":{"statusCode":200,"body":"{\"message\":\"Workflow was started\"}","timeTaken":322}}}}}},"404":{"description":"Falha ao receber webhook teste","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code do WebHook","sample":"200","example":"200"},"body":{"type":"string","description":"Body retornado pela URL do WebHook","sample":"200","example":"200"},"timeTaken":{"type":"number","description":"Latência do processo e envio de WebHook em milisegundos","sample":"317","example":"317"}},"required":["statusCode","body","timeTaken"],"additionalProperties":false},"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","in":"path","required":true,"description":"Identificador do evento","schema":{"type":"string","description":"Identificador do evento","sample":"nutror.lesson_watched","example":"nutror.lesson_watched"}}],"responses":{"200":{"description":"Exemplo do evento buscado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id do contato","sample":"123","example":"123"}},"required":["id"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da Origin","sample":"guab3fmaixba8twqr7mrezg6u","example":"guab3fmaixba8twqr7mrezg6u"},"name":{"type":"string","description":"Nome da Origin","sample":"Nutror","example":"Nutror"},"prefix":{"type":"string","description":"Prefixo da Origin","sample":"nutror","example":"nutror"},"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do Evento","sample":"nutror.lesson_rated","example":"nutror.lesson_rated"},"metadata":{"type":"array","items":{"type":"string","sample":"producerId","example":"producerId"},"description":"Metadados do Evento","sample":"Metadados do Evento","example":"Metadados do Evento"},"description":{"type":"string","description":"Descrição do Evento","sample":"Aluno avaliou uma aula","example":"Aluno avaliou uma aula"}},"required":["name","metadata","description"],"additionalProperties":false,"description":"Evento"},"description":"Eventos"}},"required":["id","name","prefix","events"],"additionalProperties":false},"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":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Id da Secret","sample":"o01re8ty3kanab3ufi5ref0s3","example":"o01re8ty3kanab3ufi5ref0s3"},"name":{"type":"string","description":"Nome da Secret","sample":"APP: 5aeed2e8-869f-41d3-ae0d-3f322236f395","example":"APP: 5aeed2e8-869f-41d3-ae0d-3f322236f395"},"appId":{"type":"string","description":"Id do App","sample":"5aeed2e8-869f-41d3-ae0d-3f322236f395","example":"5aeed2e8-869f-41d3-ae0d-3f322236f395"},"secret":{"type":"string","description":"Segredo de validação do Webhook","sample":"edzwgd_T9fKNbk0MG6jNRFUcyIcjknSCd6K0M7Z4xbojWnoj8xPQeWKuX","example":"edzwgd_T9fKNbk0MG6jNRFUcyIcjknSCd6K0M7Z4xbojWnoj8xPQeWKuX"},"default":{"type":"boolean","description":"Secret padrão","sample":"false","example":"false"}},"required":["id","name","appId","secret","default"],"additionalProperties":false},"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":{}}}}}}}