Add tenant services

Core.Thalos.Provider/Contracts/IPermissionProvider.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 Permission-related service operations.
+    /// </summary>
     public interface IPermissionProvider
     {
         /// <summary>
         /// Creates a new Permission.
         /// </summary>
-        /// <param name="entity">The Permission to be created.</param>
-        /// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="newPermission">The Permission to be created.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{PermissionAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<PermissionAdapter> CreatePermission(PermissionRequest newPermission, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Gets an Permission by identifier.
+        /// Gets a Permission by its identifier.
         /// </summary>
-        /// <param name="id">The Permission identifier.</param>
-        /// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="_id">The Permission Mongo identifier.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{PermissionAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<PermissionAdapter> GetPermissionById(string _id, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Gets all the roles.
+        /// Gets all Permissions.
         /// </summary>
-        /// <returns>A <see cref="{Task{IEnumerbale{PermissionAdapter}}}"/> 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{PermissionAdapter}}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<IEnumerable<PermissionAdapter>> GetAllPermissions(CancellationToken cancellationToken);
 
         /// <summary>
-        /// Gets all the permissions by permissions identifier list.
+        /// Gets all Permissions by a list of identifiers.
         /// </summary>
-        /// <param name="permissions">The list of permissions identifiers.</param>
-        /// <returns>A <see cref="Task{IEnumerable{PermissionAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="permissions">The list of Permission identifiers.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{IEnumerable{PermissionAdapter}}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<IEnumerable<PermissionAdapter>> GetAllPermissionsByList(string[] permissions, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Changes the status of the permission.
+        /// Changes the status of a Permission.
         /// </summary>
-        /// <param name="id">The permission identifier.</param>
-        /// <param name="newStatus">The new status of the permission.</param>
-        /// <returns>The <see cref="PermissionAdapter"/> updated entity.</returns>
-        /// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
-        ValueTask<PermissionAdapter> ChangePermissionStatus(string id, Blueprint.Mongo.StatusEnum newStatus, CancellationToken cancellationToken);
+        /// <param name="_id">The Permission Mongo identifier.</param>
+        /// <param name="newStatus">The new status of the Permission.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{PermissionAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
+        ValueTask<PermissionAdapter> ChangePermissionStatus(string _id, Blueprint.Mongo.StatusEnum newStatus, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Updates a Permission by id.
+        /// Updates a Permission.
         /// </summary>
         /// <param name="entity">The Permission to be updated.</param>
-        /// <param name="id">The Permission identifier.</param>
-        /// <returns>A <see cref="{Task{PermissionAdapter}}"/> representing
-        /// the asynchronous execution of the service.</returns>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{PermissionAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
         ValueTask<PermissionAdapter> UpdatePermission(PermissionAdapter entity, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Deletes a Permission by its identifier.
+        /// </summary>
+        /// <param name="_id">The Permission Mongo identifier.</param>
+        /// <param name="cancellationToken">A token to cancel the asynchronous operation.</param>
+        /// <returns>
+        /// A <see cref="ValueTask{PermissionAdapter}"/> representing the asynchronous execution of the service.
+        /// </returns>
+        ValueTask<PermissionAdapter?> DeletePermission(string _id, CancellationToken cancellationToken);
     }
 }