qi-compute-api-client 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

compute_api_client/models/reservation.py

@@ -18,30 +18,29 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictBool, StrictInt
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Reservation(BaseModel):
     """
     Reservation
     """ # noqa: E501
-    id: StrictInt
-    member_id: StrictInt
-    start_time: datetime
-    end_time: datetime
-    backend_type_id: StrictInt
+    id: StrictInt = Field(description="The id of the reservation")
+    member_id: StrictInt = Field(description="The id of the member who made the reservation")
+    start_time: datetime = Field(description="Starting time of lthe reservation")
+    end_time: datetime = Field(description="End time of the reservation")
+    backend_type_id: StrictInt = Field(description="The id of the backend_type")
     backend_id: Optional[StrictInt]
-    is_terminated: StrictBool
+    is_terminated: StrictBool = Field(description="If the reservation has been terminated")
     __properties: ClassVar[List[str]] = ["id", "member_id", "start_time", "end_time", "backend_type_id", "backend_id", "is_terminated"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -54,7 +53,7 @@ class Reservation(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of Reservation from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -68,10 +67,12 @@ class Reservation(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if backend_id (nullable) is None
@@ -82,7 +83,7 @@ class Reservation(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of Reservation from a dict"""
         if obj is None:
             return None

compute_api_client/models/reservation_in.py

@@ -18,27 +18,26 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictInt
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class ReservationIn(BaseModel):
     """
     ReservationIn
     """ # noqa: E501
-    member_id: StrictInt
-    start_time: datetime
-    end_time: datetime
-    backend_type_id: StrictInt
+    member_id: StrictInt = Field(description="The id of the member who made the reservation")
+    start_time: datetime = Field(description="Starting time of lthe reservation")
+    end_time: datetime = Field(description="End time of the reservation")
+    backend_type_id: StrictInt = Field(description="The id of the backend_type")
     __properties: ClassVar[List[str]] = ["member_id", "start_time", "end_time", "backend_type_id"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -51,7 +50,7 @@ class ReservationIn(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of ReservationIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -65,16 +64,18 @@ class ReservationIn(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of ReservationIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/result.py

@@ -18,31 +18,30 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from pydantic import BaseModel, StrictFloat, StrictInt, StrictStr
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Result(BaseModel):
     """
     Result
     """ # noqa: E501
-    id: StrictInt
-    created_on: datetime
-    job_id: StrictInt
-    execution_time_in_seconds: Union[StrictFloat, StrictInt]
+    id: StrictInt = Field(description="The ID of the result")
+    created_on: datetime = Field(description="Time of creation of the result")
+    job_id: StrictInt = Field(description="The ID of the job")
+    execution_time_in_seconds: Union[StrictFloat, StrictInt] = Field(description="Time it took to compute the result")
     shots_requested: Optional[StrictInt]
     shots_done: Optional[StrictInt]
     results: Optional[Dict[str, Any]]
     raw_data: Optional[List[StrictStr]]
     __properties: ClassVar[List[str]] = ["id", "created_on", "job_id", "execution_time_in_seconds", "shots_requested", "shots_done", "results", "raw_data"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -55,7 +54,7 @@ class Result(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of Result from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -69,10 +68,12 @@ class Result(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if shots_requested (nullable) is None
@@ -98,7 +99,7 @@ class Result(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of Result from a dict"""
         if obj is None:
             return None

compute_api_client/models/result_in.py

@@ -17,30 +17,28 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
-from pydantic import BaseModel, StrictFloat, StrictInt, StrictStr
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class ResultIn(BaseModel):
     """
     ResultIn
     """ # noqa: E501
-    job_id: StrictInt
-    execution_time_in_seconds: Union[StrictFloat, StrictInt]
+    job_id: StrictInt = Field(description="The ID of the result")
+    execution_time_in_seconds: Union[StrictFloat, StrictInt] = Field(description="Time it took to compute the result")
     shots_requested: Optional[StrictInt] = None
     shots_done: Optional[StrictInt] = None
     results: Optional[Dict[str, Any]] = None
     raw_data: Optional[List[StrictStr]] = None
     __properties: ClassVar[List[str]] = ["job_id", "execution_time_in_seconds", "shots_requested", "shots_done", "results", "raw_data"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -53,7 +51,7 @@ class ResultIn(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of ResultIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -67,10 +65,12 @@ class ResultIn(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if shots_requested (nullable) is None
@@ -96,7 +96,7 @@ class ResultIn(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of ResultIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/role.py

@@ -14,16 +14,8 @@
 
 from __future__ import annotations
 import json
-import pprint
-import re  # noqa: F401
 from enum import Enum
-
-
-
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing_extensions import Self
 
 
 class Role(str, Enum):

compute_api_client/models/share_type.py

@@ -14,16 +14,8 @@
 
 from __future__ import annotations
 import json
-import pprint
-import re  # noqa: F401
 from enum import Enum
-
-
-
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing_extensions import Self
 
 
 class ShareType(str, Enum):

compute_api_client/models/team.py

@@ -17,30 +17,27 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictBool, StrictInt
-from pydantic import Field
 from typing_extensions import Annotated
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Team(BaseModel):
     """
     Team
     """ # noqa: E501
-    id: StrictInt
-    name: Annotated[str, Field(strict=True, max_length=64)]
-    slug: Annotated[str, Field(strict=True, max_length=64)]
-    individual_user: StrictBool
+    id: StrictInt = Field(description="The id of the team")
+    name: Annotated[str, Field(strict=True, max_length=64)] = Field(description="The name of the team")
+    slug: Annotated[str, Field(strict=True, max_length=64)] = Field(description="The slugified name")
+    individual_user: StrictBool = Field(description="If it is an individual user")
     __properties: ClassVar[List[str]] = ["id", "name", "slug", "individual_user"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -53,7 +50,7 @@ class Team(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of Team from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -67,16 +64,18 @@ class Team(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of Team from a dict"""
         if obj is None:
             return None

compute_api_client/models/transaction.py

@@ -18,33 +18,31 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictInt
-from pydantic import Field
 from typing_extensions import Annotated
 from compute_api_client.models.domain import Domain
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class Transaction(BaseModel):
     """
     Transaction
     """ # noqa: E501
-    id: StrictInt
+    id: StrictInt = Field(description="The id of the transaction")
     domain: Optional[Domain]
     job: Optional[StrictInt]
-    team_id: StrictInt
+    team_id: StrictInt = Field(description="The id of the team who initiated the transaction")
     member_id: Optional[StrictInt]
     change: Annotated[int, Field(strict=True, ge=-32768)]
-    timestamp: datetime
+    timestamp: datetime = Field(description="Time when the transaction was started")
     __properties: ClassVar[List[str]] = ["id", "domain", "job", "team_id", "member_id", "change", "timestamp"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -57,7 +55,7 @@ class Transaction(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of Transaction from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -71,10 +69,12 @@ class Transaction(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # set to None if domain (nullable) is None
@@ -95,7 +95,7 @@ class Transaction(BaseModel):
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of Transaction from a dict"""
         if obj is None:
             return None

compute_api_client/models/transaction_domain.py

@@ -0,0 +1,142 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    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)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+
+from typing import Any, Optional
+from pydantic import BaseModel, Field, StrictStr, ValidationError, field_validator
+from compute_api_client.models.domain import Domain
+from typing import Union, Any, List, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal
+from pydantic import StrictStr, Field
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+TRANSACTIONDOMAIN_ANY_OF_SCHEMAS = ["Domain", "object"]
+
+class TransactionDomain(BaseModel):
+    """
+    The domain type of the transaction
+    """
+
+    # data type: Domain
+    anyof_schema_1_validator: Optional[Domain] = None
+    # data type: object
+    anyof_schema_2_validator: Optional[Any] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[Domain, object]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: List[str] = Literal[TRANSACTIONDOMAIN_ANY_OF_SCHEMAS]
+
+    model_config = {
+        "validate_assignment": True
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = TransactionDomain.model_construct()
+        error_messages = []
+        # validate data type: Domain
+        if not isinstance(v, Domain):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `Domain`")
+        else:
+            return v
+
+        # validate data type: object
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in TransactionDomain with anyOf schemas: Domain, object. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[Domain] = None
+        try:
+            instance.actual_instance = Domain.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # deserialize data into object
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into TransactionDomain with anyOf schemas: Domain, object. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        to_json = getattr(self.actual_instance, "to_json", None)
+        if callable(to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Dict:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        to_json = getattr(self.actual_instance, "to_json", None)
+        if callable(to_json):
+            return self.actual_instance.to_dict()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+