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

compute_api_client/api/users_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_user import PageUser
 from compute_api_client.models.user import User
 from compute_api_client.models.user_in import UserIn
 
@@ -856,10 +859,6 @@ class UsersApi:
     @validate_call
     async def read_users_users_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,
         full_name: Optional[StrictStr] = None,
         email: Optional[StrictStr] = None,
@@ -868,6 +867,10 @@ class UsersApi:
         is_active: Optional[StrictBool] = None,
         is_confirmed: Optional[StrictBool] = None,
         oidc_sub: 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)],
@@ -880,19 +883,11 @@ class UsersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> List[User]:
+    ) -> PageUser:
         """List users
 
         Read users.
 
-        :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 full_name:
@@ -909,6 +904,14 @@ class UsersApi:
         :type is_confirmed: bool
         :param oidc_sub:
         :type oidc_sub: 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
@@ -932,10 +935,6 @@ class UsersApi:
         """ # noqa: E501
 
         _param = self._read_users_users_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             full_name=full_name,
             email=email,
@@ -944,6 +943,10 @@ class UsersApi:
             is_active=is_active,
             is_confirmed=is_confirmed,
             oidc_sub=oidc_sub,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -951,7 +954,7 @@ class UsersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[User]",
+            '200': "PageUser",
             '422': "HTTPValidationError"
             
         }
@@ -969,10 +972,6 @@ class UsersApi:
     @validate_call
     async def read_users_users_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,
         full_name: Optional[StrictStr] = None,
         email: Optional[StrictStr] = None,
@@ -981,6 +980,10 @@ class UsersApi:
         is_active: Optional[StrictBool] = None,
         is_confirmed: Optional[StrictBool] = None,
         oidc_sub: 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)],
@@ -993,19 +996,11 @@ class UsersApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[List[User]]:
+    ) -> ApiResponse[PageUser]:
         """List users
 
         Read users.
 
-        :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 full_name:
@@ -1022,6 +1017,14 @@ class UsersApi:
         :type is_confirmed: bool
         :param oidc_sub:
         :type oidc_sub: 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
@@ -1045,10 +1048,6 @@ class UsersApi:
         """ # noqa: E501
 
         _param = self._read_users_users_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             full_name=full_name,
             email=email,
@@ -1057,6 +1056,10 @@ class UsersApi:
             is_active=is_active,
             is_confirmed=is_confirmed,
             oidc_sub=oidc_sub,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1064,7 +1067,7 @@ class UsersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[User]",
+            '200': "PageUser",
             '422': "HTTPValidationError"
             
         }
@@ -1082,10 +1085,6 @@ class UsersApi:
     @validate_call
     async def read_users_users_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,
         full_name: Optional[StrictStr] = None,
         email: Optional[StrictStr] = None,
@@ -1094,6 +1093,10 @@ class UsersApi:
         is_active: Optional[StrictBool] = None,
         is_confirmed: Optional[StrictBool] = None,
         oidc_sub: 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)],
@@ -1111,14 +1114,6 @@ class UsersApi:
 
         Read users.
 
-        :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 full_name:
@@ -1135,6 +1130,14 @@ class UsersApi:
         :type is_confirmed: bool
         :param oidc_sub:
         :type oidc_sub: 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
