qi-compute-api-client 0.21.0__py3-none-any.whl → 0.31.0__py3-none-any.whl

compute_api_client/docs/User.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **is_staff** | **bool** |  | 
 **is_active** | **bool** |  | 
 **is_confirmed** | **bool** |  | 
+**oidc_sub** | **str** |  | 
 
 ## Example
 

compute_api_client/docs/UserIn.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **is_staff** | **bool** |  | [optional] [default to False]
 **is_active** | **bool** |  | [optional] [default to False]
 **is_confirmed** | **bool** |  | [optional] [default to False]
+**oidc_sub** | **str** |  | 
 
 ## Example
 

compute_api_client/docs/UsersApi.md

@@ -19,7 +19,7 @@ Create new user.
 
 ### Example
 
-* Api Key Authentication (user):
+* OAuth Authentication (user_bearer):
 ```python
 import time
 import os
@@ -40,11 +40,7 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: user
-configuration.api_key['user'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
+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:
@@ -75,7 +71,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer)
 
 ### HTTP request headers
 
@@ -99,7 +95,7 @@ Delete a user.
 
 ### Example
 
-* Api Key Authentication (user):
+* OAuth Authentication (user_bearer):
 ```python
 import time
 import os
@@ -118,11 +114,7 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: user
-configuration.api_key['user'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
+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:
@@ -151,7 +143,7 @@ void (empty response body)
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer)
 
 ### HTTP request headers
 
@@ -176,7 +168,7 @@ Get user by ID.
 
 ### Example
 
-* Api Key Authentication (user):
+* OAuth Authentication (user_bearer):
 ```python
 import time
 import os
@@ -196,11 +188,7 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: user
-configuration.api_key['user'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
+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:
@@ -231,7 +219,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer)
 
 ### HTTP request headers
 
@@ -248,7 +236,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_users_users_get**
-> List[User] read_users_users_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed)
+> List[User] read_users_users_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub)
 
 List users
 
@@ -256,7 +244,7 @@ Read users.
 
 ### Example
 
-* Api Key Authentication (user):
+* OAuth Authentication (user_bearer):
 ```python
 import time
 import os
@@ -276,11 +264,7 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: user
-configuration.api_key['user'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
+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:
@@ -297,10 +281,11 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     is_staff = True # bool |  (optional)
     is_active = True # bool |  (optional)
     is_confirmed = True # bool |  (optional)
+    oidc_sub = 'oidc_sub_example' # str |  (optional)
 
     try:
         # List users
-        api_response = await api_instance.read_users_users_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed)
+        api_response = await api_instance.read_users_users_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, full_name=full_name, email=email, is_superuser=is_superuser, is_staff=is_staff, is_active=is_active, is_confirmed=is_confirmed, oidc_sub=oidc_sub)
         print("The response of UsersApi->read_users_users_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -324,6 +309,7 @@ Name | Type | Description  | Notes
  **is_staff** | **bool**|  | [optional] 
  **is_active** | **bool**|  | [optional] 
  **is_confirmed** | **bool**|  | [optional] 
+ **oidc_sub** | **str**|  | [optional] 
 
 ### Return type
 
@@ -331,7 +317,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer)
 
 ### HTTP request headers
 

compute_api_client/models/__init__.py

@@ -18,6 +18,7 @@ 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.backend import Backend
+from compute_api_client.models.backend_in import BackendIn
 from compute_api_client.models.backend_patch import BackendPatch
 from compute_api_client.models.backend_status import BackendStatus
 from compute_api_client.models.backend_type import BackendType

compute_api_client/models/algorithm.py

@@ -38,7 +38,7 @@ class Algorithm(BaseModel):
     type: AlgorithmType
     shared: ShareType
     link: Optional[Annotated[str, Field(strict=True, max_length=255)]]
