feat: add create retrieve and update api endpoints for organization resource

api-reference/openapi_spec.json

@@ -1109,6 +1109,111 @@
         ]
       }
     },
+    "/organization": {
+      "post": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Organization - Create",
+        "description": "Organization - Create\n\nCreate a new organization",
+        "operationId": "Create an Organization",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OrganizationRequest"
+              },
+              "examples": {
+                "Create an organization with organization_name": {
+                  "value": {
+                    "organization_name": "organization_abc"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Organization Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrganizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid data"
+          }
+        },
+        "security": [
+          {
+            "admin_api_key": []
+          }
+        ]
+      }
+    },
+    "/organization/{organization_id}": {
+      "post": {
+        "tags": [
+          "Organization"
+        ],
+        "summary": "Organization - Update",
+        "description": "Organization - Update\n\nCreate a new organization for .",
+        "operationId": "Create an Organization",
+        "parameters": [
+          {
+            "name": "organization_id",
+            "in": "path",
+            "description": "The unique identifier for the Organization",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OrganizationRequest"
+              },
+              "examples": {
+                "Update organization_name of the organization": {
+                  "value": {
+                    "organization_name": "organization_abcd"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Organization Created",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OrganizationResponse"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid data"
+          }
+        },
+        "security": [
+          {
+            "admin_api_key": []
+          }
+        ]
+      }
+    },
     "/accounts": {
       "post": {
         "tags": [
@@ -11294,7 +11399,10 @@
           "organization_id": {
             "type": "string",
             "description": "The id of the organization to which the merchant belongs to, if not passed an organization is created",
-            "nullable": true
+            "example": "org_q98uSGAYbjEwqs0mJwnz",
+            "nullable": true,
+            "maxLength": 64,
+            "minLength": 1
           },
           "pm_collect_link_config": {
             "allOf": [
@@ -11511,7 +11619,10 @@
           },
           "organization_id": {
             "type": "string",
-            "description": "The organization id merchant is associated with"
+            "description": "The organization id merchant is associated with",
+            "example": "org_q98uSGAYbjEwqs0mJwnz",
+            "maxLength": 64,
+            "minLength": 1
           },
           "is_recon_enabled": {
             "type": "boolean",
@@ -12899,6 +13010,33 @@
           }
         }
       },
+      "OrganizationRequest": {
+        "type": "object",
+        "properties": {
+          "organization_name": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
+      "OrganizationResponse": {
+        "type": "object",
+        "required": [
+          "organization_id"
+        ],
+        "properties": {
+          "organization_id": {
+            "type": "string",
+            "example": "org_q98uSGAYbjEwqs0mJwnz",
+            "maxLength": 64,
+            "minLength": 1
+          },
+          "organization_name": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
       "OutgoingWebhook": {
         "type": "object",
         "required": [

crates/api_models/src/admin.rs

@@ -108,7 +108,8 @@ pub struct MerchantAccountCreate {
     pub frm_routing_algorithm: Option<serde_json::Value>,
 
     /// The id of the organization to which the merchant belongs to, if not passed an organization is created
-    pub organization_id: Option<String>,
+    #[schema(value_type = Option<String>, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")]
+    pub organization_id: Option<id_type::OrganizationId>,
 
     /// Default payment method collect link config
     #[schema(value_type = Option<BusinessCollectLinkConfig>)]
@@ -208,7 +209,8 @@ pub struct MerchantAccountCreate {
     pub metadata: Option<MerchantAccountMetadata>,
 
     /// The id of the organization to which the merchant belongs to. Please use the organization endpoint to create an organization
-    pub organization_id: String,
+    #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")]
+    pub organization_id: id_type::OrganizationId,
 }
 
 #[cfg(all(feature = "v2", feature = "merchant_account_v2"))]
@@ -414,7 +416,8 @@ pub struct MerchantAccountResponse {
     pub frm_routing_algorithm: Option<serde_json::Value>,
 
     /// The organization id merchant is associated with
-    pub organization_id: String,
+    #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")]
+    pub organization_id: id_type::OrganizationId,
 
     ///  A boolean value to indicate if the merchant has recon service is enabled or not, by default value is false
     pub is_recon_enabled: bool,
@@ -456,7 +459,8 @@ pub struct MerchantAccountResponse {
     pub metadata: Option<pii::SecretSerdeValue>,
 
     /// The id of the organization which the merchant is associated with
-    pub organization_id: String,
+    #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")]
+    pub organization_id: id_type::OrganizationId,
 
     ///  A boolean value to indicate if the merchant has recon service is enabled or not, by default value is false
     pub is_recon_enabled: bool,

crates/api_models/src/events.rs

@@ -31,6 +31,7 @@ use crate::{
     disputes::*,
     files::*,
     mandates::*,
+    organization::{OrganizationId, OrganizationRequest, OrganizationResponse},
     payment_methods::*,
     payments::*,
     user::{UserKeyTransferRequest, UserTransferKeyResponse},
@@ -127,7 +128,10 @@ impl_api_event_type!(
         GetSearchRequestWithIndex,
         GetDisputeFilterRequest,
         DisputeFiltersResponse,
-        GetDisputeMetricRequest
+        GetDisputeMetricRequest,
+        OrganizationResponse,
+        OrganizationRequest,
+        OrganizationId
     )
 );
 

crates/api_models/src/organization.rs

@@ -1,13 +1,32 @@
+use common_utils::id_type;
+use utoipa::ToSchema;
 pub struct OrganizationNew {
-    pub org_id: String,
+    pub org_id: id_type::OrganizationId,
     pub org_name: Option<String>,
 }
 
 impl OrganizationNew {
     pub fn new(org_name: Option<String>) -> Self {
         Self {
-            org_id: common_utils::generate_id_with_default_len("org"),
+            org_id: id_type::OrganizationId::default(),
             org_name,
         }
     }
 }
+
+#[derive(Clone, Debug, serde::Serialize)]
+pub struct OrganizationId {
+    pub organization_id: id_type::OrganizationId,
+}
+
+#[derive(Debug, serde::Serialize, serde::Deserialize, Clone, ToSchema)]
+pub struct OrganizationRequest {
+    pub organization_name: Option<String>,
+}
+
+#[derive(Debug, serde::Serialize, Clone, ToSchema)]
+pub struct OrganizationResponse {
+    #[schema(value_type = String, max_length = 64, min_length = 1, example = "org_q98uSGAYbjEwqs0mJwnz")]
+    pub organization_id: id_type::OrganizationId,
+    pub organization_name: Option<String>,
+}

crates/api_models/src/user.rs

@@ -1,5 +1,5 @@
 use common_enums::{PermissionGroup, RoleScope, TokenPurpose};
-use common_utils::{crypto::OptionalEncryptableName, pii};
+use common_utils::{crypto::OptionalEncryptableName, id_type, pii};
 use masking::Secret;
 
 use crate::user_role::UserStatus;
@@ -164,7 +164,7 @@ pub struct GetUserDetailsResponse {
     // This field is added for audit/debug reasons
     #[serde(skip_serializing)]
     pub user_id: String,
-    pub org_id: String,
+    pub org_id: id_type::OrganizationId,
     pub is_two_factor_auth_setup: bool,
     pub recovery_codes_left: Option<usize>,
 }
@@ -206,7 +206,7 @@ pub struct UserMerchantAccount {
     pub is_active: bool,
     pub role_id: String,
     pub role_name: String,
-    pub org_id: String,
+    pub org_id: id_type::OrganizationId,
 }
 
 #[cfg(feature = "recon")]

crates/common_utils/src/id_type.rs

@@ -1,13 +1,11 @@
 //! Common ID types
 //! The id type can be used to create specific id types with custom behaviour
 
-use std::{
-    borrow::Cow,
-    fmt::{Debug, Display},
-};
+use std::{borrow::Cow, fmt::Debug};
 
 mod customer;
 mod merchant;
+mod organization;
 
 pub use customer::CustomerId;
 use diesel::{
@@ -18,6 +16,7 @@ use diesel::{
     sql_types,
 };
 pub use merchant::MerchantId;
+pub use organization::OrganizationId;
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
 
@@ -37,7 +36,7 @@ fn get_invalid_input_character(input_string: Cow<'static, str>) -> Option<char>
         .find(|char| !is_valid_id_character(char))
 }
 
-#[derive(Debug, PartialEq, Serialize, Clone, Eq)]
+#[derive(Debug, PartialEq, Serialize, Clone, Eq, Hash)]
 /// A type for alphanumeric ids
 pub(crate) struct AlphaNumericId(String);
 
@@ -83,7 +82,7 @@ impl AlphaNumericId {
 }
 
 /// A common type of id that can be used for reference ids with length constraint
-#[derive(Debug, Clone, Serialize, PartialEq, Eq, AsExpression)]
+#[derive(Debug, Clone, Serialize, PartialEq, Eq, AsExpression, Hash)]
 #[diesel(sql_type = sql_types::Text)]
 pub(crate) struct LengthId<const MAX_LENGTH: u8, const MIN_LENGTH: u8>(AlphaNumericId);
 
@@ -168,12 +167,6 @@ where
     }
 }
 
-impl<const MAX_LENGTH: u8, const MIN_LENGTH: u8> Display for LengthId<MAX_LENGTH, MIN_LENGTH> {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        write!(f, "{}", self.0 .0)
-    }
-}
-
 impl<DB, const MAX_LENGTH: u8, const MIN_LENGTH: u8> FromSql<sql_types::Text, DB>
     for LengthId<MAX_LENGTH, MIN_LENGTH>
 where