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

compute_api_client/api/teams_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,13 @@ 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_team import PageTeam
 from compute_api_client.models.team import Team
 
 from compute_api_client.api_client import ApiClient
@@ -318,14 +321,14 @@ class TeamsApi:
     @validate_call
     async def read_teams_teams_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,
         slug: Optional[StrictStr] = None,
         individual_user: 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)],
@@ -338,19 +341,11 @@ class TeamsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Team]:
+    ) -> PageTeam:
         """List teams
 
         Read teams.
 
-        :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:
@@ -359,6 +354,14 @@ class TeamsApi:
         :type slug: str
         :param individual_user:
         :type individual_user: 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
@@ -382,14 +385,14 @@ class TeamsApi:
         """ # noqa: E501
 
         _param = self._read_teams_teams_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             slug=slug,
             individual_user=individual_user,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -397,7 +400,7 @@ class TeamsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Team]",
+            '200': "PageTeam",
             '422': "HTTPValidationError"
             
         }
@@ -415,14 +418,14 @@ class TeamsApi:
     @validate_call
     async def read_teams_teams_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,
         slug: Optional[StrictStr] = None,
         individual_user: 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)],
@@ -435,19 +438,11 @@ class TeamsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Team]]:
+    ) -> ApiResponse[PageTeam]:
         """List teams
 
         Read teams.
 
-        :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:
@@ -456,6 +451,14 @@ class TeamsApi:
         :type slug: str
         :param individual_user:
         :type individual_user: 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
@@ -479,14 +482,14 @@ class TeamsApi:
         """ # noqa: E501
 
         _param = self._read_teams_teams_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             slug=slug,
             individual_user=individual_user,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -494,7 +497,7 @@ class TeamsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Team]",
+            '200': "PageTeam",
             '422': "HTTPValidationError"
             
         }
@@ -512,14 +515,14 @@ class TeamsApi:
     @validate_call
     async def read_teams_teams_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,
         slug: Optional[StrictStr] = None,
         individual_user: 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)],
@@ -537,14 +540,6 @@ class TeamsApi:
 
         Read teams.
 
-        :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:
@@ -553,6 +548,14 @@ class TeamsApi:
         :type slug: str
         :param individual_user:
         :type individual_user: 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
@@ -576,14 +579,14 @@ class TeamsApi:
         """ # noqa: E501
 
         _param = self._read_teams_teams_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             name=name,
             slug=slug,
             individual_user=individual_user,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -591,7 +594,7 @@ class TeamsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Team]",
+            '200': "PageTeam",
             '422': "HTTPValidationError"
             
         }
@@ -604,14 +607,14 @@ class TeamsApi:
 
     def _read_teams_teams_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         name,
         slug,
         individual_user,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -633,22 +636,6 @@ class TeamsApi:
 
         # 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))
@@ -665,6 +652,22 @@ class TeamsApi:
             
             _query_params.append(('individual_user', individual_user))
             
+        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/transactions_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,13 +23,16 @@ 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
 
-from typing import List, Optional
+from typing import Optional
 
 from compute_api_client.models.domain import Domain
+from compute_api_client.models.page_transaction import PageTransaction
 from compute_api_client.models.transaction import Transaction
 
 from compute_api_client.api_client import ApiClient
@@ -321,10 +324,6 @@ class TransactionsApi:
     @validate_call
     async def read_transactions_transactions_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,
         domain__isnull: Optional[StrictBool] = None,
         domain: Optional[Domain] = None,
@@ -335,6 +334,10 @@ class TransactionsApi:
         member_id: Optional[StrictInt] = None,
         change: Optional[StrictInt] = None,
         timestamp: Optional[datetime] = 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)],
@@ -347,19 +350,11 @@ class TransactionsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Transaction]:
+    ) -> PageTransaction:
         """List transactions
 
         Read transactions.
 
-        :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 domain__isnull:
@@ -380,6 +375,14 @@ class TransactionsApi:
         :type change: int
         :param timestamp:
         :type timestamp: datetime
+        :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
@@ -403,10 +406,6 @@ class TransactionsApi:
         """ # noqa: E501
 
         _param = self._read_transactions_transactions_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             domain__isnull=domain__isnull,
             domain=domain,
@@ -417,6 +416,10 @@ class TransactionsApi:
             member_id=member_id,
             change=change,
             timestamp=timestamp,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -424,7 +427,7 @@ class TransactionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Transaction]",
+            '200': "PageTransaction",
             '422': "HTTPValidationError"
             
         }
@@ -442,10 +445,6 @@ class TransactionsApi:
     @validate_call
     async def read_transactions_transactions_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,
         domain__isnull: Optional[StrictBool] = None,
         domain: Optional[Domain] = None,
@@ -456,6 +455,10 @@ class TransactionsApi:
         member_id: Optional[StrictInt] = None,
         change: Optional[StrictInt] = None,
         timestamp: Optional[datetime] = 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)],
@@ -468,19 +471,11 @@ class TransactionsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Transaction]]:
+    ) -> ApiResponse[PageTransaction]:
         """List transactions
 
         Read transactions.
 
-        :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 domain__isnull:
@@ -501,6 +496,14 @@ class TransactionsApi:
         :type change: int
         :param timestamp:
         :type timestamp: datetime
+        :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
@@ -524,10 +527,6 @@ class TransactionsApi:
         """ # noqa: E501
 
         _param = self._read_transactions_transactions_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             domain__isnull=domain__isnull,
             domain=domain,
@@ -538,6 +537,10 @@ class TransactionsApi:
             member_id=member_id,
             change=change,
             timestamp=timestamp,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -545,7 +548,7 @@ class TransactionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Transaction]",
+            '200': "PageTransaction",
             '422': "HTTPValidationError"
             
         }
@@ -563,10 +566,6 @@ class TransactionsApi:
     @validate_call
     async def read_transactions_transactions_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,
         domain__isnull: Optional[StrictBool] = None,
         domain: Optional[Domain] = None,
@@ -577,6 +576,10 @@ class TransactionsApi:
         member_id: Optional[StrictInt] = None,
         change: Optional[StrictInt] = None,
         timestamp: Optional[datetime] = 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)],
@@ -594,14 +597,6 @@ class TransactionsApi:
 
         Read transactions.
 
-        :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 domain__isnull:
@@ -622,6 +617,14 @@ class TransactionsApi:
         :type change: int
         :param timestamp:
         :type timestamp: datetime
+        :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
@@ -645,10 +648,6 @@ class TransactionsApi:
         """ # noqa: E501
 
         _param = self._read_transactions_transactions_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             domain__isnull=domain__isnull,
             domain=domain,
@@ -659,6 +658,10 @@ class TransactionsApi:
             member_id=member_id,
             change=change,
             timestamp=timestamp,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -666,7 +669,7 @@ class TransactionsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Transaction]",
+            '200': "PageTransaction",
             '422': "HTTPValidationError"
             
         }
@@ -679,10 +682,6 @@ class TransactionsApi:
 
     def _read_transactions_transactions_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         domain__isnull,
         domain,
@@ -693,6 +692,10 @@ class TransactionsApi:
         member_id,
         change,
         timestamp,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -714,22 +717,6 @@ class TransactionsApi:
 
         # 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))
@@ -779,6 +766,22 @@ class TransactionsApi:
             else:
                 _query_params.append(('timestamp', timestamp))
             
+        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