qi-compute-api-client 0.35.0__tar.gz → 0.37.0__tar.gz

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qi-compute-api-client
-Version: 0.35.0
+Version: 0.37.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

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/api/backend_types_api.py

@@ -786,7 +786,6 @@ class BackendTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'user_bearer'
         ]
 
         return self.api_client.param_serialize(

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/api/files_api.py

@@ -867,6 +867,8 @@ class FilesApi:
         language_id: Optional[StrictInt] = None,
         compile_stage: Optional[CompileStage] = None,
         generated: Optional[StrictBool] = None,
+        name__isnull: Optional[StrictBool] = 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,
@@ -900,6 +902,10 @@ class FilesApi:
         :type compile_stage: CompileStage
         :param generated:
         :type generated: bool
+        :param name__isnull:
+        :type name__isnull: bool
+        :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.
@@ -937,6 +943,8 @@ class FilesApi:
             language_id=language_id,
             compile_stage=compile_stage,
             generated=generated,
+            name__isnull=name__isnull,
+            name=name,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -972,6 +980,8 @@ class FilesApi:
         language_id: Optional[StrictInt] = None,
         compile_stage: Optional[CompileStage] = None,
         generated: Optional[StrictBool] = None,
+        name__isnull: Optional[StrictBool] = 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,
@@ -1005,6 +1015,10 @@ class FilesApi:
         :type compile_stage: CompileStage
         :param generated:
         :type generated: bool
+        :param name__isnull:
+        :type name__isnull: bool
+        :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.
@@ -1042,6 +1056,8 @@ class FilesApi:
             language_id=language_id,
             compile_stage=compile_stage,
             generated=generated,
+            name__isnull=name__isnull,
+            name=name,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1077,6 +1093,8 @@ class FilesApi:
         language_id: Optional[StrictInt] = None,
         compile_stage: Optional[CompileStage] = None,
         generated: Optional[StrictBool] = None,
+        name__isnull: Optional[StrictBool] = 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,
@@ -1110,6 +1128,10 @@ class FilesApi:
         :type compile_stage: CompileStage
         :param generated:
         :type generated: bool
+        :param name__isnull:
+        :type name__isnull: bool
+        :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.
@@ -1147,6 +1169,8 @@ class FilesApi:
             language_id=language_id,
             compile_stage=compile_stage,
             generated=generated,
+            name__isnull=name__isnull,
+            name=name,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -1177,6 +1201,8 @@ class FilesApi:
         language_id,
         compile_stage,
         generated,
+        name__isnull,
+        name,
         sort_by,
         latest,
         page,
@@ -1226,6 +1252,14 @@ class FilesApi:
             
             _query_params.append(('generated', generated))
             
+        if name__isnull is not None:
+            
+            _query_params.append(('name__isnull', name__isnull))
+            
+        if name is not None:
+            
+            _query_params.append(('name', name))
+            
         if sort_by is not None:
             
             _query_params.append(('sort_by', sort_by))

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/api/results_api.py

@@ -29,7 +29,7 @@ from datetime import datetime
 
 from pydantic import StrictBool, StrictFloat, StrictInt, StrictStr
 
-from typing import Any, Dict, Optional, Union
+from typing import Optional, Union
 
 from compute_api_client.models.page_result import PageResult
 from compute_api_client.models.result import Result
@@ -876,7 +876,6 @@ class ResultsApi:
         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,
-        body: Optional[Dict[str, Any]] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -924,8 +923,6 @@ class ResultsApi:
         :type page: int
         :param size: Page size
         :type size: int
-        :param body:
-        :type body: object
         :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
@@ -964,7 +961,6 @@ class ResultsApi:
             latest=latest,
             page=page,
             size=size,
-            body=body,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1006,7 +1002,6 @@ class ResultsApi:
         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,
-        body: Optional[Dict[str, Any]] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1054,8 +1049,6 @@ class ResultsApi:
         :type page: int
         :param size: Page size
         :type size: int
-        :param body:
-        :type body: object
         :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
@@ -1094,7 +1087,6 @@ class ResultsApi:
             latest=latest,
             page=page,
             size=size,
-            body=body,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1136,7 +1128,6 @@ class ResultsApi:
         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,
-        body: Optional[Dict[str, Any]] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1184,8 +1175,6 @@ class ResultsApi:
         :type page: int
         :param size: Page size
         :type size: int
-        :param body:
-        :type body: object
         :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
@@ -1224,7 +1213,6 @@ class ResultsApi:
             latest=latest,
             page=page,
             size=size,
-            body=body,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1261,7 +1249,6 @@ class ResultsApi:
         latest,
         page,
         size,
-        body,
         _request_auth,
         _content_type,
         _headers,
@@ -1353,8 +1340,6 @@ class ResultsApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if body is not None:
-            _body_params = body
 
 
         # set the HTTP header `Accept`
@@ -1364,19 +1349,6 @@ class ResultsApi:
             ]
         )
 