-    name: Optional[Annotated[str, Field(strict=True, max_length=255)]]
+    name: Annotated[str, Field(strict=True, max_length=255)]
     __properties: ClassVar[List[str]] = ["id", "project_id", "type", "shared", "link", "name"]
 
     model_config = {
@@ -82,11 +82,6 @@ class Algorithm(BaseModel):
         if self.link is None and "link" in self.model_fields_set:
             _dict['link'] = None
 
-        # 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

compute_api_client/models/algorithm_in.py

@@ -37,7 +37,7 @@ class AlgorithmIn(BaseModel):
     type: AlgorithmType
     shared: ShareType
     link: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
-    name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    name: Annotated[str, Field(strict=True, max_length=255)]
     __properties: ClassVar[List[str]] = ["project_id", "type", "shared", "link", "name"]
 
     model_config = {
@@ -81,11 +81,6 @@ class AlgorithmIn(BaseModel):
         if self.link is None and "link" in self.model_fields_set:
             _dict['link'] = None
 
-        # 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

compute_api_client/models/backend_in.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    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. 
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, StrictInt
+from pydantic import Field
+from typing_extensions import Annotated
+from compute_api_client.models.backend_status import BackendStatus
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class BackendIn(BaseModel):
+    """
+    BackendIn
+    """ # noqa: E501
+    name: Annotated[str, Field(strict=True, max_length=32)]
+    location: Annotated[str, Field(strict=True, max_length=32)]
+    backend_type_id: StrictInt
+    status: BackendStatus
+    last_heartbeat: datetime
+    __properties: ClassVar[List[str]] = ["name", "location", "backend_type_id", "status", "last_heartbeat"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BackendIn from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of BackendIn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "location": obj.get("location"),
+            "backend_type_id": obj.get("backend_type_id"),
+            "status": obj.get("status"),
+            "last_heartbeat": obj.get("last_heartbeat")
+        })
+        return _obj
+
+

compute_api_client/models/backend_type.py

@@ -22,6 +22,7 @@ from typing import Any, ClassVar, Dict, List, Union
 from pydantic import BaseModel, StrictBool, StrictInt, StrictStr
 from pydantic import Field
 from typing_extensions import Annotated
+from compute_api_client.models.backend_status import BackendStatus
 try:
     from typing import Self
 except ImportError:
@@ -40,7 +41,10 @@ class BackendType(BaseModel):
     features: List[StrictStr]
     default_compiler_config: Union[str, Any]
     native_gateset: Union[str, Any]
-    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "features", "default_compiler_config", "native_gateset"]
+    status: BackendStatus
+    default_number_of_shots: StrictInt
+    max_number_of_shots: StrictInt
+    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "features", "default_compiler_config", "native_gateset", "status", "default_number_of_shots", "max_number_of_shots"]
 
     model_config = {
         "populate_by_name": True,
@@ -98,7 +102,10 @@ class BackendType(BaseModel):
             "is_hardware": obj.get("is_hardware"),
             "features": obj.get("features"),
             "default_compiler_config": obj.get("default_compiler_config"),
-            "native_gateset": obj.get("native_gateset")
+            "native_gateset": obj.get("native_gateset"),
+            "status": obj.get("status"),
+            "default_number_of_shots": obj.get("default_number_of_shots"),
+            "max_number_of_shots": obj.get("max_number_of_shots")
         })
         return _obj
 

compute_api_client/models/batch_job_in.py

@@ -29,9 +29,8 @@ class BatchJobIn(BaseModel):
     """
     BatchJobIn
     """ # noqa: E501
-    user_id: StrictInt
     backend_type_id: StrictInt
-    __properties: ClassVar[List[str]] = ["user_id", "backend_type_id"]
+    __properties: ClassVar[List[str]] = ["backend_type_id"]
 
     model_config = {
         "populate_by_name": True,
@@ -81,7 +80,6 @@ class BatchJobIn(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "user_id": obj.get("user_id"),
             "backend_type_id": obj.get("backend_type_id")
         })
         return _obj

compute_api_client/models/job_in.py

@@ -20,7 +20,6 @@ import json
 
 from typing import Any, ClassVar, Dict, List, Optional
 from pydantic import BaseModel, StrictInt
-from compute_api_client.models.job_status import JobStatus
 try:
     from typing import Self
 except ImportError:
