Generate Client Library code - Automated

Author: pyansys-ci-bot

ansys-grantami-serverapi-openapi/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 name = "ansys-grantami-serverapi-openapi"
 description = "Autogenerated client library for the Granta MI Server API."
-version = "5.0.0.dev406"
+version = "5.0.0.dev408"
 license = "MIT"
 authors = ["ANSYS, Inc. <pyansys.core@ansys.com>"]
 maintainers = ["ANSYS, Inc. <pyansys.core@ansys.com>"]

ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/__init__.py

@@ -677,8 +677,10 @@
 from .models.gsa_parameter_value_type import GsaParameterValueType
 from .models.gsa_parameter_with_data_value import GsaParameterWithDataValue
 from .models.gsa_parameters_info import GsaParametersInfo
+from .models.gsa_permission import GsaPermission
 from .models.gsa_permission_categories_info import GsaPermissionCategoriesInfo
 from .models.gsa_permission_category import GsaPermissionCategory
+from .models.gsa_permissions_info import GsaPermissionsInfo
 from .models.gsa_picture_attribute import GsaPictureAttribute
 from .models.gsa_picture_datum import GsaPictureDatum
 from .models.gsa_picture_datum_criterion import GsaPictureDatumCriterion
@@ -866,6 +868,7 @@
 from .models.gsa_slim_named_unit import GsaSlimNamedUnit
 from .models.gsa_slim_objects import GsaSlimObjects
 from .models.gsa_slim_parameter import GsaSlimParameter
+from .models.gsa_slim_permission import GsaSlimPermission
 from .models.gsa_slim_permission_category import GsaSlimPermissionCategory
 from .models.gsa_slim_profile import GsaSlimProfile
 from .models.gsa_slim_profile_table import GsaSlimProfileTable
@@ -1602,8 +1605,10 @@
     "GsaParameterValueType",
     "GsaParameterWithDataValue",
     "GsaParametersInfo",
+    "GsaPermission",
     "GsaPermissionCategoriesInfo",
     "GsaPermissionCategory",
+    "GsaPermissionsInfo",
     "GsaPictureAttribute",
     "GsaPictureDatum",
     "GsaPictureDatumCriterion",
@@ -1773,6 +1778,7 @@
     "GsaSlimNamedUnit",
     "GsaSlimObjects",
     "GsaSlimParameter",
+    "GsaSlimPermission",
     "GsaSlimPermissionCategory",
     "GsaSlimProfile",
     "GsaSlimProfileTable",

ansys-grantami-serverapi-openapi/src/ansys/grantami/serverapi_openapi/api/permission_based_access_control_api.py

@@ -48,7 +48,88 @@ class PermissionBasedAccessControlApi(ApiBase):
     Ref: https://github.com/swagger-api/swagger-codegen
     """
 
-    def get_access_control_category(
+    def get_permission_categories(
+        self, *, database_key: "str"
+    ) -> "Union[GsaPermissionCategoriesInfo, None]":
+        """Get all permission-based access control categories for the specified database.
+
+        This method makes a synchronous HTTP request.
+
+        Parameters
+        ----------
+        database_key: str
+
+        Returns
+        -------
+        Union[GsaPermissionCategoriesInfo, None]
+        """
+        data = self._get_permission_categories_with_http_info(
+            database_key, _return_http_data_only=True
+        )
+        return data  # type: ignore[no-any-return]
+
+    def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any:
+        all_params = [
+            "database_key",
+            "_return_http_data_only",
+            "_preload_content",
+            "_request_timeout",
+        ]
+
+        params = locals()
+        for key, val in params["kwargs"].items():
+            if key not in all_params:
+                raise TypeError(
+                    f"Got an unexpected keyword argument '{key}' to method get_permission_categories"
+                )
+            params[key] = val
+        del params["kwargs"]
+        # verify the required parameter "database_key" is set
+        if "database_key" not in params or params["database_key"] is None:
+            raise ValueError(
+                "Missing the required parameter 'database_key' when calling 'get_permission_categories'"
+            )
+
+        collection_formats: dict[str, Any] = {}
+
+        path_params: dict[str, Any] = {}
+        if "database_key" in params and database_key is not None:
+            path_params["database-key"] = params["database_key"]
+
+        query_params: list[Any] = []
+
+        header_params: dict[str, Any] = {}
+
+        form_params: list[Any] = []
+        local_var_files: dict[str, Any] = {}
+
+        body_params = None
+        # HTTP header 'Accept'
+        header_params["Accept"] = self.api_client.select_header_accept(["application/json"])
+
+        response_type_map: dict[int, Optional[str]] = {
+            200: "GsaPermissionCategoriesInfo",
+            403: None,
+            404: None,
+        }
+
+        return self.api_client.call_api(
+            "/v1alpha/databases/{database-key}/permission-categories",
+            "GET",
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            _return_http_data_only=params.get("_return_http_data_only"),
+            _preload_content=params.get("_preload_content", True),
+            _request_timeout=params.get("_request_timeout"),
+            collection_formats=collection_formats,
+            response_type_map=response_type_map,
+        )
+
+    def get_permission_category(
         self, *, database_key: "str", category_guid: "str"
     ) -> "Union[GsaPermissionCategory, None]":
         """Get a permission-based access control category with a specified guid.
