qi-compute-api-client 0.32.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

compute_api_client/api/members_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,12 +23,15 @@ 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.member import Member
 from compute_api_client.models.member_in import MemberIn
+from compute_api_client.models.page_member import PageMember
 from compute_api_client.models.role import Role
 
 from compute_api_client.api_client import ApiClient
@@ -857,14 +860,14 @@ class MembersApi:
     @validate_call
     async def read_members_members_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,
         team_id: Optional[StrictInt] = None,
         role: Optional[Role] = None,
         is_active: Optional[StrictBool] = 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)],
@@ -877,19 +880,11 @@ class MembersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Member]:
+    ) -> PageMember:
         """List members
 
         Read members.
 
-        :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 team_id:
@@ -898,6 +893,14 @@ class MembersApi:
         :type role: Role
         :param is_active:
         :type is_active: bool
+        :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
@@ -921,14 +924,14 @@ class MembersApi:
         """ # noqa: E501
 
         _param = self._read_members_members_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             team_id=team_id,
             role=role,
             is_active=is_active,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -936,7 +939,7 @@ class MembersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Member]",
+            '200': "PageMember",
             '422': "HTTPValidationError"
             
         }
@@ -954,14 +957,14 @@ class MembersApi:
     @validate_call
     async def read_members_members_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,
         team_id: Optional[StrictInt] = None,
         role: Optional[Role] = None,
         is_active: Optional[StrictBool] = 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)],
@@ -974,19 +977,11 @@ class MembersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Member]]:
+    ) -> ApiResponse[PageMember]:
         """List members
 
         Read members.
 
-        :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 team_id:
@@ -995,6 +990,14 @@ class MembersApi:
         :type role: Role
         :param is_active:
         :type is_active: bool
+        :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
@@ -1018,14 +1021,14 @@ class MembersApi:
         """ # noqa: E501
 
         _param = self._read_members_members_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             team_id=team_id,
             role=role,
             is_active=is_active,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1033,7 +1036,7 @@ class MembersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Member]",
+            '200': "PageMember",
             '422': "HTTPValidationError"
             
         }
@@ -1051,14 +1054,14 @@ class MembersApi:
     @validate_call
     async def read_members_members_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,
         team_id: Optional[StrictInt] = None,
         role: Optional[Role] = None,
         is_active: Optional[StrictBool] = 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)],
@@ -1076,14 +1079,6 @@ class MembersApi:
 
         Read members.
 
-        :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 team_id:
@@ -1092,6 +1087,14 @@ class MembersApi:
         :type role: Role
         :param is_active:
         :type is_active: bool
+        :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
@@ -1115,14 +1118,14 @@ class MembersApi:
         """ # noqa: E501
 
         _param = self._read_members_members_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             team_id=team_id,
             role=role,
             is_active=is_active,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1130,7 +1133,7 @@ class MembersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Member]",
+            '200': "PageMember",
             '422': "HTTPValidationError"
             
         }
@@ -1143,14 +1146,14 @@ class MembersApi:
 
     def _read_members_members_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         team_id,
         role,
         is_active,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -1172,22 +1175,6 @@ class MembersApi:
 
         # process the path parameters
         # process the query parameters
-        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))
@@ -1204,6 +1191,22 @@ class MembersApi:
             
             _query_params.append(('is_active', is_active))
             
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if latest is not None:
+            
+            _query_params.append(('latest', latest))
+            
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if size is not None:
+            
+            _query_params.append(('size', size))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter

compute_api_client/api/metadata_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,12 +23,15 @@ try:
 except ImportError:
     from typing_extensions import Annotated
 
-from pydantic import StrictInt
+from pydantic import Field
+from typing_extensions import Annotated
+from pydantic import StrictBool, StrictInt, StrictStr
 
-from typing import List
+from typing import Optional
 
 from compute_api_client.models.metadata import Metadata
 from compute_api_client.models.metadata_in import MetadataIn
+from compute_api_client.models.page_metadata import PageMetadata
 
 from compute_api_client.api_client import ApiClient
 from compute_api_client.api_response import ApiResponse
@@ -330,6 +333,10 @@ class MetadataApi:
     async def read_metadata_by_backend_id_metadata_backend_backend_id_get(
         self,
         backend_id: StrictInt,
+        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)],
@@ -342,13 +349,21 @@ class MetadataApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Metadata]:
+    ) -> PageMetadata:
         """Retrieve metadata by backend ID
 
         Get metadata by job ID.
 
         :param backend_id: (required)
         :type backend_id: int
+        :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
@@ -373,6 +388,10 @@ class MetadataApi:
 
         _param = self._read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize(
             backend_id=backend_id,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -380,7 +399,7 @@ class MetadataApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Metadata]",
+            '200': "PageMetadata",
             '422': "HTTPValidationError"
             
         }
@@ -399,6 +418,10 @@ class MetadataApi:
     async def read_metadata_by_backend_id_metadata_backend_backend_id_get_with_http_info(
         self,
         backend_id: StrictInt,
+        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)],
@@ -411,13 +434,21 @@ class MetadataApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Metadata]]:
+    ) -> ApiResponse[PageMetadata]:
         """Retrieve metadata by backend ID
 
         Get metadata by job ID.
 
         :param backend_id: (required)
         :type backend_id: int
+        :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
@@ -442,6 +473,10 @@ class MetadataApi:
 
         _param = self._read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize(
             backend_id=backend_id,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -449,7 +484,7 @@ class MetadataApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Metadata]",
+            '200': "PageMetadata",
             '422': "HTTPValidationError"
             
         }
@@ -468,6 +503,10 @@ class MetadataApi:
     async def read_metadata_by_backend_id_metadata_backend_backend_id_get_without_preload_content(
         self,
         backend_id: StrictInt,
+        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)],
@@ -487,6 +526,14 @@ class MetadataApi:
 
         :param backend_id: (required)
         :type backend_id: int
+        :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
@@ -511,6 +558,10 @@ class MetadataApi:
 
         _param = self._read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize(
             backend_id=backend_id,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -518,7 +569,7 @@ class MetadataApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Metadata]",
+            '200': "PageMetadata",
             '422': "HTTPValidationError"
             
         }
@@ -532,6 +583,10 @@ class MetadataApi:
     def _read_metadata_by_backend_id_metadata_backend_backend_id_get_serialize(
         self,
         backend_id,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -555,6 +610,22 @@ class MetadataApi:
         if backend_id is not None:
             _path_params['backend_id'] = backend_id
         # process the query parameters
+        if sort_by is not None:
+            
+            _query_params.append(('sort_by', sort_by))
+            
+        if latest is not None:
+            
+            _query_params.append(('latest', latest))
+            
+        if page is not None:
+            
+            _query_params.append(('page', page))
+            
+        if size is not None:
+            
+            _query_params.append(('size', size))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter