qi-compute-api-client 0.32.0__tar.gz → 0.33.0__tar.gz

{qi_compute_api_client-0.32.0 → qi_compute_api_client-0.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qi-compute-api-client
-Version: 0.32.0
+Version: 0.33.0
 Summary: An API client for the Compute Job Manager of Quantum Inspire.
 Home-page: https://github.com/QuTech-Delft/compute-api-client
 License: Apache-2.0
@@ -22,7 +22,7 @@ Project-URL: Repository, https://github.com/QuTech-Delft/compute-api-client
 Description-Content-Type: text/markdown
 
 # compute-api-client
- **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 `compute_api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
@@ -200,6 +200,24 @@ Class | Method | HTTP request | Description
  - [MemberIn](compute_api_client/docs/MemberIn.md)
  - [Metadata](compute_api_client/docs/Metadata.md)
  - [MetadataIn](compute_api_client/docs/MetadataIn.md)
+ - [PageAlgorithm](compute_api_client/docs/PageAlgorithm.md)
+ - [PageBackend](compute_api_client/docs/PageBackend.md)
+ - [PageBackendType](compute_api_client/docs/PageBackendType.md)
+ - [PageBatchJob](compute_api_client/docs/PageBatchJob.md)
+ - [PageCommit](compute_api_client/docs/PageCommit.md)
+ - [PageFile](compute_api_client/docs/PageFile.md)
+ - [PageJob](compute_api_client/docs/PageJob.md)
+ - [PageLanguage](compute_api_client/docs/PageLanguage.md)
+ - [PageMember](compute_api_client/docs/PageMember.md)
+ - [PageMetadata](compute_api_client/docs/PageMetadata.md)
+ - [PagePermission](compute_api_client/docs/PagePermission.md)
+ - [PagePermissionGroup](compute_api_client/docs/PagePermissionGroup.md)
+ - [PageProject](compute_api_client/docs/PageProject.md)
+ - [PageReservation](compute_api_client/docs/PageReservation.md)
+ - [PageResult](compute_api_client/docs/PageResult.md)
+ - [PageTeam](compute_api_client/docs/PageTeam.md)
+ - [PageTransaction](compute_api_client/docs/PageTransaction.md)
+ - [PageUser](compute_api_client/docs/PageUser.md)
  - [Permission](compute_api_client/docs/Permission.md)
  - [PermissionGroup](compute_api_client/docs/PermissionGroup.md)
  - [Project](compute_api_client/docs/Project.md)

{qi_compute_api_client-0.32.0 → qi_compute_api_client-0.33.0}/README.md

@@ -1,5 +1,5 @@
 # compute-api-client
- **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 `compute_api_client` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
@@ -177,6 +177,24 @@ Class | Method | HTTP request | Description
  - [MemberIn](compute_api_client/docs/MemberIn.md)
  - [Metadata](compute_api_client/docs/Metadata.md)
  - [MetadataIn](compute_api_client/docs/MetadataIn.md)
+ - [PageAlgorithm](compute_api_client/docs/PageAlgorithm.md)
+ - [PageBackend](compute_api_client/docs/PageBackend.md)
+ - [PageBackendType](compute_api_client/docs/PageBackendType.md)
+ - [PageBatchJob](compute_api_client/docs/PageBatchJob.md)
+ - [PageCommit](compute_api_client/docs/PageCommit.md)
+ - [PageFile](compute_api_client/docs/PageFile.md)
+ - [PageJob](compute_api_client/docs/PageJob.md)
+ - [PageLanguage](compute_api_client/docs/PageLanguage.md)
+ - [PageMember](compute_api_client/docs/PageMember.md)
+ - [PageMetadata](compute_api_client/docs/PageMetadata.md)
+ - [PagePermission](compute_api_client/docs/PagePermission.md)
+ - [PagePermissionGroup](compute_api_client/docs/PagePermissionGroup.md)
+ - [PageProject](compute_api_client/docs/PageProject.md)
+ - [PageReservation](compute_api_client/docs/PageReservation.md)
+ - [PageResult](compute_api_client/docs/PageResult.md)
+ - [PageTeam](compute_api_client/docs/PageTeam.md)
+ - [PageTransaction](compute_api_client/docs/PageTransaction.md)
+ - [PageUser](compute_api_client/docs/PageUser.md)
  - [Permission](compute_api_client/docs/Permission.md)
  - [PermissionGroup](compute_api_client/docs/PermissionGroup.md)
  - [Project](compute_api_client/docs/Project.md)

{qi_compute_api_client-0.32.0 → qi_compute_api_client-0.33.0}/compute_api_client/__init__.py

@@ -5,7 +5,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)
@@ -80,6 +80,24 @@ from compute_api_client.models.member import Member
 from compute_api_client.models.member_in import MemberIn
 from compute_api_client.models.metadata import Metadata
 from compute_api_client.models.metadata_in import MetadataIn
+from compute_api_client.models.page_algorithm import PageAlgorithm
+from compute_api_client.models.page_backend import PageBackend
+from compute_api_client.models.page_backend_type import PageBackendType
+from compute_api_client.models.page_batch_job import PageBatchJob
+from compute_api_client.models.page_commit import PageCommit
+from compute_api_client.models.page_file import PageFile
+from compute_api_client.models.page_job import PageJob
+from compute_api_client.models.page_language import PageLanguage
+from compute_api_client.models.page_member import PageMember
+from compute_api_client.models.page_metadata import PageMetadata
+from compute_api_client.models.page_permission import PagePermission
+from compute_api_client.models.page_permission_group import PagePermissionGroup
+from compute_api_client.models.page_project import PageProject
+from compute_api_client.models.page_reservation import PageReservation
+from compute_api_client.models.page_result import PageResult
+from compute_api_client.models.page_team import PageTeam
+from compute_api_client.models.page_transaction import PageTransaction
+from compute_api_client.models.page_user import PageUser
 from compute_api_client.models.permission import Permission
 from compute_api_client.models.permission_group import PermissionGroup
 from compute_api_client.models.project import Project

{qi_compute_api_client-0.32.0 → qi_compute_api_client-0.33.0}/compute_api_client/api/algorithms_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)
@@ -27,11 +27,12 @@ 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.algorithm import Algorithm
 from compute_api_client.models.algorithm_in import AlgorithmIn
 from compute_api_client.models.algorithm_type import AlgorithmType
+from compute_api_client.models.page_algorithm import PageAlgorithm
 from compute_api_client.models.share_type import ShareType
 
 from compute_api_client.api_client import ApiClient
@@ -862,10 +863,6 @@ class AlgorithmsApi:
     async def read_algorithms_algorithms_get(
         self,
         search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = 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,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
@@ -873,6 +870,10 @@ class AlgorithmsApi:
         link__isnull: Optional[StrictBool] = None,
         link: 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)],
@@ -885,21 +886,13 @@ class AlgorithmsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[Algorithm]:
+    ) -> PageAlgorithm:
         """List algorithms
 
         List algorithms.
 
         :param search: Substring search for algorithm names
         :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 project_id:
@@ -914,6 +907,14 @@ class AlgorithmsApi:
         :type link: 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
@@ -938,10 +939,6 @@ class AlgorithmsApi:
 
         _param = self._read_algorithms_algorithms_get_serialize(
             search=search,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
@@ -949,6 +946,10 @@ class AlgorithmsApi:
             link__isnull=link__isnull,
             link=link,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -956,7 +957,7 @@ class AlgorithmsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Algorithm]",
+            '200': "PageAlgorithm",
             '422': "HTTPValidationError"
             
         }
@@ -975,10 +976,6 @@ class AlgorithmsApi:
     async def read_algorithms_algorithms_get_with_http_info(
         self,
         search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = 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,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
@@ -986,6 +983,10 @@ class AlgorithmsApi:
         link__isnull: Optional[StrictBool] = None,
         link: 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)],
@@ -998,21 +999,13 @@ class AlgorithmsApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[Algorithm]]:
+    ) -> ApiResponse[PageAlgorithm]:
         """List algorithms
 
         List algorithms.
 
         :param search: Substring search for algorithm names
         :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 project_id:
@@ -1027,6 +1020,14 @@ class AlgorithmsApi:
         :type link: 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
@@ -1051,10 +1052,6 @@ class AlgorithmsApi:
 
         _param = self._read_algorithms_algorithms_get_serialize(
             search=search,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
@@ -1062,6 +1059,10 @@ class AlgorithmsApi:
             link__isnull=link__isnull,
             link=link,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1069,7 +1070,7 @@ class AlgorithmsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Algorithm]",
+            '200': "PageAlgorithm",
             '422': "HTTPValidationError"
             
         }
@@ -1088,10 +1089,6 @@ class AlgorithmsApi:
     async def read_algorithms_algorithms_get_without_preload_content(
         self,
         search: Annotated[Optional[StrictStr], Field(description="Substring search for algorithm names")] = 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,
         project_id: Optional[StrictInt] = None,
         type: Optional[AlgorithmType] = None,
@@ -1099,6 +1096,10 @@ class AlgorithmsApi:
         link__isnull: Optional[StrictBool] = None,
         link: 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)],
@@ -1118,14 +1119,6 @@ class AlgorithmsApi:
 
         :param search: Substring search for algorithm names
         :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 project_id:
@@ -1140,6 +1133,14 @@ class AlgorithmsApi:
         :type link: 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
@@ -1164,10 +1165,6 @@ class AlgorithmsApi:
 
         _param = self._read_algorithms_algorithms_get_serialize(
             search=search,
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             project_id=project_id,
             type=type,
@@ -1175,6 +1172,10 @@ class AlgorithmsApi:
             link__isnull=link__isnull,
             link=link,
             name=name,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1182,7 +1183,7 @@ class AlgorithmsApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[Algorithm]",
+            '200': "PageAlgorithm",
             '422': "HTTPValidationError"
             
         }
@@ -1196,10 +1197,6 @@ class AlgorithmsApi:
     def _read_algorithms_algorithms_get_serialize(
         self,
         search,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         project_id,
         type,
@@ -1207,6 +1204,10 @@ class AlgorithmsApi:
         link__isnull,
         link,
         name,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -1232,22 +1233,6 @@ class AlgorithmsApi:
             
             _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))
@@ -1276,6 +1261,22 @@ class AlgorithmsApi:
             
             _query_params.append(('name', name))
             
+        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