cosmotech-api 3.1.0.dev0__py3-none-any.whl → 3.1.13__py3-none-any.whl

cosmotech_api/models/runner_validation_status.py

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 4.0.1-SNAPSHOT
+    Contact: platform@cosmotech.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RunnerValidationStatus(str, Enum):
+    """
+    the validation status of the runner
+    """
+
+    """
+    allowed enum values
+    """
+    DRAFT = 'Draft'
+    REJECTED = 'Rejected'
+    UNKNOWN = 'Unknown'
+    VALIDATED = 'Validated'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RunnerValidationStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/scenario.py

@@ -0,0 +1,186 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.3.1
+    Contact: platform@cosmotech.com
+    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 pydantic import BaseModel, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.scenario_job_state import ScenarioJobState
+from cosmotech_api.models.scenario_last_run import ScenarioLastRun
+from cosmotech_api.models.scenario_resource_sizing import ScenarioResourceSizing
+from cosmotech_api.models.scenario_run_template_parameter_value import ScenarioRunTemplateParameterValue
+from cosmotech_api.models.scenario_security import ScenarioSecurity
+from cosmotech_api.models.scenario_validation_status import ScenarioValidationStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Scenario(BaseModel):
+    """
+    a Scenario with base information
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="the Scenario unique identifier")
+    name: Optional[StrictStr] = Field(default=None, description="the Scenario name")
+    description: Optional[StrictStr] = Field(default=None, description="the Scenario description")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="the list of tags")
+    parent_id: Optional[StrictStr] = Field(default=None, description="the Scenario parent id", alias="parentId")
+    owner_id: Optional[StrictStr] = Field(default=None, description="the user id which own this Scenario", alias="ownerId")
+    root_id: Optional[StrictStr] = Field(default=None, description="the scenario root id", alias="rootId")
+    solution_id: Optional[StrictStr] = Field(default=None, description="the Solution Id associated with this Scenario", alias="solutionId")
+    run_template_id: Optional[StrictStr] = Field(default=None, description="the Solution Run Template Id associated with this Scenario", alias="runTemplateId")
+    organization_id: Optional[StrictStr] = Field(default=None, description="the associated Organization Id", alias="organizationId")
+    workspace_id: Optional[StrictStr] = Field(default=None, description="the associated Workspace Id", alias="workspaceId")
+    state: Optional[ScenarioJobState] = None
+    creation_date: Optional[StrictInt] = Field(default=None, description="the Scenario creation date", alias="creationDate")
+    last_update: Optional[StrictInt] = Field(default=None, description="the last time a Scenario was updated", alias="lastUpdate")
+    owner_name: Optional[StrictStr] = Field(default=None, description="the name of the owner", alias="ownerName")
+    solution_name: Optional[StrictStr] = Field(default=None, description="the Solution name", alias="solutionName")
+    run_template_name: Optional[StrictStr] = Field(default=None, description="the Solution Run Template name associated with this Scenario", alias="runTemplateName")
+    dataset_list: Optional[List[StrictStr]] = Field(default=None, description="the list of Dataset Id associated to this Scenario Run Template", alias="datasetList")
+    run_sizing: Optional[ScenarioResourceSizing] = Field(default=None, alias="runSizing")
+    parameters_values: Optional[List[ScenarioRunTemplateParameterValue]] = Field(default=None, description="the list of Solution Run Template parameters values", alias="parametersValues")
+    last_run: Optional[ScenarioLastRun] = Field(default=None, alias="lastRun")
+    parent_last_run: Optional[ScenarioLastRun] = Field(default=None, alias="parentLastRun")
+    root_last_run: Optional[ScenarioLastRun] = Field(default=None, alias="rootLastRun")
+    validation_status: Optional[ScenarioValidationStatus] = Field(default=None, alias="validationStatus")
+    security: Optional[ScenarioSecurity] = None
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "tags", "parentId", "ownerId", "rootId", "solutionId", "runTemplateId", "organizationId", "workspaceId", "state", "creationDate", "lastUpdate", "ownerName", "solutionName", "runTemplateName", "datasetList", "runSizing", "parametersValues", "lastRun", "parentLastRun", "rootLastRun", "validationStatus", "security"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    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) -> Optional[Self]:
+        """Create an instance of Scenario 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "id",
+            "owner_id",
+            "root_id",
+            "solution_id",
+            "organization_id",
+            "workspace_id",
+            "creation_date",
+            "last_update",
+            "owner_name",
+            "solution_name",
+            "run_template_name",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of run_sizing
+        if self.run_sizing:
+            _dict['runSizing'] = self.run_sizing.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in parameters_values (list)
+        _items = []
+        if self.parameters_values:
+            for _item in self.parameters_values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['parametersValues'] = _items
+        # override the default output from pydantic by calling `to_dict()` of last_run
+        if self.last_run:
+            _dict['lastRun'] = self.last_run.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of parent_last_run
+        if self.parent_last_run:
+            _dict['parentLastRun'] = self.parent_last_run.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of root_last_run
+        if self.root_last_run:
+            _dict['rootLastRun'] = self.root_last_run.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of security
+        if self.security:
+            _dict['security'] = self.security.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Scenario from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "parentId": obj.get("parentId"),
+            "ownerId": obj.get("ownerId"),
+            "rootId": obj.get("rootId"),
+            "solutionId": obj.get("solutionId"),
+            "runTemplateId": obj.get("runTemplateId"),
+            "organizationId": obj.get("organizationId"),
+            "workspaceId": obj.get("workspaceId"),
+            "state": obj.get("state"),
+            "creationDate": obj.get("creationDate"),
+            "lastUpdate": obj.get("lastUpdate"),
+            "ownerName": obj.get("ownerName"),
+            "solutionName": obj.get("solutionName"),
+            "runTemplateName": obj.get("runTemplateName"),
+            "datasetList": obj.get("datasetList"),
+            "runSizing": ScenarioResourceSizing.from_dict(obj["runSizing"]) if obj.get("runSizing") is not None else None,
+            "parametersValues": [ScenarioRunTemplateParameterValue.from_dict(_item) for _item in obj["parametersValues"]] if obj.get("parametersValues") is not None else None,
+            "lastRun": ScenarioLastRun.from_dict(obj["lastRun"]) if obj.get("lastRun") is not None else None,
+            "parentLastRun": ScenarioLastRun.from_dict(obj["parentLastRun"]) if obj.get("parentLastRun") is not None else None,
+            "rootLastRun": ScenarioLastRun.from_dict(obj["rootLastRun"]) if obj.get("rootLastRun") is not None else None,
+            "validationStatus": obj.get("validationStatus"),
+            "security": ScenarioSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_access_control.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.3.1
+    Contact: platform@cosmotech.com
+    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 pydantic import BaseModel, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioAccessControl(BaseModel):
+    """
+    a Scenario access control item
+    """ # noqa: E501
+    id: StrictStr = Field(description="the identity id")
+    role: StrictStr = Field(description="a role")
+    __properties: ClassVar[List[str]] = ["id", "role"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    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) -> Optional[Self]:
+        """Create an instance of ScenarioAccessControl 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.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioAccessControl from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "role": obj.get("role")
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_changed_parameter_value.py

@@ -0,0 +1,102 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.3.1
+    Contact: platform@cosmotech.com
+    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 pydantic import BaseModel, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioChangedParameterValue(BaseModel):
+    """
+    the difference between the values of a parameter
+    """ # noqa: E501
+    parameter_id: Optional[StrictStr] = Field(default=None, description="the parameter id the values refer to", alias="parameterId")
+    var_type: Optional[StrictStr] = Field(default=None, description="the parameter value type", alias="varType")
+    value: Optional[StrictStr] = Field(default=None, description="the parameter value for the reference Scenario")
+    compared_value: Optional[StrictStr] = Field(default=None, description="the parameter value for the compared Scenario", alias="comparedValue")
+    __properties: ClassVar[List[str]] = ["parameterId", "varType", "value", "comparedValue"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    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) -> Optional[Self]:
+        """Create an instance of ScenarioChangedParameterValue 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "parameter_id",
+            "var_type",
+            "value",
+            "compared_value",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioChangedParameterValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameterId": obj.get("parameterId"),
+            "varType": obj.get("varType"),
+            "value": obj.get("value"),
+            "comparedValue": obj.get("comparedValue")
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_comparison_result.py