-        # set the HTTP header `Content-Type`
-        if _content_type:
-            _header_params['Content-Type'] = _content_type
-        else:
-            _default_content_type = (
-                self.api_client.select_header_content_type(
-                    [
-                        'application/json'
-                    ]
-                )
-            )
-            if _default_content_type is not None:
-                _header_params['Content-Type'] = _default_content_type
 
         # authentication setting
         _auth_settings: List[str] = [

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/docs/BackendTypesApi.md

@@ -93,7 +93,6 @@ Read backend types.
 
 ### Example
 
-* OAuth Authentication (user_bearer):
 ```python
 import time
 import os
@@ -109,12 +108,6 @@ configuration = compute_api_client.Configuration(
     host = "http://localhost"
 )
 
-# The client must configure the authentication and authorization parameters
-# in accordance with the API server security policy.
-# Examples for each auth method are provided below, use the example that
-# satisfies your auth use case.
-
-configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 # Enter a context with an instance of the API client
 async with compute_api_client.ApiClient(configuration) as api_client:
@@ -171,7 +164,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user_bearer](../README.md#user_bearer)
+No authorization required
 
 ### HTTP request headers
 

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/docs/File.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | 
 **compile_properties** | **object** |  | 
 **generated** | **bool** |  | 
+**name** | **str** |  | [optional] 
 
 ## Example
 

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/docs/FileIn.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **compile_stage** | [**CompileStage**](CompileStage.md) |  | 
 **compile_properties** | **object** |  | 
 **generated** | **bool** |  | [optional] [default to False]
+**name** | **str** |  | [optional] 
 
 ## Example
 

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/docs/FilesApi.md

@@ -243,7 +243,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_files_files_get**
-> PageFile read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, sort_by=sort_by, latest=latest, page=page, size=size)
+> PageFile read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, name__isnull=name__isnull, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List files
 
@@ -284,6 +284,8 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     language_id = 56 # int |  (optional)
     compile_stage = compute_api_client.CompileStage() # CompileStage |  (optional)
     generated = True # bool |  (optional)
+    name__isnull = True # bool |  (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)
@@ -291,7 +293,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
     try:
         # List files
-        api_response = await api_instance.read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, sort_by=sort_by, latest=latest, page=page, size=size)
+        api_response = await api_instance.read_files_files_get(id=id, commit_id=commit_id, content=content, language_id=language_id, compile_stage=compile_stage, generated=generated, name__isnull=name__isnull, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of FilesApi->read_files_files_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -310,6 +312,8 @@ Name | Type | Description  | Notes
  **language_id** | **int**|  | [optional] 
  **compile_stage** | [**CompileStage**](.md)|  | [optional] 
  **generated** | **bool**|  | [optional] 
+ **name__isnull** | **bool**|  | [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]

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/docs/ResultsApi.md

@@ -245,7 +245,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_results_by_algorithm_id_results_algorithm_algorithm_id_get**
-> PageResult read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, sort_by=sort_by, latest=latest, page=page, size=size, body=body)
+> PageResult read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, sort_by=sort_by, latest=latest, page=page, size=size)
 
 Retrieve results by algorithm ID
 
@@ -294,11 +294,10 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     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)
-    body = None # object |  (optional)
 
     try:
         # Retrieve results by algorithm ID
-        api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, sort_by=sort_by, latest=latest, page=page, size=size, body=body)
+        api_response = await api_instance.read_results_by_algorithm_id_results_algorithm_algorithm_id_get(algorithm_id, id=id, created_on=created_on, job_id=job_id, metadata_id=metadata_id, execution_time_in_seconds=execution_time_in_seconds, shots_requested__isnull=shots_requested__isnull, shots_requested=shots_requested, shots_done__isnull=shots_done__isnull, shots_done=shots_done, results__isnull=results__isnull, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of ResultsApi->read_results_by_algorithm_id_results_algorithm_algorithm_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -326,7 +325,6 @@ Name | Type | Description  | Notes
  **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]
- **body** | **object**|  | [optional] 
 
 ### Return type
 
@@ -338,7 +336,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 ### HTTP response details

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/models/file.py

@@ -18,8 +18,10 @@ import re  # noqa: F401
 import json
 
 
-from typing import Any, ClassVar, Dict, List, Union
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
 from compute_api_client.models.compile_stage import CompileStage
 try:
     from typing import Self
@@ -37,7 +39,8 @@ class File(BaseModel):
     compile_stage: CompileStage
     compile_properties: Union[str, Any]
     generated: StrictBool
-    __properties: ClassVar[List[str]] = ["id", "commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated"]
+    name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    __properties: ClassVar[List[str]] = ["id", "commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated", "name"]
 
     model_config = {
         "populate_by_name": True,
@@ -75,6 +78,11 @@ class File(BaseModel):
             },
             exclude_none=True,
         )
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
         return _dict
 
     @classmethod
@@ -93,7 +101,8 @@ class File(BaseModel):
             "language_id": obj.get("language_id"),
             "compile_stage": obj.get("compile_stage"),
             "compile_properties": obj.get("compile_properties"),
-            "generated": obj.get("generated")
+            "generated": obj.get("generated"),
+            "name": obj.get("name")
         })
         return _obj
 

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/compute_api_client/models/file_in.py

@@ -20,6 +20,8 @@ import json
 
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
+from pydantic import Field
+from typing_extensions import Annotated
 from compute_api_client.models.compile_stage import CompileStage
 try:
     from typing import Self
@@ -36,7 +38,8 @@ class FileIn(BaseModel):
     compile_stage: CompileStage
     compile_properties: Union[str, Any]
     generated: Optional[StrictBool] = False
-    __properties: ClassVar[List[str]] = ["commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated"]
+    name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    __properties: ClassVar[List[str]] = ["commit_id", "content", "language_id", "compile_stage", "compile_properties", "generated", "name"]
 
     model_config = {
         "populate_by_name": True,
@@ -74,6 +77,11 @@ class FileIn(BaseModel):
             },
             exclude_none=True,
         )
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
         return _dict
 
     @classmethod
@@ -91,7 +99,8 @@ class FileIn(BaseModel):
             "language_id": obj.get("language_id"),
             "compile_stage": obj.get("compile_stage"),
             "compile_properties": obj.get("compile_properties"),
-            "generated": obj.get("generated") if obj.get("generated") is not None else False
+            "generated": obj.get("generated") if obj.get("generated") is not None else False,
+            "name": obj.get("name")
         })
         return _obj
 

{qi_compute_api_client-0.35.0 → qi_compute_api_client-0.37.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "qi-compute-api-client"
-version = "0.35.0"
+version = "0.37.0"
 description = "An API client for the Compute Job Manager of Quantum Inspire."
 license = "Apache-2.0"
 authors = ["Quantum Inspire <support@quantum-inspire.eu>"]