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

compute_api_client/api/projects_api.py

@@ -23,6 +23,8 @@ try:
 except ImportError:
     from typing_extensions import Annotated
 
+from pydantic import Field
+from typing_extensions import Annotated
 from datetime import datetime
 
 from pydantic import StrictBool, StrictInt, StrictStr
@@ -308,6 +310,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -567,6 +570,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -863,6 +867,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1131,6 +1136,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1155,6 +1161,7 @@ class ProjectsApi:
     @validate_call
     async def read_projects_projects_get(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
         latest: Optional[StrictBool] = None,
         sort_by: Optional[StrictStr] = None,
         page_number: Optional[StrictInt] = None,
@@ -1180,8 +1187,10 @@ class ProjectsApi:
     ) -> List[Project]:
         """List projects
 
-        List projects.
+        List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
+        :param search: Substring search for project names or description
+        :type search: str
         :param latest:
         :type latest: bool
         :param sort_by:
@@ -1225,6 +1234,7 @@ class ProjectsApi:
         """ # noqa: E501
 
         _param = self._read_projects_projects_get_serialize(
+            search=search,
             latest=latest,
             sort_by=sort_by,
             page_number=page_number,
@@ -1260,6 +1270,7 @@ class ProjectsApi:
     @validate_call
     async def read_projects_projects_get_with_http_info(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
         latest: Optional[StrictBool] = None,
         sort_by: Optional[StrictStr] = None,
         page_number: Optional[StrictInt] = None,
@@ -1285,8 +1296,10 @@ class ProjectsApi:
     ) -> ApiResponse[List[Project]]:
         """List projects
 
-        List projects.
+        List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
+        :param search: Substring search for project names or description
+        :type search: str
         :param latest:
         :type latest: bool
         :param sort_by:
@@ -1330,6 +1343,7 @@ class ProjectsApi:
         """ # noqa: E501
 
         _param = self._read_projects_projects_get_serialize(
+            search=search,
             latest=latest,
             sort_by=sort_by,
             page_number=page_number,
@@ -1365,6 +1379,7 @@ class ProjectsApi:
     @validate_call
     async def read_projects_projects_get_without_preload_content(
         self,
+        search: Annotated[Optional[StrictStr], Field(description="Substring search for project names or description")] = None,
         latest: Optional[StrictBool] = None,
         sort_by: Optional[StrictStr] = None,
         page_number: Optional[StrictInt] = None,
@@ -1390,8 +1405,10 @@ class ProjectsApi:
     ) -> RESTResponseType:
         """List projects
 
-        List projects.
+        List projects.  If the search parameter is provided, the list is filtered based on the condition that either the project name OR description contains the specified substring. The filter considers exact matches for other parameters provided. The final result is the logical AND of the substring match condition and any other provided exact match conditions.
 
+        :param search: Substring search for project names or description
+        :type search: str
         :param latest:
         :type latest: bool
         :param sort_by:
@@ -1435,6 +1452,7 @@ class ProjectsApi:
         """ # noqa: E501
 
         _param = self._read_projects_projects_get_serialize(
+            search=search,
             latest=latest,
             sort_by=sort_by,
             page_number=page_number,
@@ -1465,6 +1483,7 @@ class ProjectsApi:
 
     def _read_projects_projects_get_serialize(
         self,
+        search,
         latest,
         sort_by,
         page_number,
@@ -1496,6 +1515,10 @@ class ProjectsApi:
 
         # process the path parameters
         # process the query parameters
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
         if latest is not None:
             
             _query_params.append(('latest', latest))
@@ -1560,6 +1583,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1856,6 +1880,7 @@ class ProjectsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/reservations_api.py

@@ -307,6 +307,7 @@ class ReservationsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -575,6 +576,7 @@ class ReservationsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1047,6 +1049,7 @@ class ReservationsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1315,6 +1318,7 @@ class ReservationsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/results_api.py

@@ -832,6 +832,7 @@ class ResultsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -1100,6 +1101,7 @@ class ResultsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/teams_api.py

@@ -294,6 +294,7 @@ class TeamsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -680,6 +681,7 @@ class TeamsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/transactions_api.py

@@ -297,6 +297,7 @@ class TransactionsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -794,6 +795,7 @@ class TransactionsApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/api/users_api.py

@@ -305,6 +305,7 @@ class UsersApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -564,6 +565,7 @@ class UsersApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -832,6 +834,7 @@ class UsersApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 
@@ -867,6 +870,7 @@ class UsersApi:
         is_staff: Optional[StrictBool] = None,
         is_active: Optional[StrictBool] = None,
         is_confirmed: Optional[StrictBool] = None,
+        oidc_sub: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -906,6 +910,8 @@ class UsersApi:
         :type is_active: bool
         :param is_confirmed:
         :type is_confirmed: bool
+        :param oidc_sub:
+        :type oidc_sub: str
         :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
@@ -940,6 +946,7 @@ class UsersApi:
             is_staff=is_staff,
             is_active=is_active,
             is_confirmed=is_confirmed,
+            oidc_sub=oidc_sub,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -976,6 +983,7 @@ class UsersApi:
         is_staff: Optional[StrictBool] = None,
         is_active: Optional[StrictBool] = None,
         is_confirmed: Optional[StrictBool] = None,
+        oidc_sub: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1015,6 +1023,8 @@ class UsersApi:
         :type is_active: bool
         :param is_confirmed:
         :type is_confirmed: bool
+        :param oidc_sub:
+        :type oidc_sub: str
         :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
@@ -1049,6 +1059,7 @@ class UsersApi:
             is_staff=is_staff,
             is_active=is_active,
             is_confirmed=is_confirmed,
+            oidc_sub=oidc_sub,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1085,6 +1096,7 @@ class UsersApi:
         is_staff: Optional[StrictBool] = None,
         is_active: Optional[StrictBool] = None,
         is_confirmed: Optional[StrictBool] = None,
+        oidc_sub: Optional[StrictStr] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1124,6 +1136,8 @@ class UsersApi:
         :type is_active: bool
         :param is_confirmed:
         :type is_confirmed: bool
+        :param oidc_sub:
+        :type oidc_sub: str
         :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,6 +1172,7 @@ class UsersApi:
             is_staff=is_staff,
             is_active=is_active,
             is_confirmed=is_confirmed,
+            oidc_sub=oidc_sub,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -1189,6 +1204,7 @@ class UsersApi:
         is_staff,
         is_active,
         is_confirmed,
+        oidc_sub,
         _request_auth,
         _content_type,
         _headers,
@@ -1254,6 +1270,10 @@ class UsersApi:
             
             _query_params.append(('is_confirmed', is_confirmed))
             
+        if oidc_sub is not None:
+            
+            _query_params.append(('oidc_sub', oidc_sub))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -1269,6 +1289,7 @@ class UsersApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'user_bearer', 
             'user'
         ]
 

compute_api_client/configuration.py

@@ -382,6 +382,13 @@ conf = compute_api_client.Configuration(
                     'user',
                 ),
             }
+        if self.access_token is not None:
+            auth['user_bearer'] = {
+                'type': 'oauth2',
+                'in': 'header',
+                'key': 'Authorization',
+                'value': 'Bearer ' + self.access_token
+            }
         if 'backend' in self.api_key:
             auth['backend'] = {
                 'type': 'api_key',

compute_api_client/docs/AlgorithmsApi.md

@@ -20,6 +20,7 @@ Create new algorithm.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
@@ -41,6 +42,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -76,7 +79,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -100,6 +103,7 @@ Delete an algorithm.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
@@ -119,6 +123,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -152,7 +158,7 @@ void (empty response body)
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -177,6 +183,7 @@ Get algorithm by ID.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (backend):
 * Api Key Authentication (user):
 ```python
@@ -198,6 +205,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: backend
 configuration.api_key['backend'] = os.environ["API_KEY"]
 
@@ -239,7 +248,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[backend](../README.md#backend), [user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [backend](../README.md#backend), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -256,7 +265,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(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__isnull=name__isnull, name=name)
+> 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__isnull=name__isnull, name=name)
 
 List algorithms
 
@@ -264,6 +273,7 @@ List algorithms.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
@@ -286,6 +296,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -296,6 +308,7 @@ configuration.api_key['user'] = os.environ["API_KEY"]
 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)
@@ -311,7 +324,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
     try:
         # List algorithms
-        api_response = await api_instance.read_algorithms_algorithms_get(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__isnull=name__isnull, name=name)
+        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__isnull=name__isnull, name=name)
         print("The response of AlgorithmsApi->read_algorithms_algorithms_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -324,6 +337,7 @@ 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] 
@@ -343,7 +357,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -367,6 +381,7 @@ Update an algorithm.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
@@ -388,6 +403,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -425,7 +442,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 

compute_api_client/docs/BackendApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **create_backend_backends_post**
-> BackendWithAuthentication create_backend_backends_post(backend)
+> BackendWithAuthentication create_backend_backends_post(backend_in)
 
 Create backend
 
@@ -20,12 +20,13 @@ Create new backend.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
 import os
 import compute_api_client
-from compute_api_client.models.backend import Backend
+from compute_api_client.models.backend_in import BackendIn
 from compute_api_client.models.backend_with_authentication import BackendWithAuthentication
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -41,6 +42,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -51,11 +54,11 @@ configuration.api_key['user'] = os.environ["API_KEY"]
 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)
-    backend = compute_api_client.Backend() # Backend | 
+    backend_in = compute_api_client.BackendIn() # BackendIn | 
 
     try:
         # Create backend
-        api_response = await api_instance.create_backend_backends_post(backend)
+        api_response = await api_instance.create_backend_backends_post(backend_in)
         print("The response of BackendApi->create_backend_backends_post:\n")
         pprint(api_response)
     except Exception as e:
@@ -68,7 +71,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **backend** | [**Backend**](Backend.md)|  | 
+ **backend_in** | [**BackendIn**](BackendIn.md)|  | 
 
 ### Return type
 
@@ -76,7 +79,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -100,6 +103,7 @@ Get backend by ID.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
@@ -120,6 +124,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -155,7 +161,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 
@@ -254,6 +260,7 @@ Read backends.
 
 ### Example
 
+* OAuth Authentication (user_bearer):
 * Api Key Authentication (user):
 ```python
 import time
@@ -275,6 +282,8 @@ configuration = compute_api_client.Configuration(
 # Examples for each auth method are provided below, use the example that
 # satisfies your auth use case.
 
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
 # Configure API key authorization: user
 configuration.api_key['user'] = os.environ["API_KEY"]
 
@@ -328,7 +337,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user](../README.md#user)
+[user_bearer](../README.md#user_bearer), [user](../README.md#user)
 
 ### HTTP request headers
 

compute_api_client/docs/BackendIn.md

@@ -0,0 +1,32 @@
+# BackendIn
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | 
+**location** | **str** |  | 
+**backend_type_id** | **int** |  | 
+**status** | [**BackendStatus**](BackendStatus.md) |  | 
+**last_heartbeat** | **datetime** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.backend_in import BackendIn
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BackendIn from a JSON string
+backend_in_instance = BackendIn.from_json(json)
+# print the JSON string representation of the object
+print BackendIn.to_json()
+
+# convert the object into a dict
+backend_in_dict = backend_in_instance.to_dict()
+# create an instance of BackendIn from a dict
+backend_in_form_dict = backend_in.from_dict(backend_in_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/BackendType.md

@@ -13,6 +13,9 @@ Name | Type | Description | Notes
 **features** | **List[str]** |  | 
 **default_compiler_config** | **object** |  | 
 **native_gateset** | **object** |  | 
+**status** | [**BackendStatus**](BackendStatus.md) |  | 
+**default_number_of_shots** | **int** |  | 
+**max_number_of_shots** | **int** |  | 
 
 ## Example