Add tenant services

Core.Thalos.Provider/Contracts/IModuleProvider.cs

@@ -3,61 +3,85 @@
 //     AgileWebs
 // </copyright>
 // ***********************************************************************
+
 using Core.Thalos.BuildingBlocks;
 using Core.Thalos.Domain.Contexts.Onboarding.Request;
 
 namespace Core.Thalos.Provider.Contracts
 {
+    /// <summary>
+    /// Interface for Module-related service operations.
+    /// </summary>
     public interface IModuleProvider
     {
         /// <summary>
         /// Creates a new Module.
         /// </summary>
-        /// <param name="entity">The Module to be created.</param>
-        /// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="newModule">The Module to be created.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{ModuleAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<ModuleAdapter> CreateModule(ModuleRequest newModule, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Gets an Module by identifier.
+        /// Gets a Module by its identifier.
         /// </summary>
-        /// <param name="id">The Module identifier.</param>
-        /// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="_id">The Module Mongo identifier.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{ModuleAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<ModuleAdapter> GetModuleById(string _id, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Gets all the roles.
+        /// Gets all Modules.
         /// </summary>
-        /// <returns>A <see cref="{Task{IEnumerbale{ModuleAdapter}}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{IEnumerable{ModuleAdapter}}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<IEnumerable<ModuleAdapter>> GetAllModules(CancellationToken cancellationToken);
 
         /// <summary>
-        /// Gets all the permissions by permissions identifier list.
+        /// Gets all Modules by a list of identifiers.
         /// </summary>
-        /// <param name="permissions">The list of permissions identifiers.</param>
-        /// <returns>A <see cref="Task{IEnumerable{ModuleAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="modules">The list of Module identifiers.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{IEnumerable{ModuleAdapter}}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<IEnumerable<ModuleAdapter>> GetAllModulesByList(string[] modules, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Changes the status of the permission.
+        /// Changes the status of a Module.
         /// </summary>
-        /// <param name="id">The permission identifier.</param>
-        /// <param name="newStatus">The new status of the permission.</param>
-        /// <returns>The <see cref="ModuleAdapter"/> updated entity.</returns>
-        /// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
-        ValueTask<ModuleAdapter> ChangeModuleStatus(string id, Blueprint.Mongo.StatusEnum newStatus, CancellationToken cancellationToken);
+        /// <param name="_id">The Module Mongo identifier.</param>
+        /// <param name="newStatus">The new status of the Module.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{ModuleAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
+        ValueTask<ModuleAdapter> ChangeModuleStatus(string _id, Blueprint.Mongo.StatusEnum newStatus, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Updates a Module by id.
+        /// Updates a Module by its identifier.
         /// </summary>
         /// <param name="entity">The Module to be updated.</param>
-        /// <param name="id">The Module identifier.</param>
-        /// <returns>A <see cref="{Task{ModuleAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{ModuleAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<ModuleAdapter> UpdateModule(ModuleAdapter entity, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Deletes a Module by its identifier.
+        /// </summary>
+        /// <param name="_id">The Module Mongo identifier.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{ModuleAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
+        ValueTask<ModuleAdapter?> DeleteModule(string _id, CancellationToken cancellationToken);
     }
 }