Comment changes and OpenApi spec changes

Author: su-shivanshmathur

api-reference-v2/openapi_spec.json

@@ -7929,6 +7929,7 @@
           "aci",
           "adyen",
           "airwallex",
+          "archipel",
           "authorizedotnet",
           "bambora",
           "bamboraapac",
@@ -10949,6 +10950,50 @@
           }
         }
       },
+      "GenericTokenizationRequest": {
+        "type": "object",
+        "required": [
+          "customer_id",
+          "token_request"
+        ],
+        "properties": {
+          "customer_id": {
+            "type": "string",
+            "description": "Customer ID for which the tokenization is requested",
+            "example": "12345_cus_01926c58bc6e77c09e809964e72af8c8"
+          },
+          "token_request": {
+            "type": "object",
+            "description": "Request for tokenization which contains the data to be tokenized"
+          }
+        }
+      },
+      "GenericTokenizationResponse": {
+        "type": "object",
+        "required": [
+          "id",
+          "created_at",
+          "flag"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier returned by the tokenization service",
+            "example": "12345_tok_01926c58bc6e77c09e809964e72af8c8"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Created time of the tokenization id",
+            "example": "2024-02-24T11:04:09.922Z"
+          },
+          "flag": {
+            "type": "string",
+            "description": "Status of the tokenization id created",
+            "example": "enabled"
+          }
+        }
+      },
       "GiftCardAdditionalData": {
         "oneOf": [
           {
@@ -13804,7 +13849,8 @@
           "trigger_api",
           "display_bank_transfer_information",
           "display_wait_screen",
-          "collect_otp"
+          "collect_otp",
+          "redirect_inside_popup"
         ]
       },
       "NoThirdPartySdkSessionResponse": {
@@ -18118,6 +18164,11 @@
             "type": "boolean",
             "description": "Indicates if 3ds challenge is forced",
             "nullable": true
+          },
+          "is_iframe_redirection_enabled": {
+            "type": "boolean",
+            "description": "Indicates if the redirection has to open in the iframe",
+            "nullable": true
           }
         },
         "additionalProperties": false
@@ -18289,6 +18340,11 @@
             ],
             "default": "no_three_ds",
             "nullable": true
+          },
+          "is_iframe_redirection_enabled": {
+            "type": "boolean",
+            "description": "Indicates if the redirection has to open in the iframe",
+            "nullable": true
           }
         }
       },
@@ -20091,6 +20147,11 @@
             ],
             "nullable": true
           },
+          "is_iframe_redirection_enabled": {
+            "type": "boolean",
+            "description": "Indicates if the redirection has to open in the iframe",
+            "nullable": true
+          },
           "is_external_vault_enabled": {
             "type": "boolean",
             "description": "Indicates if external vault is enabled or not.",
@@ -20354,6 +20415,11 @@
             ],
             "nullable": true
           },
