qi-compute-api-client 0.51.0__tar.gz → 0.52.0__tar.gz

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qi-compute-api-client
-Version: 0.51.0
+Version: 0.52.0
 Summary: An API client for the Compute Job Manager of Quantum Inspire.
 Project-URL: Repository, https://github.com/QuTech-Delft/compute-api-client
 Author-email: Quantum Inspire <support@quantum-inspire.eu>

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/compute_api_client/api/backend_types_api.py

@@ -336,6 +336,7 @@ class BackendTypesApi:
         default_number_of_shots: Optional[StrictInt] = None,
         max_number_of_shots: Optional[StrictInt] = None,
         enabled: Optional[StrictBool] = None,
+        identifier: 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,
@@ -381,6 +382,8 @@ class BackendTypesApi:
         :type max_number_of_shots: int
         :param enabled:
         :type enabled: bool
+        :param identifier:
+        :type identifier: 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.
@@ -424,6 +427,7 @@ class BackendTypesApi:
             default_number_of_shots=default_number_of_shots,
             max_number_of_shots=max_number_of_shots,
             enabled=enabled,
+            identifier=identifier,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -465,6 +469,7 @@ class BackendTypesApi:
         default_number_of_shots: Optional[StrictInt] = None,
         max_number_of_shots: Optional[StrictInt] = None,
         enabled: Optional[StrictBool] = None,
+        identifier: 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,
@@ -510,6 +515,8 @@ class BackendTypesApi:
         :type max_number_of_shots: int
         :param enabled:
         :type enabled: bool
+        :param identifier:
+        :type identifier: 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.
@@ -553,6 +560,7 @@ class BackendTypesApi:
             default_number_of_shots=default_number_of_shots,
             max_number_of_shots=max_number_of_shots,
             enabled=enabled,
+            identifier=identifier,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -594,6 +602,7 @@ class BackendTypesApi:
         default_number_of_shots: Optional[StrictInt] = None,
         max_number_of_shots: Optional[StrictInt] = None,
         enabled: Optional[StrictBool] = None,
+        identifier: 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,
@@ -639,6 +648,8 @@ class BackendTypesApi:
         :type max_number_of_shots: int
         :param enabled:
         :type enabled: bool
+        :param identifier:
+        :type identifier: 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.
@@ -682,6 +693,7 @@ class BackendTypesApi:
             default_number_of_shots=default_number_of_shots,
             max_number_of_shots=max_number_of_shots,
             enabled=enabled,
+            identifier=identifier,
             sort_by=sort_by,
             latest=latest,
             page=page,
@@ -718,6 +730,7 @@ class BackendTypesApi:
         default_number_of_shots,
         max_number_of_shots,
         enabled,
+        identifier,
         sort_by,
         latest,
         page,
@@ -791,6 +804,10 @@ class BackendTypesApi:
             
             _query_params.append(('enabled', enabled))
             
+        if identifier is not None:
+            
+            _query_params.append(('identifier', identifier))
+            
         if sort_by is not None:
             
             _query_params.append(('sort_by', sort_by))

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/compute_api_client/docs/BackendType.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **default_number_of_shots** | **int** |  | 
 **max_number_of_shots** | **int** |  | 
 **enabled** | **bool** |  | 
+**identifier** | **str** |  | 
 
 ## Example
 

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/compute_api_client/docs/BackendTypePatch.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **default_number_of_shots** | **int** |  | [optional] 
 **max_number_of_shots** | **int** |  | [optional] 
 **enabled** | **bool** |  | [optional] 
+**identifier** | **str** |  | [optional] 
 
 ## Example
 

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/compute_api_client/docs/BackendTypesApi.md

@@ -93,7 +93,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**
-> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, sort_by=sort_by, latest=latest, page=page, size=size)
+> PageBackendType read_backend_types_backend_types_get(id=id, name=name, infrastructure=infrastructure, description=description, image_id=image_id, is_hardware=is_hardware, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, identifier=identifier, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List backend types
 
@@ -133,6 +133,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
     default_number_of_shots = 56 # int |  (optional)
     max_number_of_shots = 56 # int |  (optional)
     enabled = True # bool |  (optional)
+    identifier = 'identifier_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)
@@ -140,7 +141,7 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
     try:
         # List backend types
-        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, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, sort_by=sort_by, latest=latest, page=page, size=size)
+        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, supports_raw_data=supports_raw_data, nqubits=nqubits, status=status, default_number_of_shots=default_number_of_shots, max_number_of_shots=max_number_of_shots, enabled=enabled, identifier=identifier, 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:
@@ -165,6 +166,7 @@ Name | Type | Description  | Notes
  **default_number_of_shots** | **int**|  | [optional] 
  **max_number_of_shots** | **int**|  | [optional] 
  **enabled** | **bool**|  | [optional] 
+ **identifier** | **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.51.0 → qi_compute_api_client-0.52.0}/compute_api_client/models/backend_type.py

@@ -48,7 +48,8 @@ class BackendType(BaseModel):
     default_number_of_shots: StrictInt
     max_number_of_shots: StrictInt
     enabled: StrictBool
-    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled"]
+    identifier: Annotated[str, Field(strict=True, max_length=32)]
+    __properties: ClassVar[List[str]] = ["id", "name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "status", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier"]
 
     model_config = {
         "populate_by_name": True,
@@ -113,7 +114,8 @@ class BackendType(BaseModel):
             "status": obj.get("status"),
             "default_number_of_shots": obj.get("default_number_of_shots"),
             "max_number_of_shots": obj.get("max_number_of_shots"),
-            "enabled": obj.get("enabled")
+            "enabled": obj.get("enabled"),
+            "identifier": obj.get("identifier")
         })
         return _obj
 

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/compute_api_client/models/backend_type_patch.py

@@ -45,7 +45,8 @@ class BackendTypePatch(BaseModel):
     default_number_of_shots: Optional[StrictInt] = None
     max_number_of_shots: Optional[StrictInt] = None
     enabled: Optional[StrictBool] = None
-    __properties: ClassVar[List[str]] = ["name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "default_number_of_shots", "max_number_of_shots", "enabled"]
+    identifier: Optional[Annotated[str, Field(strict=True, max_length=32)]] = None
+    __properties: ClassVar[List[str]] = ["name", "infrastructure", "description", "image_id", "is_hardware", "supports_raw_data", "features", "default_compiler_config", "gateset", "topology", "nqubits", "default_number_of_shots", "max_number_of_shots", "enabled", "identifier"]
 
     model_config = {
         "populate_by_name": True,
@@ -153,6 +154,11 @@ class BackendTypePatch(BaseModel):
         if self.enabled is None and "enabled" in self.model_fields_set:
             _dict['enabled'] = None
 
+        # set to None if identifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.identifier is None and "identifier" in self.model_fields_set:
+            _dict['identifier'] = None
+
         return _dict
 
     @classmethod
@@ -178,7 +184,8 @@ class BackendTypePatch(BaseModel):
             "nqubits": obj.get("nqubits"),
             "default_number_of_shots": obj.get("default_number_of_shots"),
             "max_number_of_shots": obj.get("max_number_of_shots"),
-            "enabled": obj.get("enabled")
+            "enabled": obj.get("enabled"),
+            "identifier": obj.get("identifier")
         })
         return _obj
 

{qi_compute_api_client-0.51.0 → qi_compute_api_client-0.52.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qi-compute-api-client"
-version = "0.51.0"
+version = "0.52.0"
 description = "An API client for the Compute Job Manager of Quantum Inspire."
 authors = [{ name = "Quantum Inspire", email = "support@quantum-inspire.eu" }]
 requires-python = "~=3.9"