qi-compute-api-client 0.17.0__py3-none-any.whl → 0.27.0__py3-none-any.whl

compute_api_client/api/metadata_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **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. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -570,6 +570,7 @@ class MetadataApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -838,6 +839,7 @@ class MetadataApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/permissions_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **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. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -295,6 +295,7 @@ class PermissionsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -320,6 +321,9 @@ class PermissionsApi:
     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,
         _request_timeout: Union[
@@ -341,6 +345,12 @@ class PermissionsApi:
 
         :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:
@@ -369,6 +379,9 @@ class PermissionsApi:
 
         _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,
             _request_auth=_request_auth,
@@ -397,6 +410,9 @@ class PermissionsApi:
     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,
         _request_timeout: Union[
@@ -418,6 +434,12 @@ class PermissionsApi:
 
         :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:
@@ -446,6 +468,9 @@ class PermissionsApi:
 
         _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,
             _request_auth=_request_auth,
@@ -474,6 +499,9 @@ class PermissionsApi:
     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,
         _request_timeout: Union[
@@ -495,6 +523,12 @@ class PermissionsApi:
 
         :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:
@@ -523,6 +557,9 @@ class PermissionsApi:
 
         _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,
             _request_auth=_request_auth,
@@ -546,6 +583,9 @@ class PermissionsApi:
     def _read_permission_groups_permission_groups_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         name,
         _request_auth,
@@ -573,6 +613,18 @@ class PermissionsApi:
             
             _query_params.append(('latest', latest))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if page_number is not None:
+            
+            _query_params.append(('page_number', page_number))
+            
+        if items_per_page is not None:
+            
+            _query_params.append(('items_per_page', items_per_page))
+            
         if id is not None:
             
             _query_params.append(('id', id))
@@ -596,6 +648,7 @@ class PermissionsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -864,6 +917,7 @@ class PermissionsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -889,6 +943,9 @@ class PermissionsApi:
     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,
@@ -911,6 +968,12 @@ class PermissionsApi:
 
         :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:
@@ -941,6 +1004,9 @@ class PermissionsApi:
 
         _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,
@@ -970,6 +1036,9 @@ class PermissionsApi:
     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,
@@ -992,6 +1061,12 @@ class PermissionsApi:
 
         :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:
@@ -1022,6 +1097,9 @@ class PermissionsApi:
 
         _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,
@@ -1051,6 +1129,9 @@ class PermissionsApi:
     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,
@@ -1073,6 +1154,12 @@ class PermissionsApi:
 
         :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:
@@ -1103,6 +1190,9 @@ class PermissionsApi:
 
         _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,
@@ -1127,6 +1217,9 @@ class PermissionsApi:
     def _read_permissions_permissions_get_serialize(
         self,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         permission,
         name,
@@ -1155,6 +1248,18 @@ class PermissionsApi:
             
             _query_params.append(('latest', latest))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if page_number is not None:
+            
+            _query_params.append(('page_number', page_number))
+            
+        if items_per_page is not None:
+            
+            _query_params.append(('items_per_page', items_per_page))
+            
         if id is not None:
             
             _query_params.append(('id', id))
@@ -1182,6 +1287,7 @@ class PermissionsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/projects_api.py

@@ -3,7 +3,7 @@
 """
     Quantum Inspire 2
 
-    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+     **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. 
 
     The version of the OpenAPI document: 0.1.0
     Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -23,6 +23,8 @@ try:
 except ImportError:
     from typing_extensions import Annotated
 
+from pydantic import Field
+from typing_extensions import Annotated
 from datetime import datetime
 
 from pydantic import StrictBool, StrictInt, StrictStr
@@ -308,6 +310,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -567,6 +570,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -863,6 +867,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1131,6 +1136,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1155,7 +1161,11 @@ class ProjectsApi:
     @validate_call
     async def read_projects_projects_get(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         owner_id: Optional[StrictInt] = None,
@@ -1177,10 +1187,18 @@ class ProjectsApi:
     ) -> List[Project]:
         """List projects
 
-        List projects.
+        List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
+        :param search: Substring search for project names or description
+        :type search: str
         :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 created_on:
@@ -1216,7 +1234,11 @@ class ProjectsApi:
         """ # noqa: E501
 
         _param = self._read_projects_projects_get_serialize(
+            search=search,
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             owner_id=owner_id,
@@ -1248,7 +1270,11 @@ class ProjectsApi:
     @validate_call
     async def read_projects_projects_get_with_http_info(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         owner_id: Optional[StrictInt] = None,
@@ -1270,10 +1296,18 @@ class ProjectsApi:
     ) -> ApiResponse[List[Project]]:
         """List projects
 
-        List projects.
+        List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
+        :param search: Substring search for project names or description
+        :type search: str
         :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 created_on:
@@ -1309,7 +1343,11 @@ class ProjectsApi:
         """ # noqa: E501
 
         _param = self._read_projects_projects_get_serialize(
+            search=search,
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             owner_id=owner_id,
@@ -1341,7 +1379,11 @@ class ProjectsApi:
     @validate_call
     async def read_projects_projects_get_without_preload_content(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
         latest: Optional[StrictBool] = None,
+        sort_by: Optional[StrictStr] = None,
+        page_number: Optional[StrictInt] = None,
+        items_per_page: Optional[StrictInt] = None,
         id: Optional[StrictInt] = None,
         created_on: Optional[datetime] = None,
         owner_id: Optional[StrictInt] = None,
@@ -1363,10 +1405,18 @@ class ProjectsApi:
     ) -> RESTResponseType:
         """List projects
 
-        List projects.
+        List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
+        :param search: Substring search for project names or description
+        :type search: str
         :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 created_on:
@@ -1402,7 +1452,11 @@ class ProjectsApi:
         """ # noqa: E501
 
         _param = self._read_projects_projects_get_serialize(
+            search=search,
             latest=latest,
+            sort_by=sort_by,
+            page_number=page_number,
+            items_per_page=items_per_page,
             id=id,
             created_on=created_on,
             owner_id=owner_id,
@@ -1429,7 +1483,11 @@ class ProjectsApi:
 
     def _read_projects_projects_get_serialize(
         self,
+        search,
         latest,
+        sort_by,
+        page_number,
+        items_per_page,
         id,
         created_on,
         owner_id,
@@ -1457,10 +1515,26 @@ class ProjectsApi:
 
         # process the path parameters
         # process the query parameters
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
         if latest is not None:
             
             _query_params.append(('latest', latest))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if page_number is not None:
+            
+            _query_params.append(('page_number', page_number))
+            
+        if items_per_page is not None:
+            
+            _query_params.append(('items_per_page', items_per_page))
+            
         if id is not None:
             
             _query_params.append(('id', id))
@@ -1509,6 +1583,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1805,6 +1880,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]