diff --git a/README.md b/README.md index 7526a53..5649842 100644 --- a/README.md +++ b/README.md @@ -56,24 +56,187 @@ dotnet run ```

📍 API Endpoints

-## Endpoints de Admin +

Admin

| Rota | Descrição | |-----------------------------------------|--------------------------------------------------| | GET /v1/admins | Recupera uma lista de administradores | | DELETE /v1/admins | Exclui o administrador autenticado | -| PUT /v1/admins | Atualiza os detalhes de um administrador | +| PUT /v1/admins | Atualiza os detalhes do administrador autenticado | | GET /v1/admins/{Id} | Recupera os detalhes de um administrador pelo ID | | PUT /v1/admins/{Id} | Atualiza os detalhes de um administrador pelo ID | | DELETE /v1/admins/{Id} | Exclui um administrador pelo ID | | POST /v1/admins/{adminId}/permissions/{permissionId} | Adiciona uma permissão a um administrador pelo ID | | DELETE /v1/admins/{adminId}/permissions/{permissionId}| Remove uma permissão de um administrador pelo ID | | POST /v1/admins/to-root-admin/{toRootAdminId} | Promove um administrador a root pelo ID | -| PATCH /v1/admins/name | Atualiza o nome de um administrador | -| PATCH /v1/admins/email | Atualiza o email de um administrador | -| PATCH /v1/admins/phone | Atualiza o telefone de um administrador | -| PATCH /v1/admins/address | Atualiza o endereço de um administrador | -| PATCH /v1/admins/gender/{gender} | Atualiza o gênero de um administrador pelo ID | -| PATCH /v1/admins/date-of-birth | Atualiza a data de nascimento de um administrador | +| PATCH /v1/admins/name | Atualiza o nome do administrador autenticado | +| PATCH /v1/admins/email | Atualiza o email do administrador autenticado | +| PATCH /v1/admins/phone | Atualiza o telefone do administrador autenticado | +| PATCH /v1/admins/address | Atualiza o endereço do administrador autenticado | +| PATCH /v1/admins/gender | Atualiza o gênero do administrador autenticado | +| PATCH /v1/admins/date-of-birth | Atualiza a data de nascimento do administrador autenticado | + +

Customer

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/customers | Recupera uma lista de clientes | +| PUT /v1/customers | Atualiza os detalhes do cliente autenticado | +| DELETE /v1/customers | Exclui o cliente autenticado | +| GET /v1/customers/{Id} | Recupera os detalhes de um cliente pelo ID | +| PUT /v1/customers/{Id} | Atualiza os detalhes de um cliente pelo ID | +| DELETE /v1/customers/{Id} | Exclui um cliente pelo ID | +| PATCH /v1/customers/name | Atualiza o nome do cliente autenticado | +| PATCH /v1/customers/email | Atualiza o email do cliente autenticado | +| PATCH /v1/customers/phone | Atualiza o telefone do cliente autenticado | +| PATCH /v1/customers/address | Atualiza o endereço do cliente autenticado | +| PATCH /v1/customers/gender | Atualiza o gênero de um cliente pelo ID | +| PATCH /v1/customers/date-of-birth | Atualiza a data de nascimento do cliente autenticado | + +

Employee

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/employees | Recupera uma lista de funcionários | +| DELETE /v1/employees | Exclui o funcionário autenticado | +| PUT /v1/employees | Atualiza os detalhes do funcionário autenticado | +| GET /v1/employees/{id} | Recupera os detalhes de um funcionário pelo ID | +| PUT /v1/employees/{id} | Atualiza os detalhes de um funcionário pelo ID | +| DELETE /v1/employees/{id} | Exclui um funcionário pelo ID | +| POST /v1/employees/{id}/responsibilities/{resId} | Adiciona uma responsabilidade a um funcionário pelo ID | +| DELETE /v1/employees/{id}/responsibilities/{resId}| Remove uma responsabilidade de um funcionário pelo ID | +| POST /v1/employees/{employeeId}/permissions/{permissionId} | Adiciona uma permissão a um funcionário pelo ID | +| DELETE /v1/employees/{employeeId}/permissions/{permissionId} | Remove uma permissão de um funcionário pelo ID | +| PATCH /v1/employees/name | Atualiza o nome do funcionário autenticado | +| PATCH /v1/employees/email | Atualiza o email do funcionário autenticado | +| PATCH /v1/employees/phone | Atualiza o telefone do funcionário autenticado | +| PATCH /v1/employees/address | Atualiza o endereço do funcionário autenticado | +| PATCH /v1/employees/gender | Atualiza o gênero de um funcionário pelo ID | +| PATCH /v1/employees/date-of-birth | Atualiza a data de nascimento do funcionário autenticado | + +

Feedback

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/feedbacks | Recupera uma lista de feedbacks | +| POST /v1/feedbacks | Cria um novo feedback | +| GET /v1/feedbacks/{Id} | Recupera os detalhes de um feedback pelo ID | +| PUT /v1/feedbacks/{Id} | Atualiza os detalhes de um feedback pelo ID | +| DELETE /v1/feedbacks/{Id} | Exclui um feedback pelo ID | +| PATCH /v1/feedbacks/{Id}/rate/{rate} | Atualiza a avaliação de um feedback pelo ID | +| PATCH /v1/feedbacks/{Id}/comment | Atualiza o comentário de um feedback pelo ID | +| PATCH /v1/feedbacks/add-like/{feedbackId} | Adiciona um like a um feedback pelo ID | +| PATCH /v1/feedbacks/remove-like/{feedbackId} | Remove um like de um feedback pelo ID | +| PATCH /v1/feedbacks/add-dislike/{feedbackId} | Adiciona um dislike a um feedback pelo ID | +| PATCH /v1/feedbacks/remove-dislike/{feedbackId} | Remove um dislike de um feedback pelo ID | + +

Invoice

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/invoices | Recupera uma lista de faturas | +| GET /v1/invoices/my | Recupera as faturas do usuário autenticado | +| GET /v1/invoices/{Id} | Recupera os detalhes de uma fatura pelo ID | +| DELETE /v1/invoices/{Id}| Exclui uma fatura pelo ID | + +

Login

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| POST /v1/login | Realiza o login de qualquer tipo de usuário | + +

Permission

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/permissions | Recupera uma lista de permissões | +| GET /v1/permissions/{Id} | Recupera os detalhes de uma permissão pelo ID | + +

Register

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| POST /v1/register/customers | Registra um novo cliente | +| POST /v1/register/admins | Registra um novo administrador | +| POST /v1/register/employees | Registra um novo funcionário | + +

Report

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/reports | Recupera uma lista de relatórios | +| POST /v1/reports | Cria um novo relatório | +| GET /v1/reports/{Id} | Recupera os detalhes de um relatório pelo ID | +| PUT /v1/reports/{Id} | Atualiza os detalhes de um relatório pelo ID | +| DELETE /v1/reports/my/{Id} | Exclui um relatório do usuário atual pelo ID | +| PATCH /v1/reports/finish/{Id}| Finaliza um relatório pelo ID | +| PATCH /v1/reports/cancel/{Id}| Cancela um relatório pelo ID | +| PATCH /v1/reports/priority/{id} | Atualiza a prioridade de um relatório pelo ID | + +

Reservation

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/reservations | Recupera uma lista de reservas | +| GET /v1/reservations/{Id} | Recupera os detalhes de uma reserva pelo ID | +| POST /v1/reservations | Cria uma nova reserva | +| DELETE /v1/reservations/{Id} | Exclui uma reserva pelo ID | +| PATCH /v1/reservations/expected-check-out/{Id} | Atualiza o check-out esperado de uma reserva pelo ID | +| PATCH /v1/reservations/expected-check-in/{Id} | Atualiza o check-in esperado de uma reserva pelo ID | +| POST /v1/reservations/{Id}/services/{serviceId} | Adiciona um serviço a uma reserva pelo ID | +| DELETE /v1/reservations/{Id}/services/{serviceId}| Remove um serviço de uma reserva pelo ID | +| POST /v1/reservations/check-in/{Id} | Faz o check-in de uma reserva pelo ID | +| POST /v1/reservations/finish/{Id} | Finaliza uma reserva pelo ID | +| POST /v1/reservations/cancel/{Id} | Cancela uma reserva pelo ID | +| GET /v1/reservations/total-amount | Simula o preço total de uma reserva | + + +

Responsibility

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/responsibilities | Recupera uma lista de responsabilidades | +| POST /v1/responsibilities | Cria uma nova responsabilidade | +| GET /v1/responsibilities/{Id}| Recupera os detalhes de uma responsabilidade pelo ID | +| PUT /v1/responsibilities/{Id}| Atualiza os detalhes de uma responsabilidade pelo ID | +| DELETE /v1/responsibilities/{Id}| Exclui uma responsabilidade pelo ID | + +

Room

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/rooms | Recupera uma lista de quartos | +| GET /v1/rooms/{Id} | Recupera os detalhes de um quarto pelo ID | +| PUT /v1/rooms/{Id} | Atualiza os detalhes de um quarto pelo ID | +| POST /v1/rooms | Cria um novo quarto | +| DELETE /v1/rooms/{Id} | Exclui um quarto pelo ID | +| POST /v1/rooms/{Id}/services/{serviceId} | Adiciona um serviço a um quarto pelo ID | +| DELETE /v1/rooms/{Id}/services/{serviceId} | Remove um serviço de um quarto pelo ID | +| PATCH /v1/rooms/number/{Id} | Atualiza o número de um quarto pelo ID | +| PATCH /v1/rooms/name/{Id} | Atualiza o nome de um quarto pelo ID | +| PATCH /v1/rooms/capacity/{Id} | Atualiza a capacidade de um quarto pelo ID | +| PATCH /v1/rooms/category/{Id} | Atualiza a categoria de um quarto pelo ID | +| PATCH /v1/rooms/price/{Id} | Atualiza o preço de um quarto pelo ID | +| PATCH /v1/rooms/enable/{Id} | Ativa um quarto pelo ID | +| PATCH /v1/rooms/disable/{Id} | Desativa um quarto pelo ID | +| PATCH /v1/rooms/available/{Id}| Atualiza o status de 'fora de serviço' para 'disponível' de um quarto pelo ID | + +

Service

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| GET /v1/services | Recupera uma lista de serviços | +| POST /v1/services | Cria um novo serviço | +| GET /v1/services/{Id} | Recupera os detalhes de um serviço pelo ID | +| PUT /v1/services/{Id} | Atualiza os detalhes de um serviço pelo ID | +| DELETE /v1/services/{Id} | Exclui um serviço pelo ID | +| POST /v1/services/{Id}/responsibilities/{responsibilityId} | Adiciona uma responsabilidade a um serviço pelo ID | +| DELETE /v1/services/{Id}/responsibilities/{responsibilityId}| Remove uma responsabilidade de um serviço pelo ID | + +

Verification

+ +| Rota | Descrição | +|-----------------------------------------|--------------------------------------------------| +| POST /v1/verifications/email-code | Envia um código de verificação de email por emai |