feat(customer_v2): Add customer V2 delete api

api-reference-v2/openapi_spec.json

@@ -5203,13 +5203,14 @@
       "CustomerDeleteResponse": {
         "type": "object",
         "required": [
-          "customer_id",
+          "merchant_reference_id",
           "customer_deleted",
           "address_deleted",
-          "payment_methods_deleted"
+          "payment_methods_deleted",
+          "id"
         ],
         "properties": {
-          "customer_id": {
+          "merchant_reference_id": {
             "type": "string",
             "description": "The identifier for the customer object",
             "example": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
@@ -5229,6 +5230,10 @@
             "type": "boolean",
             "description": "Whether payment methods deleted or not",
             "example": false
+          },
+          "id": {
+            "type": "string",
+            "description": "Global id"
           }
         }
       },

crates/api_models/src/customers.rs

@@ -352,6 +352,7 @@ impl CustomerId {
     }
 }
 
+#[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
 #[derive(Debug, Deserialize, Serialize, ToSchema)]
 pub struct CustomerDeleteResponse {
     /// The identifier for the customer object
@@ -368,6 +369,26 @@ pub struct CustomerDeleteResponse {
     pub payment_methods_deleted: bool,
 }
 
+#[cfg(all(feature = "v2", feature = "customer_v2"))]
+#[derive(Debug, Deserialize, Serialize, ToSchema)]
+pub struct CustomerDeleteResponse {
+    /// The identifier for the customer object
+    #[schema(value_type = String, max_length = 255, example = "cus_y3oqhf46pyzuxjbcn2giaqnb44")]
+    pub merchant_reference_id: Option<id_type::CustomerId>,
+    /// Whether customer was deleted or not
+    #[schema(example = false)]
+    pub customer_deleted: bool,
+    /// Whether address was deleted or not
+    #[schema(example = false)]
+    pub address_deleted: bool,
+    /// Whether payment methods deleted or not
+    #[schema(example = false)]
+    pub payment_methods_deleted: bool,
+    /// Global id
+    pub id: String,
+}
+
+/// The identifier for the customer object. If not provided the customer ID will be autogenerated.
 #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
 #[derive(Debug, Default, Clone, Deserialize, Serialize, ToSchema)]
 pub struct CustomerUpdateRequest {

crates/api_models/src/events/customer.rs

@@ -1,10 +1,12 @@
 use common_utils::events::{ApiEventMetric, ApiEventsType};
 
+#[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
+use crate::customers::CustomerId;
 #[cfg(all(feature = "v2", feature = "customer_v2"))]
 use crate::customers::GlobalId;
-#[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
-use crate::customers::{CustomerDeleteResponse, CustomerId};
-use crate::customers::{CustomerRequest, CustomerResponse, CustomerUpdateRequest};
+use crate::customers::{
+    CustomerDeleteResponse, CustomerRequest, CustomerResponse, CustomerUpdateRequest,
+};
 
 #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
 impl ApiEventMetric for CustomerDeleteResponse {
@@ -15,6 +17,15 @@ impl ApiEventMetric for CustomerDeleteResponse {
     }
 }
 
+#[cfg(all(feature = "v2", feature = "customer_v2"))]
+impl ApiEventMetric for CustomerDeleteResponse {
+    fn get_api_event_type(&self) -> Option<ApiEventsType> {
+        Some(ApiEventsType::Customer {
+            id: self.id.clone(),
+        })
+    }
+}
+
 #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
 impl ApiEventMetric for CustomerRequest {
     fn get_api_event_type(&self) -> Option<ApiEventsType> {

crates/common_enums/src/enums.rs

@@ -10,11 +10,11 @@ pub mod diesel_exports {
         DbAuthenticationType as AuthenticationType, DbBlocklistDataKind as BlocklistDataKind,
         DbCaptureMethod as CaptureMethod, DbCaptureStatus as CaptureStatus,
         DbConnectorType as ConnectorType, DbCountryAlpha2 as CountryAlpha2, DbCurrency as Currency,
-        DbDisputeStage as DisputeStage, DbDisputeStatus as DisputeStatus, DbEventType as EventType,
-        DbFraudCheckStatus as FraudCheckStatus, DbFutureUsage as FutureUsage,
-        DbIntentStatus as IntentStatus, DbMandateStatus as MandateStatus,
-        DbPaymentMethodIssuerCode as PaymentMethodIssuerCode, DbPaymentType as PaymentType,
-        DbRefundStatus as RefundStatus,
+        DbDeleteStatus as DeleteStatus, DbDisputeStage as DisputeStage,
+        DbDisputeStatus as DisputeStatus, DbFraudCheckStatus as FraudCheckStatus,
+        DbFutureUsage as FutureUsage, DbIntentStatus as IntentStatus,
+        DbMandateStatus as MandateStatus, DbPaymentMethodIssuerCode as PaymentMethodIssuerCode,
+        DbPaymentType as PaymentType, DbRefundStatus as RefundStatus,
         DbRequestIncrementalAuthorization as RequestIncrementalAuthorization,
         DbWebhookDeliveryAttempt as WebhookDeliveryAttempt,
     };
@@ -3135,3 +3135,23 @@ pub enum OrderFulfillmentTimeOrigin {
     Create,
     Confirm,
 }
+
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Eq,
+    PartialEq,
+    serde::Deserialize,
+    serde::Serialize,
+    strum::Display,
+    strum::EnumString,
+    ToSchema,
+)]
+#[router_derive::diesel_enum(storage_type = "db_enum")]
+#[strum(serialize_all = "snake_case")]
+#[serde(rename_all = "snake_case")]
+pub enum DeleteStatus {
+    Active,
+    Redacted,
+}

crates/diesel_models/src/customers.rs

@@ -1,10 +1,10 @@
-// #[cfg(all(feature = "v2", feature = "customer_v2"))]
-// use crate::enums::SoftDeleteStatus;
 use common_enums::ApiVersion;
 use common_utils::{encryption::Encryption, pii, types::Description};
 use diesel::{AsChangeset, Identifiable, Insertable, Queryable, Selectable};
 use time::PrimitiveDateTime;
 
+#[cfg(all(feature = "v2", feature = "customer_v2"))]
+use crate::enums::DeleteStatus;
 #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
 use crate::schema::customers;
 #[cfg(all(feature = "v2", feature = "customer_v2"))]
@@ -32,21 +32,6 @@ pub struct CustomerNew {
     pub version: ApiVersion,
 }
 
-#[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
-impl Customer {
-    pub fn get_customer_id(&self) -> common_utils::id_type::CustomerId {
-        self.customer_id.clone()
-    }
-}
-
-#[cfg(all(feature = "v2", feature = "customer_v2"))]
-impl Customer {
-    #[allow(clippy::todo)]
-    pub fn get_customer_id(&self) -> common_utils::id_type::CustomerId {
-        todo!()
-    }
-}
-
 #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
 impl CustomerNew {
     pub fn update_storage_scheme(&mut self, storage_scheme: common_enums::MerchantStorageScheme) {
@@ -77,8 +62,6 @@ impl From<CustomerNew> for Customer {
     }
 }
 
-// V2 customer
-
 #[cfg(all(feature = "v2", feature = "customer_v2"))]
 #[derive(
     Clone,
@@ -107,7 +90,7 @@ pub struct CustomerNew {
     pub merchant_reference_id: Option<common_utils::id_type::CustomerId>,
     pub default_billing_address: Option<Encryption>,
     pub default_shipping_address: Option<Encryption>,
-    // pub status: Option<SoftDeleteStatus>,
+    pub status: DeleteStatus,
     pub id: String,
 }
 
@@ -138,8 +121,8 @@ impl From<CustomerNew> for Customer {
             default_billing_address: customer_new.default_billing_address,
             default_shipping_address: customer_new.default_shipping_address,
             id: customer_new.id,
-            // status: customer_new.status,
             version: customer_new.version,
+            status: customer_new.status,
         }
     }
 }
@@ -189,7 +172,7 @@ pub struct Customer {
     pub merchant_reference_id: Option<common_utils::id_type::CustomerId>,
     pub default_billing_address: Option<Encryption>,
     pub default_shipping_address: Option<Encryption>,
-    // pub status: Option<SoftDeleteStatus>,
+    pub status: DeleteStatus,
     pub id: String,
 }
 
@@ -264,6 +247,7 @@ pub struct CustomerUpdateInternal {
     pub updated_by: Option<String>,
     pub default_billing_address: Option<Encryption>,
     pub default_shipping_address: Option<Encryption>,
+    pub status: Option<DeleteStatus>,
 }
 
 #[cfg(all(feature = "v2", feature = "customer_v2"))]
@@ -277,10 +261,10 @@ impl CustomerUpdateInternal {
             phone_country_code,
             metadata,
             connector_customer,
-            // address_id,
             default_payment_method_id,
             default_billing_address,
             default_shipping_address,
+            status,
             ..
         } = self;
 
@@ -293,14 +277,14 @@ impl CustomerUpdateInternal {
             metadata: metadata.map_or(source.metadata, Some),
             modified_at: common_utils::date_time::now(),
             connector_customer: connector_customer.map_or(source.connector_customer, Some),
-            // address_id: address_id.map_or(source.address_id, Some),
             default_payment_method_id: default_payment_method_id
                 .flatten()
                 .map_or(source.default_payment_method_id, Some),
             default_billing_address: default_billing_address
                 .map_or(source.default_billing_address, Some),
             default_shipping_address: default_shipping_address
                 .map_or(source.default_shipping_address, Some),
+            status: status.unwrap_or(source.status),
             ..source
         }
     }