+          "is_iframe_redirection_enabled": {
+            "type": "boolean",
+            "description": "Indicates if the redirection has to open in the iframe",
+            "nullable": true
+          },
           "is_external_vault_enabled": {
             "type": "boolean",
             "description": "Indicates if external vault is enabled or not.",
@@ -21435,6 +21501,7 @@
           "aci",
           "adyen",
           "airwallex",
+          "archipel",
           "authorizedotnet",
           "bankofamerica",
           "billwerk",

crates/api_models/src/payment_methods.rs

@@ -2884,7 +2884,7 @@ pub struct PaymentMethodsSessionUpdateRequest {
 
     /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data
     #[schema(value_type = Option<serde_json::Value>)]
-    pub tokenization_data: Option<masking::Secret<serde_json::Value>>,
+    pub tokenization_data: Option<pii::SecretSerdeValue>,
 }
 
 #[cfg(feature = "v2")]
@@ -2951,7 +2951,7 @@ pub struct PaymentMethodSessionResponse {
 
     /// Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data
     #[schema(value_type = Option<serde_json::Value>)]
-    pub tokenization_data: Option<masking::Secret<serde_json::Value>>,
+    pub tokenization_data: Option<pii::SecretSerdeValue>,
 
     /// The iso timestamp when the session will expire
     /// Trying to retrieve the session or any operations on the session after this time will result in an error

crates/api_models/src/tokenization.rs

@@ -8,27 +8,23 @@ use utoipa::{schema, ToSchema};
 #[cfg(all(feature = "v2", feature = "tokenization_v2"))]
 #[derive(Debug, Serialize, Deserialize, ToSchema)]
 pub struct GenericTokenizationResponse {
+    /// Unique identifier returned by the tokenization service
     #[schema(value_type = String, example = "12345_tok_01926c58bc6e77c09e809964e72af8c8")]
     pub id: GlobalTokenId,
+    /// Created time of the tokenization id
     #[schema(value_type = PrimitiveDateTime,example = "2024-02-24T11:04:09.922Z")]
     pub created_at: PrimitiveDateTime,
+    /// Status of the tokenization id created
     #[schema(value_type = String,example = "enabled")]
     pub flag: common_enums::TokenizationFlag,
 }
 #[cfg(all(feature = "v2", feature = "tokenization_v2"))]
 #[derive(Debug, Serialize, Deserialize, ToSchema)]
 pub struct GenericTokenizationRequest {
-    // Customer ID for which the tokenization is requested
+    /// Customer ID for which the tokenization is requested
     #[schema(value_type = String, example = "12345_cus_01926c58bc6e77c09e809964e72af8c8")]
     pub customer_id: GlobalCustomerId,
-    // Request for tokenization which contains the data to be tokenized
+    /// Request for tokenization which contains the data to be tokenized
     #[schema(value_type = Object,example = json!({ "city": "NY", "unit": "245" }))]
     pub token_request: masking::Secret<serde_json::Value>,
 }
-
-#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
-#[derive(Default, Debug, serde::Deserialize, serde::Serialize, Clone)]
-pub struct TokenizationQueryParameters {
-    // Parameter to view tokenization data or not
-    pub reveal: Option<bool>,
-}

crates/diesel_models/src/payment_methods_session.rs

@@ -1,3 +1,5 @@
+use common_utils::pii;
+
 #[cfg(feature = "v2")]
 #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)]
 pub struct PaymentMethodSession {
@@ -6,7 +8,7 @@ pub struct PaymentMethodSession {
     pub billing: Option<common_utils::encryption::Encryption>,
     pub psp_tokenization: Option<common_types::payment_methods::PspTokenization>,
     pub network_tokenization: Option<common_types::payment_methods::NetworkTokenization>,
-    pub tokenization_data: Option<masking::Secret<serde_json::Value>>,
+    pub tokenization_data: Option<pii::SecretSerdeValue>,
     pub return_url: Option<common_utils::types::Url>,
     #[serde(with = "common_utils::custom_serde::iso8601")]
     pub expires_at: time::PrimitiveDateTime,

crates/diesel_models/src/query.rs

@@ -39,6 +39,8 @@ pub mod relay;
 pub mod reverse_lookup;
 pub mod role;
 pub mod routing_algorithm;
+#[cfg(feature = "tokenization_v2")]
+pub mod tokenization;
 pub mod unified_translations;
 pub mod user;
 pub mod user_authentication_method;

crates/diesel_models/src/query/tokenization.rs

@@ -0,0 +1,43 @@
+#[cfg(feature = "v2")]
+use common_enums;
+#[cfg(feature = "v2")]
+use common_utils::{
+    id_type::{GlobalTokenId, MerchantId},
+    tokenization as tokenization_utils,
+};
+#[cfg(feature = "v2")]
+use diesel::{
+    associations::HasTable,
+    deserialize::FromSqlRow,
+    expression::AsExpression,
+    pg::Pg,
+    serialize::{Output, ToSql},
+    sql_types::{Jsonb, Text},
+    AsChangeset, Identifiable, Insertable, Queryable, Selectable,
+};
+#[cfg(feature = "v2")]
+use serde::{Deserialize, Serialize};
+#[cfg(feature = "v2")]
+use time::PrimitiveDateTime;
+
+#[cfg(feature = "v2")]
+use crate::{query::generics, schema_v2::tokenization, PgPooledConn, StorageResult, tokenization as tokenization_diesel};
+
+#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
+impl tokenization_diesel::Tokenization {
+    pub async fn insert(self, conn: &PgPooledConn) -> StorageResult<Self> {
+        generics::generic_insert(conn, self).await
+    }
+
+    pub async fn find_by_id(
+        conn: &PgPooledConn,
+        id: &common_utils::id_type::GlobalTokenId,
+    ) -> StorageResult<Self> {
+        use diesel::ExpressionMethods;
+        generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
+            conn,
+            tokenization::dsl::id.eq(id.to_owned()),
+        )
+        .await
+    }
+}

crates/diesel_models/src/tokenization.rs

@@ -37,21 +37,6 @@ pub struct Tokenization {
     pub version: common_enums::enums::ApiVersion,
 }
 
-#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
-impl Tokenization {
-    pub async fn find_by_id(
-        conn: &PgPooledConn,
-        id: &common_utils::id_type::GlobalTokenId,
-    ) -> StorageResult<Self> {
-        use diesel::ExpressionMethods;
-        generics::generic_find_one::<<Self as HasTable>::Table, _, _>(
-            conn,
-            tokenization::dsl::id.eq(id.to_owned()),
-        )
-        .await
-    }
-}
-
 #[cfg(all(feature = "v2", feature = "tokenization_v2"))]
 #[derive(Clone, Debug, Insertable)]
 #[diesel(table_name = tokenization)]
@@ -66,12 +51,7 @@ pub struct TokenizationNew {
     pub flag: common_enums::enums::TokenizationFlag,
 }
 
-#[cfg(all(feature = "v2", feature = "tokenization_v2"))]
-impl Tokenization {
-    pub async fn insert(self, conn: &PgPooledConn) -> StorageResult<Self> {
-        generics::generic_insert(conn, self).await
-    }
-}
+
 
 #[cfg(all(feature = "v2", feature = "tokenization_v2"))]
 #[derive(Clone, Debug, AsChangeset)]

crates/openapi/src/openapi_v2.rs

@@ -729,6 +729,8 @@ Never share your secret api keys. Keep them guarded and secure.
         api_models::process_tracker::revenue_recovery::RevenueRecoveryResponse,
         api_models::enums::ProcessTrackerStatus,
         routes::payments::ForceSync,
+        api_models::tokenization::GenericTokenizationRequest,
+        api_models::tokenization::GenericTokenizationResponse,
     )),
     modifiers(&SecurityAddon)
 )]