# LaundryAPI

## API Docs
- Authentication [Signup](https://9pr75b24d6.apidog.io/signup-15613781e0.md): This endpoint allows new users to create an account by providing their email, phon number, password, and full name. After successful registration, a verification code is sent to the user whatsApp.
- Authentication [Resend Verification Code](https://9pr75b24d6.apidog.io/resend-verification-code-15613783e0.md): This endpoint allows users to request a new verification code if they haven’t received or lost the previous one. It can be used in  **Email / phone number Verification:** When verifying an Email / phone number for the first time.
- Authentication [Verify phone number](https://9pr75b24d6.apidog.io/verify-phone-number-15613784e0.md): This endpoint verifies a user’s phone number using a unique verification code sent to their email. Upon successful verification, the user receives an access token for authentication.
- Authentication [Login](https://9pr75b24d6.apidog.io/login-15613785e0.md): This endpoint allows registered users to log in by providing their email and password. Upon successful authentication, an access token is returned for authorization in subsequent requests.
- Authentication [Refresh Token](https://9pr75b24d6.apidog.io/refresh-token-15613786e0.md): This endpoint generates a new access token for authenticated users, allowing them to stay logged in without needing to re-enter credentials. It should be called when the current access token expires.
- Authentication [Forgot Password](https://9pr75b24d6.apidog.io/forgot-password-15613787e0.md): This endpoint allows users to initiate the password reset process. If a user forgets their password, they can provide their registered email address, and a verification code will be sent to that email. This code can then be used to reset the password.
- Authentication [Reset Password](https://9pr75b24d6.apidog.io/reset-password-15613788e0.md): This endpoint allows users to reset their password after initiating the **Forgot Password** process. The user must provide the verification code sent to their email and the new password in the request body. Upon a successful request, a new access token will be generated and returned.
- Authentication [Update Password](https://9pr75b24d6.apidog.io/update-password-15613789e0.md): This endpoint allows users to update their password. To use this endpoint, you must be logged in and provide your current password for verification, along with the new password. Upon a successful request, a new access token will be generated and returned.
- Authentication [Logout](https://9pr75b24d6.apidog.io/logout-15613791e0.md): This endpoint allows users to log out of their session. Upon a successful request, the server will invalidate the user's current authentication token, effectively ending their session.EndFragment
- Users [Get Me](https://9pr75b24d6.apidog.io/get-me-15613792e0.md): Retrieves the currently logged-in user's profile information. Requires authorization. The user must be authenticated to access this endpoint.
- Users [Update Me](https://9pr75b24d6.apidog.io/update-me-15613793e0.md): Updates the logged-in user's profile information. Requires authorization. The user must be authenticated to make changes to their own data.
- Users [Delete Me](https://9pr75b24d6.apidog.io/delete-me-15613794e0.md): Deletes the logged-in user's account. Requires authorization. The user must be authenticated and provide their password to confirm the deletion.
- Users [Get All Users](https://9pr75b24d6.apidog.io/get-all-users-15613795e0.md): 🔒 **Admin Only** | **Retrieves a list of all users.**  
- Users [Update User](https://9pr75b24d6.apidog.io/update-user-15613796e0.md): 🔒 **Admin Only** | **Update a user's information.**  
- Users [Delete User](https://9pr75b24d6.apidog.io/delete-user-15613797e0.md): 🔒 **Admin Only** | **Deletes a user by ID.**
- Users [Create Delivery](https://9pr75b24d6.apidog.io/create-delivery-15796426e0.md): 🔒 Admin Only | Create New User With Delivery Role
- Users [Create Admin](https://9pr75b24d6.apidog.io/create-admin-15797377e0.md): 🔒 Admin Only | Create New User With Delivery Role
- Items [Get all items](https://9pr75b24d6.apidog.io/get-all-items-15808438e0.md): This end point can be used by all users to get the price list of the items
- Items [Get Single item](https://9pr75b24d6.apidog.io/get-single-item-15808442e0.md): 
- Items [Create item](https://9pr75b24d6.apidog.io/create-item-15808584e0.md): 
- Items [Update item](https://9pr75b24d6.apidog.io/update-item-15809587e0.md): 
- Items [Delete item](https://9pr75b24d6.apidog.io/delete-item-15810179e0.md): 
- Orders [Get all orders](https://9pr75b24d6.apidog.io/get-all-orders-15849075e0.md): allow user to get all their orders.
- Orders [Single Order](https://9pr75b24d6.apidog.io/single-order-15849784e0.md): 
- Orders [Create Order](https://9pr75b24d6.apidog.io/create-order-15848361e0.md): this end point allows users to place orders by providing the dates on pickup and delivery.
- Orders [Delete order](https://9pr75b24d6.apidog.io/delete-order-15849443e0.md): allow user to delete his order by providing the id
- Orders [Update Order](https://9pr75b24d6.apidog.io/update-order-15849923e0.md): this end point is uset to update an order, it differs based on the user requesting it.
- Branches [All Branches](https://9pr75b24d6.apidog.io/all-branches-15860943e0.md): This endpoint allows you to retrieve all branches.
- Branches [Single Branch](https://9pr75b24d6.apidog.io/single-branch-15861162e0.md): This end point retrieves a single branch
- Branches [branch's orders](https://9pr75b24d6.apidog.io/branchs-orders-15863309e0.md): This end point retrievs all the orders assigned to a specific branch 
- Branches [Nearest Branches](https://9pr75b24d6.apidog.io/nearest-branches-15861301e0.md): This end point is used to retrieve the nearest laundry branches which is not more than `maxDistance`m away  for the location you provide in the request query params.
- Branches [Create Branch](https://9pr75b24d6.apidog.io/create-branch-15859845e0.md): This endpoint allows admin to create a new branch with its name, location, and weekly working schedule.
- Branches [update branch](https://9pr75b24d6.apidog.io/update-branch-15860624e0.md): This endpoint allows admins to update branch.
- Branches [Delete branch](https://9pr75b24d6.apidog.io/delete-branch-15860926e0.md): This endpoint allows admins to delete a branch.
- Notifications [All Notifications](https://9pr75b24d6.apidog.io/all-notifications-15878791e0.md): 
- Notifications [Create notification](https://9pr75b24d6.apidog.io/create-notification-15879453e0.md): Allow admin to create a new notification
- Notifications [Delete Notification](https://9pr75b24d6.apidog.io/delete-notification-15879462e0.md): 
- Banners [All Banners](https://9pr75b24d6.apidog.io/all-banners-15879463e0.md): 
- Banners [Create Banner](https://9pr75b24d6.apidog.io/create-banner-15879464e0.md): Allow admin to create a new banner
- Banners [Delete Banners](https://9pr75b24d6.apidog.io/delete-banners-15879465e0.md): 
- WhatsApp [initialize whatsapp Session](https://9pr75b24d6.apidog.io/initialize-whatsapp-session-17331355e0.md): This End-point is to allow admins to initialize the whatsApp Sesstion.