crates/diesel_models/src/enums.rs

@@ -6,9 +6,9 @@ pub mod diesel_exports {
         DbCaptureMethod as CaptureMethod, DbCaptureStatus as CaptureStatus,
         DbConnectorStatus as ConnectorStatus, DbConnectorType as ConnectorType,
         DbCountryAlpha2 as CountryAlpha2, DbCurrency as Currency,
-        DbDashboardMetadata as DashboardMetadata, DbDisputeStage as DisputeStage,
-        DbDisputeStatus as DisputeStatus, DbEventClass as EventClass,
-        DbEventObjectType as EventObjectType, DbEventType as EventType,
+        DbDashboardMetadata as DashboardMetadata, DbDeleteStatus as DeleteStatus,
+        DbDisputeStage as DisputeStage, DbDisputeStatus as DisputeStatus,
+        DbEventClass as EventClass, DbEventObjectType as EventObjectType, DbEventType as EventType,
         DbFraudCheckStatus as FraudCheckStatus, DbFraudCheckType as FraudCheckType,
         DbFutureUsage as FutureUsage, DbGenericLinkType as GenericLinkType,
         DbIntentStatus as IntentStatus, DbMandateStatus as MandateStatus,

crates/diesel_models/src/query/mandate.rs

@@ -61,6 +61,12 @@ impl Mandate {
         .await
     }
 
+    //Fix this function once V2 mandate is schema is being built
+    #[cfg(all(feature = "v2", feature = "customer_v2"))]
+    pub async fn find_by_global_id(_conn: &PgPooledConn, _id: &str) -> StorageResult<Vec<Self>> {
+        todo!()
+    }
+
     pub async fn update_by_merchant_id_mandate_id(
         conn: &PgPooledConn,
         merchant_id: &common_utils::id_type::MerchantId,

crates/diesel_models/src/query/payment_method.rs

@@ -126,6 +126,16 @@ impl PaymentMethod {
         .await
     }
 
+    // Need to fix this function once we start moving to v2 for payment method
+    #[cfg(all(feature = "v2", feature = "customer_v2"))]
+    pub async fn find_by_global_id(
+        _conn: &PgPooledConn,
+        _id: &str,
+        _limit: Option<i64>,
+    ) -> StorageResult<Vec<Self>> {
+        todo!()
+    }
+
     pub async fn get_count_by_customer_id_merchant_id_status(
         conn: &PgPooledConn,
         customer_id: &common_utils::id_type::CustomerId,

crates/diesel_models/src/schema_v2.rs

@@ -317,6 +317,7 @@ diesel::table! {
         merchant_reference_id -> Nullable<Varchar>,
         default_billing_address -> Nullable<Bytea>,
         default_shipping_address -> Nullable<Bytea>,
+        status -> DeleteStatus,
         #[max_length = 64]
         id -> Varchar,
     }

crates/hyperswitch_domain_models/src/customer.rs

@@ -1,6 +1,6 @@
 use api_models::customers::CustomerRequestWithEncryption;
-// #[cfg(all(feature = "v2", feature = "customer_v2"))]
-// use common_enums::SoftDeleteStatus;
+#[cfg(all(feature = "v2", feature = "customer_v2"))]
+use common_enums::DeleteStatus;
 use common_utils::{
     crypto, date_time,
     encryption::Encryption,
@@ -56,9 +56,9 @@ pub struct Customer {
     pub merchant_reference_id: Option<id_type::CustomerId>,
     pub default_billing_address: Option<Encryption>,
     pub default_shipping_address: Option<Encryption>,
-    // pub status: Option<SoftDeleteStatus>,
     pub id: String,
     pub version: common_enums::ApiVersion,
+    pub status: DeleteStatus,
 }
 
 #[cfg(all(any(feature = "v1", feature = "v2"), not(feature = "customer_v2")))]
@@ -182,7 +182,7 @@ impl super::behaviour::Conversion for Customer {
             default_billing_address: self.default_billing_address.map(Encryption::from),
             default_shipping_address: self.default_shipping_address.map(Encryption::from),
             version: self.version,
-            // status: self.status,
+            status: self.status,
         })
     }
 
@@ -236,7 +236,7 @@ impl super::behaviour::Conversion for Customer {
             default_billing_address: item.default_billing_address,
             default_shipping_address: item.default_shipping_address,
             version: item.version,
-            // status: item.status,
+            status: item.status,
         })
     }
 
