qi-compute-api-client 0.31.0__py3-none-any.whl → 0.33.0__py3-none-any.whl

compute_api_client/api/permissions_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-     **Sorting and Pagination of list endpoints**  The api provides sorting and pagination for list endpoints. The following parameters can be passed as query parameters to get sorted and paginated list.  - `latest`     - **Type**: Boolean.     - **Description**: Get the most recently created object. Defaults to False. - `sort_by`     - **Type**: String:     - **Description**: The field / column name to sort on. To reverse sort provide the field with a \"-\" sign. E.g. \"created_on\" for ascending order while \"-created_on\" in descending order. Defaults to \"id\". - `page_number`     - **Type**: Positive Integer     - **Description**: The page number for pagination. Defaults to 1. - `items_per_page`     - **Type**: Positive Integer.     - **Description**: The number of items per page for pagination. Defaults to 50. 
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -23,10 +23,14 @@ try:
 except ImportError:
     from typing_extensions import Annotated
 
+from pydantic import Field
+from typing_extensions import Annotated
 from pydantic import StrictBool, StrictInt, StrictStr
 
-from typing import List, Optional
+from typing import Optional
 
+from compute_api_client.models.page_permission import PagePermission
+from compute_api_client.models.page_permission_group import PagePermissionGroup
 from compute_api_client.models.permission import Permission
 from compute_api_client.models.permission_group import PermissionGroup
 
@@ -319,12 +323,12 @@ class PermissionsApi:
     @validate_call
     async def read_permission_groups_permission_groups_get(
         self,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -337,23 +341,23 @@ class PermissionsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[PermissionGroup]:
+    ) -> PagePermissionGroup:
         """List permission groups
 
         Read permissions groups.
 
-        :param latest:
-        :type latest: bool
-        :param sort_by:
-        :type sort_by: str
-        :param page_number:
-        :type page_number: int
-        :param items_per_page:
-        :type items_per_page: int
         :param id:
         :type id: int
         :param name:
         :type name: str
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -377,12 +381,12 @@ class PermissionsApi:
         """ # noqa: E501
 
         _param = self._read_permission_groups_permission_groups_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -390,7 +394,7 @@ class PermissionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[PermissionGroup]",
+            '200': "PagePermissionGroup",
             '422': "HTTPValidationError"
             
         }
@@ -408,12 +412,12 @@ class PermissionsApi:
     @validate_call
     async def read_permission_groups_permission_groups_get_with_http_info(
         self,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -426,23 +430,23 @@ class PermissionsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[PermissionGroup]]:
+    ) -> ApiResponse[PagePermissionGroup]:
         """List permission groups
 
         Read permissions groups.
 
-        :param latest:
-        :type latest: bool
-        :param sort_by:
-        :type sort_by: str
-        :param page_number:
-        :type page_number: int
-        :param items_per_page:
-        :type items_per_page: int
         :param id:
         :type id: int
         :param name:
         :type name: str
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -466,12 +470,12 @@ class PermissionsApi:
         """ # noqa: E501
 
         _param = self._read_permission_groups_permission_groups_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -479,7 +483,7 @@ class PermissionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[PermissionGroup]",
+            '200': "PagePermissionGroup",
             '422': "HTTPValidationError"
             
         }