@@ -31,10 +30,9 @@ class JobIn(BaseModel):
     JobIn
     """ # noqa: E501
     file_id: StrictInt
-    status: Optional[JobStatus] = None
     batch_job_id: StrictInt
     number_of_shots: Optional[StrictInt] = None
-    __properties: ClassVar[List[str]] = ["file_id", "status", "batch_job_id", "number_of_shots"]
+    __properties: ClassVar[List[str]] = ["file_id", "batch_job_id", "number_of_shots"]
 
     model_config = {
         "populate_by_name": True,
@@ -90,7 +88,6 @@ class JobIn(BaseModel):
 
         _obj = cls.model_validate({
             "file_id": obj.get("file_id"),
-            "status": obj.get("status"),
             "batch_job_id": obj.get("batch_job_id"),
             "number_of_shots": obj.get("number_of_shots")
         })

compute_api_client/models/transaction.py

@@ -36,10 +36,10 @@ class Transaction(BaseModel):
     domain: Optional[Domain]
     job: Optional[StrictInt]
     team_id: StrictInt
-    user_id: Optional[StrictInt]
+    member_id: Optional[StrictInt]
     change: Annotated[int, Field(strict=True, ge=-32768)]
     timestamp: datetime
-    __properties: ClassVar[List[str]] = ["id", "domain", "job", "team_id", "user_id", "change", "timestamp"]
+    __properties: ClassVar[List[str]] = ["id", "domain", "job", "team_id", "member_id", "change", "timestamp"]
 
     model_config = {
         "populate_by_name": True,
@@ -87,10 +87,10 @@ class Transaction(BaseModel):
         if self.job is None and "job" in self.model_fields_set:
             _dict['job'] = None
 
-        # set to None if user_id (nullable) is None
+        # set to None if member_id (nullable) is None
         # and model_fields_set contains the field
-        if self.user_id is None and "user_id" in self.model_fields_set:
-            _dict['user_id'] = None
+        if self.member_id is None and "member_id" in self.model_fields_set:
+            _dict['member_id'] = None
 
         return _dict
 
@@ -108,7 +108,7 @@ class Transaction(BaseModel):
             "domain": obj.get("domain"),
             "job": obj.get("job"),
             "team_id": obj.get("team_id"),
-            "user_id": obj.get("user_id"),
+            "member_id": obj.get("member_id"),
             "change": obj.get("change"),
             "timestamp": obj.get("timestamp")
         })

compute_api_client/models/user.py

@@ -38,7 +38,8 @@ class User(BaseModel):
     is_staff: StrictBool
     is_active: StrictBool
     is_confirmed: StrictBool
-    __properties: ClassVar[List[str]] = ["id", "full_name", "email", "is_superuser", "is_staff", "is_active", "is_confirmed"]
+    oidc_sub: Annotated[str, Field(strict=True, max_length=256)]
+    __properties: ClassVar[List[str]] = ["id", "full_name", "email", "is_superuser", "is_staff", "is_active", "is_confirmed", "oidc_sub"]
 
     model_config = {
         "populate_by_name": True,
@@ -94,7 +95,8 @@ class User(BaseModel):
             "is_superuser": obj.get("is_superuser"),
             "is_staff": obj.get("is_staff"),
             "is_active": obj.get("is_active"),
-            "is_confirmed": obj.get("is_confirmed")
+            "is_confirmed": obj.get("is_confirmed"),
+            "oidc_sub": obj.get("oidc_sub")
         })
         return _obj
 

compute_api_client/models/user_in.py

@@ -37,7 +37,8 @@ class UserIn(BaseModel):
     is_staff: Optional[StrictBool] = False
     is_active: Optional[StrictBool] = False
     is_confirmed: Optional[StrictBool] = False
-    __properties: ClassVar[List[str]] = ["full_name", "email", "is_superuser", "is_staff", "is_active", "is_confirmed"]
+    oidc_sub: Annotated[str, Field(strict=True, max_length=256)]
+    __properties: ClassVar[List[str]] = ["full_name", "email", "is_superuser", "is_staff", "is_active", "is_confirmed", "oidc_sub"]
 
     model_config = {
         "populate_by_name": True,
@@ -92,7 +93,8 @@ class UserIn(BaseModel):
             "is_superuser": obj.get("is_superuser") if obj.get("is_superuser") is not None else False,
             "is_staff": obj.get("is_staff") if obj.get("is_staff") is not None else False,
             "is_active": obj.get("is_active") if obj.get("is_active") is not None else False,
-            "is_confirmed": obj.get("is_confirmed") if obj.get("is_confirmed") is not None else False
+            "is_confirmed": obj.get("is_confirmed") if obj.get("is_confirmed") is not None else False,
+            "oidc_sub": obj.get("oidc_sub")
         })
         return _obj
 

{qi_compute_api_client-0.21.0.dist-info → qi_compute_api_client-0.31.0.dist-info}/METADATA

@@ -1,20 +1,20 @@
 Metadata-Version: 2.1
 Name: qi-compute-api-client
-Version: 0.21.0
+Version: 0.31.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
 Author: Quantum Inspire
 Author-email: support@quantum-inspire.eu
-Requires-Python: >=3.7,<4.0
+Requires-Python: >=3.8,<4.0
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
 Requires-Dist: urllib3 (>=1.25.3,<2.0.0)
@@ -68,11 +68,7 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
-# Configure API key authorization: user
-configuration.api_key['user'] = os.environ["API_KEY"]
-
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['user'] = 'Bearer'
+configuration.access_token = os.environ["ACCESS_TOKEN"]
 
 
 # Enter a context with an instance of the API client
@@ -158,6 +154,7 @@ Class | Method | HTTP request | Description
 *ResultsApi* | [**create_result_results_post**](compute_api_client/docs/ResultsApi.md#create_result_results_post) | **POST** /results | Create result
 *ResultsApi* | [**delete_results_by_job_id_results_job_job_id_delete**](compute_api_client/docs/ResultsApi.md#delete_results_by_job_id_results_job_job_id_delete) | **DELETE** /results/job/{job_id} | Delete results by job ID
 *ResultsApi* | [**read_result_results_id_get**](compute_api_client/docs/ResultsApi.md#read_result_results_id_get) | **GET** /results/{id} | Retrieve result
+*ResultsApi* | [**read_results_by_algorithm_id_results_algorithm_algorithm_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_algorithm_id_results_algorithm_algorithm_id_get) | **GET** /results/algorithm/{algorithm_id} | Retrieve results by algorithm ID
 *ResultsApi* | [**read_results_by_job_id_results_job_job_id_get**](compute_api_client/docs/ResultsApi.md#read_results_by_job_id_results_job_job_id_get) | **GET** /results/job/{job_id} | Retrieve results by job ID
 *TeamsApi* | [**read_team_teams_id_get**](compute_api_client/docs/TeamsApi.md#read_team_teams_id_get) | **GET** /teams/{id} | Retrieve teams
 *TeamsApi* | [**read_teams_teams_get**](compute_api_client/docs/TeamsApi.md#read_teams_teams_get) | **GET** /teams/ | List teams
@@ -175,6 +172,7 @@ Class | Method | HTTP request | Description
  - [AlgorithmIn](compute_api_client/docs/AlgorithmIn.md)
  - [AlgorithmType](compute_api_client/docs/AlgorithmType.md)
  - [Backend](compute_api_client/docs/Backend.md)
+ - [BackendIn](compute_api_client/docs/BackendIn.md)
  - [BackendPatch](compute_api_client/docs/BackendPatch.md)
  - [BackendStatus](compute_api_client/docs/BackendStatus.md)
  - [BackendType](compute_api_client/docs/BackendType.md)
@@ -225,12 +223,13 @@ Class | Method | HTTP request | Description
 
 
 Authentication schemes defined for the API:
-<a id="user"></a>
-### user
+<a id="user_bearer"></a>
+### user_bearer
 
-- **Type**: API key
-- **API key parameter name**: X-userid
-- **Location**: HTTP header
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_staging/protocol/openid-connect/auth
+- **Scopes**: N/A
 
 <a id="backend"></a>
 ### backend