@@ -0,0 +1,106 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.3.1
+    Contact: platform@cosmotech.com
+    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 pydantic import BaseModel, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.scenario_changed_parameter_value import ScenarioChangedParameterValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioComparisonResult(BaseModel):
+    """
+    the result of the comparison of two scenarios
+    """ # noqa: E501
+    scenario_id: Optional[StrictStr] = Field(default=None, description="the Scenario Id which is the reference for the comparison", alias="scenarioId")
+    compared_scenario_id: Optional[StrictStr] = Field(default=None, description="the Scenario Id the reference Scenario is compared to", alias="comparedScenarioId")
+    changed_values: Optional[List[ScenarioChangedParameterValue]] = Field(default=None, description="the list of changed values for parameters", alias="changedValues")
+    __properties: ClassVar[List[str]] = ["scenarioId", "comparedScenarioId", "changedValues"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    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) -> Optional[Self]:
+        """Create an instance of ScenarioComparisonResult 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "scenario_id",
+            "compared_scenario_id",
+            "changed_values",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in changed_values (list)
+        _items = []
+        if self.changed_values:
+            for _item in self.changed_values:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['changedValues'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioComparisonResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "scenarioId": obj.get("scenarioId"),
+            "comparedScenarioId": obj.get("comparedScenarioId"),
+            "changedValues": [ScenarioChangedParameterValue.from_dict(_item) for _item in obj["changedValues"]] if obj.get("changedValues") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/scenario_data_download_info.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 3.3.1
+    Contact: platform@cosmotech.com
+    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 pydantic import BaseModel, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from cosmotech_api.models.scenario_job_state import ScenarioJobState
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScenarioDataDownloadInfo(BaseModel):
+    """
+    Scenario data download job info
+    """ # noqa: E501
+    url: Optional[StrictStr] = Field(default=None, description="the Scenario Data Download URL")
+    state: Optional[ScenarioJobState] = None
+    __properties: ClassVar[List[str]] = ["url", "state"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+
+    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) -> Optional[Self]:
+        """Create an instance of ScenarioDataDownloadInfo 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "url",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScenarioDataDownloadInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "url": obj.get("url"),
+            "state": obj.get("state")
+        })
+        return _obj
+
+