@@ -497,12 +501,12 @@ class PermissionsApi:
     @validate_call
     async def read_permission_groups_permission_groups_get_without_preload_content(
         self,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         name: Optional[StrictStr] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -520,18 +524,18 @@ class PermissionsApi:
 
         Read permissions groups.
 
-        :param latest:
-        :type latest: bool
-        :param sort_by:
-        :type sort_by: str
-        :param page_number:
-        :type page_number: int
-        :param items_per_page:
-        :type items_per_page: int
         :param id:
         :type id: int
         :param name:
         :type name: str
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -555,12 +559,12 @@ class PermissionsApi:
         """ # noqa: E501
 
         _param = self._read_permission_groups_permission_groups_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -568,7 +572,7 @@ class PermissionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[PermissionGroup]",
+            '200': "PagePermissionGroup",
             '422': "HTTPValidationError"
             
         }
@@ -581,12 +585,12 @@ class PermissionsApi:
 
     def _read_permission_groups_permission_groups_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         name,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -608,29 +612,29 @@ class PermissionsApi:
 
         # process the path parameters
         # process the query parameters
-        if latest is not None:
+        if id is not None:
             
-            _query_params.append(('latest', latest))
+            _query_params.append(('id', id))
             
-        if sort_by is not None:
+        if name is not None:
             
-            _query_params.append(('sort_by', sort_by))
+            _query_params.append(('name', name))
             
-        if page_number is not None:
+        if sort_by is not None:
             
-            _query_params.append(('page_number', page_number))
+            _query_params.append(('sort_by', sort_by))
             
-        if items_per_page is not None:
+        if latest is not None:
             
-            _query_params.append(('items_per_page', items_per_page))
+            _query_params.append(('latest', latest))
             
-        if id is not None:
+        if page is not None:
             
-            _query_params.append(('id', id))
+            _query_params.append(('page', page))
             
-        if name is not None:
+        if size is not None:
             
-            _query_params.append(('name', name))
+            _query_params.append(('size', size))
             
         # process the header parameters
         # process the form parameters
@@ -939,13 +943,13 @@ class PermissionsApi:
     @validate_call
     async def read_permissions_permissions_get(
         self,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         permission: Optional[StrictStr] = None,
         name: Optional[StrictStr] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -958,25 +962,25 @@ class PermissionsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Permission]:
+    ) -> PagePermission:
         """List permissions
 
         Read permissions.
 
-        :param latest:
-        :type latest: bool
-        :param sort_by:
-        :type sort_by: str
-        :param page_number:
-        :type page_number: int
-        :param items_per_page:
-        :type items_per_page: int
         :param id:
         :type id: int
         :param permission:
         :type permission: str
         :param name:
         :type name: str
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1000,13 +1004,13 @@ class PermissionsApi:
         """ # noqa: E501
 
         _param = self._read_permissions_permissions_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             permission=permission,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1014,7 +1018,7 @@ class PermissionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Permission]",
+            '200': "PagePermission",
             '422': "HTTPValidationError"
             
         }
@@ -1032,13 +1036,13 @@ class PermissionsApi:
     @validate_call
     async def read_permissions_permissions_get_with_http_info(
         self,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         permission: Optional[StrictStr] = None,
         name: Optional[StrictStr] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1051,25 +1055,25 @@ class PermissionsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Permission]]:
+    ) -> ApiResponse[PagePermission]:
         """List permissions
 
         Read permissions.
 
-        :param latest:
-        :type latest: bool
-        :param sort_by:
-        :type sort_by: str
-        :param page_number:
-        :type page_number: int
-        :param items_per_page:
-        :type items_per_page: int
         :param id:
         :type id: int
         :param permission:
         :type permission: str
         :param name:
         :type name: str
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1093,13 +1097,13 @@ class PermissionsApi:
         """ # noqa: E501
 
         _param = self._read_permissions_permissions_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             permission=permission,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1107,7 +1111,7 @@ class PermissionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Permission]",
+            '200': "PagePermission",
             '422': "HTTPValidationError"
             
         }
@@ -1125,13 +1129,13 @@ class PermissionsApi:
     @validate_call
     async def read_permissions_permissions_get_without_preload_content(
         self,
-        latest: Optional[StrictBool] = None,
-        sort_by: Optional[StrictStr] = None,
-        page_number: Optional[StrictInt] = None,
-        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         permission: Optional[StrictStr] = None,
         name: Optional[StrictStr] = None,
+        sort_by: Annotated[Optional[StrictStr], Field(description="The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.")] = None,
+        latest: Annotated[Optional[StrictBool], Field(description="If True gets the most recently created object.")] = None,
+        page: Annotated[Optional[Annotated[int, Field(strict=True, ge=1)]], Field(description="Page number")] = None,
+        size: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="Page size")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1149,20 +1153,20 @@ class PermissionsApi:
 
         Read permissions.
 
-        :param latest:
-        :type latest: bool
-        :param sort_by:
-        :type sort_by: str
-        :param page_number:
-        :type page_number: int
-        :param items_per_page:
-        :type items_per_page: int
         :param id:
         :type id: int
         :param permission:
         :type permission: str
         :param name:
         :type name: str
+        :param sort_by: The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'.
+        :type sort_by: str
+        :param latest: If True gets the most recently created object.
+        :type latest: bool
+        :param page: Page number
+        :type page: int
+        :param size: Page size
+        :type size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -1186,13 +1190,13 @@ class PermissionsApi:
         """ # noqa: E501
 
         _param = self._read_permissions_permissions_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             permission=permission,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1200,7 +1204,7 @@ class PermissionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Permission]",
+            '200': "PagePermission",
             '422': "HTTPValidationError"
             
         }
@@ -1213,13 +1217,13 @@ class PermissionsApi:
 
     def _read_permissions_permissions_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         permission,
         name,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -1241,33 +1245,33 @@ class PermissionsApi:
 
         # process the path parameters
         # process the query parameters
-        if latest is not None:
+        if id is not None:
             
-            _query_params.append(('latest', latest))
+            _query_params.append(('id', id))
             
-        if sort_by is not None:
+        if permission is not None:
             
-            _query_params.append(('sort_by', sort_by))
+            _query_params.append(('permission', permission))
             
-        if page_number is not None:
+        if name is not None:
             
-            _query_params.append(('page_number', page_number))
+            _query_params.append(('name', name))
             
-        if items_per_page is not None:
+        if sort_by is not None:
             
-            _query_params.append(('items_per_page', items_per_page))
+            _query_params.append(('sort_by', sort_by))
             
-        if id is not None:
+        if latest is not None:
             
-            _query_params.append(('id', id))
+            _query_params.append(('latest', latest))
             
-        if permission is not None:
+        if page is not None:
             
-            _query_params.append(('permission', permission))
+            _query_params.append(('page', page))
             
-        if name is not None:
+        if size is not None:
             
-            _query_params.append(('name', name))
+            _query_params.append(('size', size))
             
         # process the header parameters
         # process the form parameters