@@ -259,8 +259,8 @@ impl super::behaviour::Conversion for Customer {
             updated_by: self.updated_by,
             default_billing_address: self.default_billing_address,
             default_shipping_address: self.default_shipping_address,
-            // status: self.status,
             version: crate::consts::API_VERSION,
+            status: self.status,
         })
     }
 }
@@ -270,7 +270,7 @@ impl super::behaviour::Conversion for Customer {
 pub enum CustomerUpdate {
     Update {
         name: crypto::OptionalEncryptableName,
-        email: crypto::OptionalEncryptableEmail,
+        email: Box<crypto::OptionalEncryptableEmail>,
         phone: Box<crypto::OptionalEncryptablePhone>,
         description: Option<Description>,
         phone_country_code: Option<String>,
@@ -279,6 +279,7 @@ pub enum CustomerUpdate {
         default_billing_address: Option<Encryption>,
         default_shipping_address: Option<Encryption>,
         default_payment_method_id: Option<Option<String>>,
+        status: Option<DeleteStatus>,
     },
     ConnectorCustomer {
         connector_customer: Option<pii::SecretSerdeValue>,
@@ -303,6 +304,7 @@ impl From<CustomerUpdate> for CustomerUpdateInternal {
                 default_billing_address,
                 default_shipping_address,
                 default_payment_method_id,
+                status,
             } => Self {
                 name: name.map(Encryption::from),
                 email: email.map(Encryption::from),
@@ -316,6 +318,7 @@ impl From<CustomerUpdate> for CustomerUpdateInternal {
                 default_shipping_address,
                 default_payment_method_id,
                 updated_by: None,
+                status,
             },
             CustomerUpdate::ConnectorCustomer { connector_customer } => Self {
                 connector_customer,
@@ -330,6 +333,7 @@ impl From<CustomerUpdate> for CustomerUpdateInternal {
                 updated_by: None,
                 default_billing_address: None,
                 default_shipping_address: None,
+                status: None,
             },
             CustomerUpdate::UpdateDefaultPaymentMethod {
                 default_payment_method_id,
@@ -346,6 +350,7 @@ impl From<CustomerUpdate> for CustomerUpdateInternal {
                 updated_by: None,
                 default_billing_address: None,
                 default_shipping_address: None,
+                status: None,
             },
         }
     }