[FEAT] Update Customer Details API

[SCCSMARTCODE]

Description

Create an API endpoint to update customer details. This endpoint will allow administrators to update customer information from the Customer Details Page efficiently and securely.

---

Acceptance Criteria

1. Endpoint Definition:

   • API endpoint to update customer details.

2. Functionality:

   • Admin can update customer details successfully.
   • Ensure only authorized users (admins) can update customer details.

3. Implementation Steps:

   • Define API Endpoint:
     • Define the API endpoint to update customer details.
   • Implement Logic:
     • Implement the logic to update customer information in the database.
   • Handle Responses:
     • Handle success and error responses, including invalid customer ID and unauthorized access.
   • Write Tests:
     • Write tests for the endpoint to ensure proper functionality.

---

Purpose

The purpose of this endpoint is to provide administrators with a secure and efficient way to update customer details. This will enhance the system's ability to maintain accurate and up-to-date customer information.

---

Requirements

• [ ] The API should follow RESTful standards.
• [ ] Ensure only authorized users (admins) can update customer details.
• [ ] Implement validation for the provided data.
• [ ] Handle both success and error responses appropriately.

---

Expected Outcome

• Successful implementation of the update customer details endpoint.
• Administrators can securely and efficiently update customer details.
• The system returns appropriate success and error responses based on the request.
• The endpoint is well-tested, ensuring reliability and correctness.

---

Example API Endpoint:

• Endpoint: PUT /api/v1/customers/:customerId

Request Example:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "address": "123 Main St, Anytown, USA"
}

Successful Response Example:

{
  "status": "success",
  "status_code": 200,
  "message": "Customer details updated successfully.",
  "customer": {
    "id": "customerId",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "address": "123 Main St, Anytown, USA"
  }
}

Error Response Examples:

1. Invalid Customer ID:

   {
    "status": "error",
    "message": "Invalid customer ID.",
    "status_code": 400
   }

2. Unauthorized Access:

   {
    "status": "error",
    "message": "Unauthorized access.",
    "status_code": 401
   }

---

Unit Testing

• [ ] Test that the customer details are updated successfully if a valid customer ID and valid data are provided.
• [ ] Test that an error is thrown when an invalid customer ID is passed as a parameter.
• [ ] Test that an error is thrown when a request is made without a valid token or by a non-admin user.

[SCCSMARTCODE]

Slack ID: SCCSMARTCODE