@@ -64,12 +145,12 @@ def get_access_control_category(
         -------
         Union[GsaPermissionCategory, None]
         """
-        data = self._get_access_control_category_with_http_info(
+        data = self._get_permission_category_with_http_info(
             database_key, category_guid, _return_http_data_only=True
         )
         return data  # type: ignore[no-any-return]
 
-    def _get_access_control_category_with_http_info(
+    def _get_permission_category_with_http_info(
         self, database_key: "str", category_guid: "str", **kwargs: Any
     ) -> Any:
         all_params = [
@@ -84,19 +165,19 @@ def _get_access_control_category_with_http_info(
         for key, val in params["kwargs"].items():
             if key not in all_params:
                 raise TypeError(
-                    f"Got an unexpected keyword argument '{key}' to method get_access_control_category"
+                    f"Got an unexpected keyword argument '{key}' to method get_permission_category"
                 )
             params[key] = val
         del params["kwargs"]
         # verify the required parameter "database_key" is set
         if "database_key" not in params or params["database_key"] is None:
             raise ValueError(
-                "Missing the required parameter 'database_key' when calling 'get_access_control_category'"
+                "Missing the required parameter 'database_key' when calling 'get_permission_category'"
             )
         # verify the required parameter "category_guid" is set
         if "category_guid" not in params or params["category_guid"] is None:
             raise ValueError(
-                "Missing the required parameter 'category_guid' when calling 'get_access_control_category'"
+                "Missing the required parameter 'category_guid' when calling 'get_permission_category'"
             )
 
         collection_formats: dict[str, Any] = {}
@@ -140,29 +221,35 @@ def _get_access_control_category_with_http_info(
             response_type_map=response_type_map,
         )
 
-    def get_permission_categories(
-        self, *, database_key: "str"
-    ) -> "Union[GsaPermissionCategoriesInfo, None]":
-        """Get all permission-based access control categories for the specified database.
+    def get_permission_in_category(
+        self, *, database_key: "str", category_guid: "str", permission_guid: "str"
+    ) -> "Union[GsaPermission, None]":
+        """Get a permission-based access control permission with a given guid in the specified category.
 
         This method makes a synchronous HTTP request.
 
         Parameters
         ----------
         database_key: str
+        category_guid: str
+        permission_guid: str
 
         Returns
         -------
-        Union[GsaPermissionCategoriesInfo, None]
+        Union[GsaPermission, None]
         """
-        data = self._get_permission_categories_with_http_info(
-            database_key, _return_http_data_only=True
+        data = self._get_permission_in_category_with_http_info(
+            database_key, category_guid, permission_guid, _return_http_data_only=True
         )
         return data  # type: ignore[no-any-return]
 
-    def _get_permission_categories_with_http_info(self, database_key: "str", **kwargs: Any) -> Any:
+    def _get_permission_in_category_with_http_info(
+        self, database_key: "str", category_guid: "str", permission_guid: "str", **kwargs: Any
+    ) -> Any:
         all_params = [
             "database_key",
+            "category_guid",
+            "permission_guid",
             "_return_http_data_only",
             "_preload_content",
             "_request_timeout",
@@ -172,21 +259,35 @@ def _get_permission_categories_with_http_info(self, database_key: "str", **kwarg
         for key, val in params["kwargs"].items():
             if key not in all_params:
                 raise TypeError(
-                    f"Got an unexpected keyword argument '{key}' to method get_permission_categories"
+                    f"Got an unexpected keyword argument '{key}' to method get_permission_in_category"
                 )
             params[key] = val
         del params["kwargs"]
         # verify the required parameter "database_key" is set
         if "database_key" not in params or params["database_key"] is None:
             raise ValueError(
-                "Missing the required parameter 'database_key' when calling 'get_permission_categories'"
+                "Missing the required parameter 'database_key' when calling 'get_permission_in_category'"
+            )
+        # verify the required parameter "category_guid" is set
+        if "category_guid" not in params or params["category_guid"] is None:
+            raise ValueError(
+                "Missing the required parameter 'category_guid' when calling 'get_permission_in_category'"
+            )
+        # verify the required parameter "permission_guid" is set
+        if "permission_guid" not in params or params["permission_guid"] is None:
+            raise ValueError(
+                "Missing the required parameter 'permission_guid' when calling 'get_permission_in_category'"
             )
 
         collection_formats: dict[str, Any] = {}
 
         path_params: dict[str, Any] = {}
         if "database_key" in params and database_key is not None:
             path_params["database-key"] = params["database_key"]
+        if "category_guid" in params and category_guid is not None:
+            path_params["category-guid"] = params["category_guid"]
+        if "permission_guid" in params and permission_guid is not None:
+            path_params["permission-guid"] = params["permission_guid"]
 
         query_params: list[Any] = []
 
@@ -200,13 +301,105 @@ def _get_permission_categories_with_http_info(self, database_key: "str", **kwarg
         header_params["Accept"] = self.api_client.select_header_accept(["application/json"])
 
         response_type_map: dict[int, Optional[str]] = {
-            200: "GsaPermissionCategoriesInfo",
+            200: "GsaPermission",
             403: None,
             404: None,
         }
 
         return self.api_client.call_api(
-            "/v1alpha/databases/{database-key}/permission-categories",
+            "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions/{permission-guid}",
+            "GET",
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            _return_http_data_only=params.get("_return_http_data_only"),
+            _preload_content=params.get("_preload_content", True),
+            _request_timeout=params.get("_request_timeout"),
+            collection_formats=collection_formats,
+            response_type_map=response_type_map,
+        )
+
+    def get_permissions_in_category(
+        self, *, database_key: "str", category_guid: "str"
+    ) -> "Union[GsaPermissionsInfo, None]":
+        """Get all permission-based access control permissions for the specified category.
+
+        This method makes a synchronous HTTP request.
+
+        Parameters
+        ----------
+        database_key: str
+        category_guid: str
+
+        Returns
+        -------
+        Union[GsaPermissionsInfo, None]
+        """
+        data = self._get_permissions_in_category_with_http_info(
+            database_key, category_guid, _return_http_data_only=True
+        )
+        return data  # type: ignore[no-any-return]
+
+    def _get_permissions_in_category_with_http_info(
+        self, database_key: "str", category_guid: "str", **kwargs: Any
+    ) -> Any:
+        all_params = [
+            "database_key",
+            "category_guid",
+            "_return_http_data_only",
+            "_preload_content",
+            "_request_timeout",
+        ]
+
+        params = locals()
+        for key, val in params["kwargs"].items():
+            if key not in all_params:
+                raise TypeError(
+                    f"Got an unexpected keyword argument '{key}' to method get_permissions_in_category"
+                )
+            params[key] = val
+        del params["kwargs"]
+        # verify the required parameter "database_key" is set
+        if "database_key" not in params or params["database_key"] is None:
+            raise ValueError(
+                "Missing the required parameter 'database_key' when calling 'get_permissions_in_category'"
+            )
+        # verify the required parameter "category_guid" is set
+        if "category_guid" not in params or params["category_guid"] is None:
+            raise ValueError(
+                "Missing the required parameter 'category_guid' when calling 'get_permissions_in_category'"
+            )
+
+        collection_formats: dict[str, Any] = {}
+
+        path_params: dict[str, Any] = {}
+        if "database_key" in params and database_key is not None:
+            path_params["database-key"] = params["database_key"]
+        if "category_guid" in params and category_guid is not None:
+            path_params["category-guid"] = params["category_guid"]
+
+        query_params: list[Any] = []
+
+        header_params: dict[str, Any] = {}
+
+        form_params: list[Any] = []
+        local_var_files: dict[str, Any] = {}
+
+        body_params = None
+        # HTTP header 'Accept'
+        header_params["Accept"] = self.api_client.select_header_accept(["application/json"])
+
+        response_type_map: dict[int, Optional[str]] = {
+            200: "GsaPermissionsInfo",
+            403: None,
+            404: None,
+        }
+
+        return self.api_client.call_api(
+            "/v1alpha/databases/{database-key}/permission-categories/{category-guid}/permissions",
             "GET",
             path_params,
             query_params,