refactor(payment_methods_v2): rename payment_method and payment_method_type fields and use concrete type for payment_method_data

[SanchithHegde]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

Description

This PR involves the following changes in payment methods v2 code:

• Renames the payment_method field to payment_method_type, and payment_method_type to payment_method_subtype. This change affect the database columns itself, the diesel models, the domain models and the API models.
• Updates the payment_method_data field in the domain model to have the concrete type wrapped by EncryptedJsonType, instead of the existing serde_json::Value type.
  • The EncryptedJsonType was also introduced in this PR. It adds support to use a concrete type in domain models, while handling the JSON serialization and deserialization before encryption and after decryption of data, respectively.

In addition, this PR removes the PaymentMethodList struct from the API models, which isn't being used anywhere.

By the way, I'm open to better name suggestions for the newly introduced things!

Additional Changes

• This PR modifies the API contract
• This PR modifies the database schema
• This PR modifies application configuration/environment variables

• This PR renames database columns in payment methods v2 code.
• This PR renames fields in payment methods v2 API models.
• This PR removes an unused type from the API models crate.

Motivation and Context

• The renaming of columns was suggested in refactor(payment_methods): refactor customer payment methods list v2 code to follow better code practices #6433 (comment). This also follows the changes done in the payment attempt v2 types for these two fields.
• Using of the concrete type in the domain models helps prevent JSON deserialization happening multiple times in different parts of the codebase.

How did you test it?

This PR mostly affects the payment methods v2 code, with focus on the customer payment methods list v2 code. I haven't been able to test these changes, there are still a couple of panics remaining in the customer payment methods list v2 code.

Ideally, nothing in the payment methods v1 code should be affected and existing Postman and Cypress tests should pass.

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

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
crates/router/src/core/payment_methods/surcharge_decision_configs.rs	96% smaller
crates/router/src/core/locker_migration.rs	85% smaller
crates/router/src/core/payments/operations/payment_confirm.rs	82% smaller
crates/router/src/types/transformers.rs	79% smaller
crates/router/src/core/customers.rs	61% smaller
crates/router/src/core/pm_auth.rs	61% smaller
crates/router/src/core/payments/tokenization.rs	58% smaller
crates/router/src/core/payment_methods/transformers.rs	39% smaller
crates/router/src/types/api/mandates.rs	31% smaller
crates/router/src/core/payments/helpers.rs	28% smaller
crates/openapi/src/openapi.rs	26% smaller
api-reference/openapi_spec.json	13% smaller
api-reference-v2/openapi_spec.json	13% smaller
crates/openapi/src/openapi_v2.rs	7% smaller
crates/hyperswitch_domain_models/src/payment_methods.rs	5% smaller
crates/router/src/types/domain/types.rs	4% smaller
crates/router/src/core/payment_methods/cards.rs	3% smaller
crates/hyperswitch_domain_models/src/type_encryption.rs	1% smaller
crates/api_models/src/events.rs	0% smaller
crates/api_models/src/events/payment.rs	0% smaller
crates/api_models/src/payment_methods.rs	0% smaller
crates/api_models/src/payments.rs	0% smaller
crates/diesel_models/src/payment_method.rs	0% smaller
crates/diesel_models/src/schema_v2.rs	0% smaller
crates/openapi/Cargo.toml	Unsupported file format
crates/router/src/core/payment_methods.rs	0% smaller
crates/router/src/core/payments.rs	0% smaller
crates/router/src/routes/payment_methods.rs	0% smaller
crates/router/src/types/api/payment_methods.rs	0% smaller
v2_migrations/2024-08-23-112510_payment_methods_v2_db_changes/down.sql	Unsupported file format
v2_migrations/2024-08-23-112510_payment_methods_v2_db_changes/up.sql	Unsupported file format

[jarnura]

What are case T required Debug? is that necessary.

[Narayanbhat166]

are we not changing the field name her?

[SanchithHegde]

Since renaming the field affects the analytics pipeline, we'd have to include ClickHouse migrations as well.
For now, I'm not including v2 changes in the analytics pipeline.

CC: @ShivanshMathurJuspay @tsdk02

[ShivanshMathurJuspay]

Are we renaming payment_method to payment_method_type ?