feat: add a domain type for customer_id

[Narayanbhat166]

Type of Change

• New feature

Description

This PR adds an id type to validate the reference id that we receive in the api.

Additional Changes

• This PR modifies the API contract
  Validations are added to the customer id
• Max length of 64 characters
• Min length of 1 character
• Should only contain alphanumeric characters and - and _.

Motivation and Context

How did you test it?

• Create a payment with valid customer_id - Success

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_eitT2K5ygdDjO4uYYKCMoZP0VWK9L9IkLJlfCjbaDzUygNUimJUWKTJx2IMLFYW6' \
--data '{
    "amount": 6540,
    "currency": "USD",
    "customer_id": "valid_customer_id"
}'

• customer_id with invalid characters

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_eitT2K5ygdDjO4uYYKCMoZP0VWK9L9IkLJlfCjbaDzUygNUimJUWKTJx2IMLFYW6' \
--data '{
    "amount": 6540,
    "currency": "USD",
    "customer_id": "invalid id"
}'

{
    "error": "Json deserialize error: value `invalid id` contains invalid character ` ` at line 5 column 1"
}

• customer_id with min length

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_eitT2K5ygdDjO4uYYKCMoZP0VWK9L9IkLJlfCjbaDzUygNUimJUWKTJx2IMLFYW6' \
--data '{
    "amount": 6540,
    "currency": "USD",
    "customer_id": ""
}'

{
    "error": "Json deserialize error: the minimum required length for this field is 1 at line 5 column 1"
}

• customer_id with max length

curl --location 'http://localhost:8080/payments' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'api-key: dev_eitT2K5ygdDjO4uYYKCMoZP0VWK9L9IkLJlfCjbaDzUygNUimJUWKTJx2IMLFYW6' \
--data '{
    "amount": 6540,
    "currency": "USD",
    "customer_id": "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuv"
}'

{
    "error": "Json deserialize error: the maximum allowed length for this field is 64 at line 5 column 1"
}

Unit test cases

Checklist

• I formatted the code cargo +nightly fmt --all
• I addressed lints thrown by cargo clippy
• I reviewed the submitted code
• I added unit tests for my changes where possible

[lsampras]

we can store the new type inside ApiEvents as long as it implements valid serialization

[Narayanbhat166]

Yes, I have already added the new type for ApiEvents

hyperswitch/crates/common_utils/src/events.rs

Line 29 in a44c742

customer_id: id_type::CustomerId,

The change here is that the mandatory field is made optional