refactor(subscription): make invoice as an id type (#9488)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
Co-authored-by: Jagan <jaganelavarasan@gmail.com>

crates/common_utils/src/events.rs

@@ -86,6 +86,7 @@ pub enum ApiEventsType {
     },
     Routing,
     Subscription,
+    Invoice,
     ResourceListAPI,
     #[cfg(feature = "v1")]
     PaymentRedirectionResponse {

crates/common_utils/src/id_type.rs

@@ -7,6 +7,7 @@ mod client_secret;
 mod customer;
 #[cfg(feature = "v2")]
 mod global_id;
+mod invoice;
 mod merchant;
 mod merchant_connector_account;
 mod organization;
@@ -47,6 +48,7 @@ pub use self::{
     authentication::AuthenticationId,
     client_secret::ClientSecretId,
     customer::CustomerId,
+    invoice::InvoiceId,
     merchant::MerchantId,
     merchant_connector_account::MerchantConnectorAccountId,
     organization::OrganizationId,

crates/common_utils/src/id_type/invoice.rs

@@ -0,0 +1,21 @@
+crate::id_type!(
+    InvoiceId,
+    " A type for invoice_id that can be used for invoice ids"
+);
+
+crate::impl_id_type_methods!(InvoiceId, "invoice_id");
+
+// This is to display the `InvoiceId` as InvoiceId(subs)
+crate::impl_debug_id_type!(InvoiceId);
+crate::impl_try_from_cow_str_id_type!(InvoiceId, "invoice_id");
+
+crate::impl_generate_id_id_type!(InvoiceId, "invoice");
+crate::impl_serializable_secret_id_type!(InvoiceId);
+crate::impl_queryable_id_type!(InvoiceId);
+crate::impl_to_sql_from_sql_id_type!(InvoiceId);
+
+impl crate::events::ApiEventMetric for InvoiceId {
+    fn get_api_event_type(&self) -> Option<crate::events::ApiEventsType> {
+        Some(crate::events::ApiEventsType::Invoice)
+    }
+}

crates/diesel_models/src/invoice.rs

@@ -1,5 +1,5 @@
 use common_enums::connector_enums::{Connector, InvoiceStatus};
-use common_utils::{pii::SecretSerdeValue, types::MinorUnit};
+use common_utils::{id_type::GenerateId, pii::SecretSerdeValue, types::MinorUnit};
 use diesel::{AsChangeset, Identifiable, Insertable, Queryable, Selectable};
 use serde::{Deserialize, Serialize};
 
@@ -8,8 +8,8 @@ use crate::schema::invoice;
 #[derive(Clone, Debug, Eq, Insertable, PartialEq, Serialize, Deserialize)]
 #[diesel(table_name = invoice, check_for_backend(diesel::pg::Pg))]
 pub struct InvoiceNew {
-    pub id: String,
-    pub subscription_id: String,
+    pub id: common_utils::id_type::InvoiceId,
+    pub subscription_id: common_utils::id_type::SubscriptionId,
     pub merchant_id: common_utils::id_type::MerchantId,
     pub profile_id: common_utils::id_type::ProfileId,
     pub merchant_connector_id: common_utils::id_type::MerchantConnectorAccountId,
@@ -34,8 +34,8 @@ pub struct InvoiceNew {
     check_for_backend(diesel::pg::Pg)
 )]
 pub struct Invoice {
-    id: String,
-    subscription_id: String,
+    id: common_utils::id_type::InvoiceId,
+    subscription_id: common_utils::id_type::SubscriptionId,
     merchant_id: common_utils::id_type::MerchantId,
     profile_id: common_utils::id_type::ProfileId,
     merchant_connector_id: common_utils::id_type::MerchantConnectorAccountId,
@@ -62,8 +62,7 @@ pub struct InvoiceUpdate {
 impl InvoiceNew {
     #[allow(clippy::too_many_arguments)]
     pub fn new(
-        id: String,
-        subscription_id: String,
+        subscription_id: common_utils::id_type::SubscriptionId,
         merchant_id: common_utils::id_type::MerchantId,
         profile_id: common_utils::id_type::ProfileId,
         merchant_connector_id: common_utils::id_type::MerchantConnectorAccountId,
@@ -76,6 +75,7 @@ impl InvoiceNew {
         provider_name: Connector,
         metadata: Option<SecretSerdeValue>,
     ) -> Self {
+        let id = common_utils::id_type::InvoiceId::generate();
         let now = common_utils::date_time::now();
         Self {
             id,