feat(waitlist): Add create, get all and delete waitlist by id

[Reliable25]

Description

This PR introduces endpoints for managing waitlists, including creating a new waitlist entry, retrieving all waitlist entries, and deleting a waitlist entry by ID.

Features Implemented:

1. Create Waitlist: Allows users to create a new waitlist entry by providing an email address.
2. Get All Waitlists: Retrieves all waitlist entries.
3. Delete Waitlist: Deletes a specific waitlist entry by its ID.
4. Error Handling: Manages errors for invalid requests, existing entries, and unauthorized access. Closes #issue_number_here

Changes proposed

1. Create Waitlist

• Endpoint: POST /api/v1/waitlists
• Summary: Creates a new waitlist entry with the provided email.

Request Body:

{
  "name": "john"
  "email": "new@example.com"
}

Successful Response:

Status Code: 201 Created Response:

{
  "message": "Waitlist entry created successfully",
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "name": "user1",
    "email": "user1@example.com"
  }
}

Error Responses:

Conflict: Status Code: 400 Bad Request Response:

{
  "error": "Conflict",
  "message": "Email already exists in the waitlist",
  "data": false
}

2. Get All Waitlists

• Endpoint: GET /api/v1/waitlists

• Summary: Retrieves all waitlist entries.

• Successful Response:

• Status Code: 200 OK Response:

  {
  "message": "Waitlists retrieved successfully",
  "data": [
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "name": "user1"
    "email": "user1@example.com"
  },
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
    "name": "user2"
    "email": "user2@example.com"
  }
  // additional waitlists
  ]
  }

  Error Responses:

Bad Request: Status Code: 400 Bad Request Response:

{
  "error": "Bad Request",
  "message": "Error retrieving waitlists",
  "data": false
}

3. Delete Waitlist by ID

• Endpoint: DELETE /api/v1/waitlists/{id}
• Summary: Deletes a specific waitlist entry by its ID.
• Path Parameter:
• id (required, Guid) - The ID of the waitlist entry to delete. Successful Response: Status Code: 200 OK Response:

  {
  "message": "Waitlist deleted successfully",
  "data": true
  }

• Error Responses:
• Not Found:
• Status Code: 404 Not Found
• Response:

  {
  "error": "Not Found",
  "message": "Waitlist with ID {id} not found",
  "data": false
  }

  Bad Request: Status Code: 400 Bad Request Response:

  {
  "error": "Bad Request",
  "message": "Error deleting waitlist",
  "data": false
  }

  What were you told to do?

• Implement endpoints for creating, retrieving, and deleting waitlist entries.

What did you do?

• Created endpoints to manage waitlists, including creating a new entry, retrieving all entries, and deleting an entry by ID.
• Added error handling for common issues such as existing entries, non-existent entries, and general request errors.
• Documented each endpoint with clear request and response formats.

Check List (Check all the applicable boxes)

🚨Please review the contribution guideline for this repository.

• [x] My code follows the code style of this project.
• [x] This PR does not contain plagiarized content.
• [x] The title and description of the PR is clear and explains the approach.
• [x] I am making a pull request against the dev branch (left side).
• [x] My commit messages styles matches our requested structure.
• [x] My code additions will fail neither code linting checks nor unit test.
• [x] I am only making changes to files I was requested to.

Screenshots/Videos