@@ -1158,10 +1161,6 @@ class UsersApi:
         """ # noqa: E501
 
         _param = self._read_users_users_get_serialize(
-            latest=latest,
-            sort_by=sort_by,
-            page_number=page_number,
-            items_per_page=items_per_page,
             id=id,
             full_name=full_name,
             email=email,
@@ -1170,6 +1169,10 @@ class UsersApi:
             is_active=is_active,
             is_confirmed=is_confirmed,
             oidc_sub=oidc_sub,
+            sort_by=sort_by,
+            latest=latest,
+            page=page,
+            size=size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1177,7 +1180,7 @@ class UsersApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "List[User]",
+            '200': "PageUser",
             '422': "HTTPValidationError"
             
         }
@@ -1190,10 +1193,6 @@ class UsersApi:
 
     def _read_users_users_get_serialize(
         self,
-        latest,
-        sort_by,
-        page_number,
-        items_per_page,
         id,
         full_name,
         email,
@@ -1202,6 +1201,10 @@ class UsersApi:
         is_active,
         is_confirmed,
         oidc_sub,
+        sort_by,
+        latest,
+        page,
+        size,
         _request_auth,
         _content_type,
         _headers,
@@ -1223,22 +1226,6 @@ class UsersApi:
 
         # 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))
@@ -1271,6 +1258,22 @@ class UsersApi:
             
             _query_params.append(('oidc_sub', oidc_sub))
             
+        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_client.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)

compute_api_client/configuration.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)

compute_api_client/docs/AlgorithmsApi.md

@@ -244,7 +244,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_algorithms_algorithms_get**
-> List[Algorithm] read_algorithms_algorithms_get(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, shared=shared, link__isnull=link__isnull, link=link, name=name)
+> PageAlgorithm read_algorithms_algorithms_get(search=search, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List algorithms
 
@@ -257,8 +257,8 @@ List algorithms.
 import time
 import os
 import compute_api_client
-from compute_api_client.models.algorithm import Algorithm
 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.rest import ApiException
 from pprint import pprint
@@ -281,10 +281,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.AlgorithmsApi(api_client)
     search = 'search_example' # str | Substring search for algorithm names (optional)
-    latest = True # bool |  (optional)
-    sort_by = 'sort_by_example' # str |  (optional)
-    page_number = 56 # int |  (optional)
-    items_per_page = 56 # int |  (optional)
     id = 56 # int |  (optional)
     project_id = 56 # int |  (optional)
     type = compute_api_client.AlgorithmType() # AlgorithmType |  (optional)
@@ -292,10 +288,14 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     link__isnull = True # bool |  (optional)
     link = 'link_example' # str |  (optional)
     name = 'name_example' # str |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List algorithms
-        api_response = await api_instance.read_algorithms_algorithms_get(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, shared=shared, link__isnull=link__isnull, link=link, name=name)
+        api_response = await api_instance.read_algorithms_algorithms_get(search=search, id=id, project_id=project_id, type=type, shared=shared, link__isnull=link__isnull, link=link, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of AlgorithmsApi->read_algorithms_algorithms_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -309,10 +309,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **search** | **str**| Substring search for algorithm names | [optional] 
- **latest** | **bool**|  | [optional] 
- **sort_by** | **str**|  | [optional] 
- **page_number** | **int**|  | [optional] 
- **items_per_page** | **int**|  | [optional] 
  **id** | **int**|  | [optional] 
  **project_id** | **int**|  | [optional] 
  **type** | [**AlgorithmType**](.md)|  | [optional] 
@@ -320,10 +316,14 @@ Name | Type | Description  | Notes
  **link__isnull** | **bool**|  | [optional] 
  **link** | **str**|  | [optional] 
  **name** | **str**|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
 
 ### Return type
 
-[**List[Algorithm]**](Algorithm.md)
+[**PageAlgorithm**](PageAlgorithm.md)
 
 ### Authorization
 

compute_api_client/docs/BackendApi.md

@@ -238,7 +238,7 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_backends_backends_get**
-> List[Backend] read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
+> PageBackend read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List backends
 
@@ -251,8 +251,8 @@ Read backends.
 import time
 import os
 import compute_api_client
-from compute_api_client.models.backend import Backend
 from compute_api_client.models.backend_status import BackendStatus
+from compute_api_client.models.page_backend import PageBackend
 from compute_api_client.rest import ApiException
 from pprint import pprint
 
@@ -273,20 +273,20 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.BackendApi(api_client)
-    latest = True # bool |  (optional)
-    sort_by = 'sort_by_example' # str |  (optional)
-    page_number = 56 # int |  (optional)
-    items_per_page = 56 # int |  (optional)
     id = 56 # int |  (optional)
     name = 'name_example' # str |  (optional)
     location = 'location_example' # str |  (optional)
     backend_type_id = 56 # int |  (optional)
     status = compute_api_client.BackendStatus() # BackendStatus |  (optional)
     last_heartbeat = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List backends
-        api_response = await api_instance.read_backends_backends_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat)
+        api_response = await api_instance.read_backends_backends_get(id=id, name=name, location=location, backend_type_id=backend_type_id, status=status, last_heartbeat=last_heartbeat, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of BackendApi->read_backends_backends_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -299,20 +299,20 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **latest** | **bool**|  | [optional] 
- **sort_by** | **str**|  | [optional] 
- **page_number** | **int**|  | [optional] 
- **items_per_page** | **int**|  | [optional] 
  **id** | **int**|  | [optional] 
  **name** | **str**|  | [optional] 
  **location** | **str**|  | [optional] 
  **backend_type_id** | **int**|  | [optional] 
  **status** | [**BackendStatus**](.md)|  | [optional] 
  **last_heartbeat** | **datetime**|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
 
 ### Return type
 
-[**List[Backend]**](Backend.md)
+[**PageBackend**](PageBackend.md)
 
 ### Authorization
 

compute_api_client/docs/BackendTypesApi.md

@@ -85,7 +85,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_backend_types_backend_types_get**
-> List[BackendType] read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots)
+> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List backend types
 
@@ -99,7 +99,7 @@ import time
 import os
 import compute_api_client
 from compute_api_client.models.backend_status import BackendStatus
-from compute_api_client.models.backend_type import BackendType
+from compute_api_client.models.page_backend_type import PageBackendType
 from compute_api_client.rest import ApiException
 from pprint import pprint
 
@@ -120,10 +120,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.BackendTypesApi(api_client)
-    latest = True # bool |  (optional)
-    sort_by = 'sort_by_example' # str |  (optional)
-    page_number = 56 # int |  (optional)
-    items_per_page = 56 # int |  (optional)
     id = 56 # int |  (optional)
     name = 'name_example' # str |  (optional)
     infrastructure = 'infrastructure_example' # str |  (optional)
@@ -133,10 +129,14 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     status = compute_api_client.BackendStatus() # BackendStatus |  (optional)
     default_number_of_shots = 56 # int |  (optional)
     max_number_of_shots = 56 # int |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List backend types
-        api_response = await api_instance.read_backend_types_backend_types_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots)
+        api_response = await api_instance.read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of BackendTypesApi->read_backend_types_backend_types_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -149,10 +149,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **latest** | **bool**|  | [optional] 
- **sort_by** | **str**|  | [optional] 
- **page_number** | **int**|  | [optional] 
- **items_per_page** | **int**|  | [optional] 
  **id** | **int**|  | [optional] 
  **name** | **str**|  | [optional] 
  **infrastructure** | **str**|  | [optional] 
@@ -162,10 +158,14 @@ Name | Type | Description  | Notes
  **status** | [**BackendStatus**](.md)|  | [optional] 
  **default_number_of_shots** | **int**|  | [optional] 
  **max_number_of_shots** | **int**|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
 
 ### Return type
 
-[**List[BackendType]**](BackendType.md)
+[**PageBackendType**](PageBackendType.md)
 
 ### Authorization
 

compute_api_client/docs/BatchJobsApi.md

@@ -403,7 +403,7 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **read_batch_jobs_batch_jobs_get**
-> List[BatchJob] read_batch_jobs_batch_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type)
+> PageBatchJob read_batch_jobs_batch_jobs_get(id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List batch jobs
 
@@ -417,8 +417,8 @@ import time
 import os
 import compute_api_client
 from compute_api_client.models.algorithm_type import AlgorithmType
-from compute_api_client.models.batch_job import BatchJob
 from compute_api_client.models.batch_job_status import BatchJobStatus
+from compute_api_client.models.page_batch_job import PageBatchJob
 from compute_api_client.rest import ApiException
 from pprint import pprint
 
@@ -439,10 +439,6 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.BatchJobsApi(api_client)
-    latest = True # bool |  (optional)
-    sort_by = 'sort_by_example' # str |  (optional)
-    page_number = 56 # int |  (optional)
-    items_per_page = 56 # int |  (optional)
     id = 56 # int |  (optional)
     created_on = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
     status = compute_api_client.BatchJobStatus() # BatchJobStatus |  (optional)
@@ -456,10 +452,14 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     finished_at__isnull = True # bool |  (optional)
     finished_at = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
     aggregated_algorithm_type = compute_api_client.AlgorithmType() # AlgorithmType |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List batch jobs
-        api_response = await api_instance.read_batch_jobs_batch_jobs_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type)
+        api_response = await api_instance.read_batch_jobs_batch_jobs_get(id=id, created_on=created_on, status=status, backend_type_id=backend_type_id, backend_id__isnull=backend_id__isnull, backend_id=backend_id, queued_at__isnull=queued_at__isnull, queued_at=queued_at, reserved_at__isnull=reserved_at__isnull, reserved_at=reserved_at, finished_at__isnull=finished_at__isnull, finished_at=finished_at, aggregated_algorithm_type=aggregated_algorithm_type, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of BatchJobsApi->read_batch_jobs_batch_jobs_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -472,10 +472,6 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **latest** | **bool**|  | [optional] 
- **sort_by** | **str**|  | [optional] 
- **page_number** | **int**|  | [optional] 
- **items_per_page** | **int**|  | [optional] 
  **id** | **int**|  | [optional] 
  **created_on** | **datetime**|  | [optional] 
  **status** | [**BatchJobStatus**](.md)|  | [optional] 
@@ -489,10 +485,14 @@ Name | Type | Description  | Notes
  **finished_at__isnull** | **bool**|  | [optional] 
  **finished_at** | **datetime**|  | [optional] 
  **aggregated_algorithm_type** | [**AlgorithmType**](.md)|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
 
 ### Return type
 
-[**List[BatchJob]**](BatchJob.md)
+[**PageBatchJob**](PageBatchJob.md)
 
 ### Authorization