cosmotech-api 4.0.0.dev8__py3-none-any.whl → 5.0.0b3__py3-none-any.whl

cosmotech_api/models/workspace.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,8 +18,10 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.workspace_edit_info import WorkspaceEditInfo
 from cosmotech_api.models.workspace_security import WorkspaceSecurity
 from cosmotech_api.models.workspace_solution import WorkspaceSolution
 from cosmotech_api.models.workspace_web_app import WorkspaceWebApp
@@ -28,28 +30,36 @@ from typing_extensions import Self
 
 class Workspace(BaseModel):
     """
-    a Workspace
+    A Workspace
     """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="Workspace unique identifier generated by the API")
-    organization_id: Optional[StrictStr] = Field(default=None, description="Organization unique identifier under which the workspace resides", alias="organizationId")
-    key: StrictStr = Field(description="technical key for resource name convention and version grouping. Must be unique")
-    name: StrictStr = Field(description="Workspace name. This name is display in the sample webApp")
-    description: Optional[StrictStr] = Field(default=None, description="the Workspace description")
-    linked_dataset_id_list: Optional[List[StrictStr]] = Field(default=None, description="list of dataset linked to this dataset", alias="linkedDatasetIdList")
-    version: Optional[StrictStr] = Field(default=None, description="the Workspace version MAJOR.MINOR.PATCH.")
-    tags: Optional[List[StrictStr]] = Field(default=None, description="the list of tags")
-    owner_id: Optional[StrictStr] = Field(default=None, description="the user id which own this workspace. set by the API from Authentification service receved id", alias="ownerId")
+    id: Annotated[str, Field(strict=True)] = Field(description="Workspace unique identifier generated by the API")
+    organization_id: Annotated[str, Field(strict=True)] = Field(description="Organization unique identifier under which the workspace resides", alias="organizationId")
+    key: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="Technical key for resource name convention and version grouping. Must be unique")
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="Workspace name. This name is display in the sample webApp")
+    description: Optional[StrictStr] = Field(default=None, description="The Workspace description")
+    version: Optional[StrictStr] = Field(default=None, description="The Workspace version MAJOR.MINOR.PATCH.")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="The list of tags")
+    create_info: WorkspaceEditInfo = Field(description="The details of the Workspace creation", alias="createInfo")
+    update_info: WorkspaceEditInfo = Field(description="The details of the Workspace last update", alias="updateInfo")
     solution: WorkspaceSolution
     web_app: Optional[WorkspaceWebApp] = Field(default=None, alias="webApp")
-    send_input_to_data_warehouse: Optional[StrictBool] = Field(default=None, description="default setting for all Scenarios and Run Templates to set whether or not the Dataset values and the input parameters values are send to the DataWarehouse prior to the ScenarioRun", alias="sendInputToDataWarehouse")
-    use_dedicated_event_hub_namespace: Optional[StrictBool] = Field(default=False, description="Set this property to true to use a dedicated Azure Event Hub Namespace for this Workspace. The Event Hub Namespace must be named \\'<organization_id\\>-<workspace_id\\>\\' (in lower case). This Namespace must also contain two Event Hubs named \\'probesmeasures\\' and \\'scenariorun\\'.", alias="useDedicatedEventHubNamespace")
-    dedicated_event_hub_sas_key_name: Optional[StrictStr] = Field(default=None, description="the Dedicated Event Hub SAS key name, default to RootManageSharedAccessKey. Ask you DevOps Team to add the associated value to your Workspace Secret", alias="dedicatedEventHubSasKeyName")
-    dedicated_event_hub_authentication_strategy: Optional[StrictStr] = Field(default=None, description="the Event Hub authentication strategy, SHARED_ACCESS_POLICY or TENANT_CLIENT_CREDENTIALS. Default to the one defined for the tenant.", alias="dedicatedEventHubAuthenticationStrategy")
-    send_scenario_run_to_event_hub: Optional[StrictBool] = Field(default=True, description="default setting for all Scenarios and Run Templates to set whether or not the ScenarioRun is send to the Event Hub", alias="sendScenarioRunToEventHub")
-    send_scenario_metadata_to_event_hub: Optional[StrictBool] = Field(default=False, description="Set this property to false to not send scenario metada to Azure Event Hub Namespace for this Workspace. The Event Hub Namespace must be named \\'<organization_id\\>-<workspace_id\\>\\' (in lower case). This Namespace must also contain two Event Hubs named \\'scenariometadata\\' and \\'scenariorunmetadata\\'.", alias="sendScenarioMetadataToEventHub")
     dataset_copy: Optional[StrictBool] = Field(default=True, description="Activate the copy of dataset on scenario creation, meaning that each scenario created in this workspace will make this copy. when false, scenario use directly the dataset specified.", alias="datasetCopy")
-    security: Optional[WorkspaceSecurity] = None
-    __properties: ClassVar[List[str]] = ["id", "organizationId", "key", "name", "description", "linkedDatasetIdList", "version", "tags", "ownerId", "solution", "webApp", "sendInputToDataWarehouse", "useDedicatedEventHubNamespace", "dedicatedEventHubSasKeyName", "dedicatedEventHubAuthenticationStrategy", "sendScenarioRunToEventHub", "sendScenarioMetadataToEventHub", "datasetCopy", "security"]
+    security: WorkspaceSecurity
+    __properties: ClassVar[List[str]] = ["id", "organizationId", "key", "name", "description", "version", "tags", "createInfo", "updateInfo", "solution", "webApp", "datasetCopy", "security"]
+
+    @field_validator('id')
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^w-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^w-\w{10,20}/")
+        return value
+
+    @field_validator('organization_id')
+    def organization_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^o-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^o-\w{10,20}/")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,12 +93,10 @@ class Workspace(BaseModel):
           are ignored.
         * OpenAPI `readOnly` fields are excluded.
         * OpenAPI `readOnly` fields are excluded.
-        * OpenAPI `readOnly` fields are excluded.
         """
         excluded_fields: Set[str] = set([
             "id",
             "organization_id",
-            "owner_id",
         ])
 
         _dict = self.model_dump(
@@ -96,6 +104,12 @@ class Workspace(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of create_info
+        if self.create_info:
+            _dict['createInfo'] = self.create_info.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of update_info
+        if self.update_info:
+            _dict['updateInfo'] = self.update_info.to_dict()
         # override the default output from pydantic by calling `to_dict()` of solution
         if self.solution:
             _dict['solution'] = self.solution.to_dict()
@@ -122,18 +136,12 @@ class Workspace(BaseModel):
             "key": obj.get("key"),
             "name": obj.get("name"),
             "description": obj.get("description"),
-            "linkedDatasetIdList": obj.get("linkedDatasetIdList"),
             "version": obj.get("version"),
             "tags": obj.get("tags"),
-            "ownerId": obj.get("ownerId"),
+            "createInfo": WorkspaceEditInfo.from_dict(obj["createInfo"]) if obj.get("createInfo") is not None else None,
+            "updateInfo": WorkspaceEditInfo.from_dict(obj["updateInfo"]) if obj.get("updateInfo") is not None else None,
             "solution": WorkspaceSolution.from_dict(obj["solution"]) if obj.get("solution") is not None else None,
             "webApp": WorkspaceWebApp.from_dict(obj["webApp"]) if obj.get("webApp") is not None else None,
-            "sendInputToDataWarehouse": obj.get("sendInputToDataWarehouse"),
-            "useDedicatedEventHubNamespace": obj.get("useDedicatedEventHubNamespace") if obj.get("useDedicatedEventHubNamespace") is not None else False,
-            "dedicatedEventHubSasKeyName": obj.get("dedicatedEventHubSasKeyName"),
-            "dedicatedEventHubAuthenticationStrategy": obj.get("dedicatedEventHubAuthenticationStrategy"),
-            "sendScenarioRunToEventHub": obj.get("sendScenarioRunToEventHub") if obj.get("sendScenarioRunToEventHub") is not None else True,
-            "sendScenarioMetadataToEventHub": obj.get("sendScenarioMetadataToEventHub") if obj.get("sendScenarioMetadataToEventHub") is not None else False,
             "datasetCopy": obj.get("datasetCopy") if obj.get("datasetCopy") is not None else True,
             "security": WorkspaceSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None
         })

cosmotech_api/models/workspace_access_control.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -25,10 +25,10 @@ from typing_extensions import Self
 
 class WorkspaceAccessControl(BaseModel):
     """
-    a Workspace access control item
+    A Workspace access control item
     """ # noqa: E501
-    id: StrictStr = Field(description="the identity id")
-    role: StrictStr = Field(description="a role")
+    id: StrictStr = Field(description="The identity id")
+    role: StrictStr = Field(description="A role")
     __properties: ClassVar[List[str]] = ["id", "role"]
 
     model_config = ConfigDict(

cosmotech_api/models/workspace_create_request.py

@@ -0,0 +1,117 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-beta3
+    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, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.workspace_security import WorkspaceSecurity
+from cosmotech_api.models.workspace_solution import WorkspaceSolution
+from cosmotech_api.models.workspace_web_app import WorkspaceWebApp
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkspaceCreateRequest(BaseModel):
+    """
+    Request object for creating a new workspace
+    """ # noqa: E501
+    key: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="Technical key for resource name convention and version grouping. Must be unique")
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=50)] = Field(description="Workspace name. This name is displayed in the sample webApp")
+    description: Optional[StrictStr] = Field(default=None, description="The Workspace description")
+    version: Optional[StrictStr] = Field(default=None, description="The Workspace version MAJOR.MINOR.PATCH.")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="The list of tags")
+    solution: WorkspaceSolution
+    web_app: Optional[WorkspaceWebApp] = Field(default=None, alias="webApp")
+    dataset_copy: Optional[StrictBool] = Field(default=True, description="Activate the copy of dataset on scenario creation", alias="datasetCopy")
+    security: Optional[WorkspaceSecurity] = None
+    __properties: ClassVar[List[str]] = ["key", "name", "description", "version", "tags", "solution", "webApp", "datasetCopy", "security"]
+
+    model_config = ConfigDict(
+        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 WorkspaceCreateRequest 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of solution
+        if self.solution:
+            _dict['solution'] = self.solution.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of web_app
+        if self.web_app:
+            _dict['webApp'] = self.web_app.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 WorkspaceCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "version": obj.get("version"),
+            "tags": obj.get("tags"),
+            "solution": WorkspaceSolution.from_dict(obj["solution"]) if obj.get("solution") is not None else None,
+            "webApp": WorkspaceWebApp.from_dict(obj["webApp"]) if obj.get("webApp") is not None else None,
+            "datasetCopy": obj.get("datasetCopy") if obj.get("datasetCopy") is not None else True,
+            "security": WorkspaceSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/workspace_edit_info.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-beta3
+    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, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkspaceEditInfo(BaseModel):
+    """
+    WorkspaceEditInfo
+    """ # noqa: E501
+    timestamp: StrictInt = Field(description="The timestamp of the modification in millisecond")
+    user_id: StrictStr = Field(description="The id of the user who did the modification", alias="userId")
+    __properties: ClassVar[List[str]] = ["timestamp", "userId"]
+
+    model_config = ConfigDict(
+        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 WorkspaceEditInfo 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 WorkspaceEditInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "timestamp": obj.get("timestamp"),
+            "userId": obj.get("userId")
+        })
+        return _obj
+
+

cosmotech_api/models/workspace_file.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -19,15 +19,15 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List
 from typing import Optional, Set
 from typing_extensions import Self
 
 class WorkspaceFile(BaseModel):
     """
-    a Workspace File resource
+    A Workspace File resource
     """ # noqa: E501
-    file_name: Optional[StrictStr] = Field(default=None, description="the Workspace File name", alias="fileName")
+    file_name: StrictStr = Field(description="The Workspace File name", alias="fileName")
     __properties: ClassVar[List[str]] = ["fileName"]
 
     model_config = ConfigDict(

cosmotech_api/models/workspace_role.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -25,9 +25,9 @@ from typing_extensions import Self
 
 class WorkspaceRole(BaseModel):
     """
-    the Workspace Role
+    The Workspace Role
     """ # noqa: E501
-    role: StrictStr = Field(description="the Workspace Role")
+    role: StrictStr = Field(description="The Workspace Role")
     __properties: ClassVar[List[str]] = ["role"]
 
     model_config = ConfigDict(

cosmotech_api/models/workspace_secret.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 3.2.10
+    The version of the OpenAPI document: 3.3.4
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,11 +30,11 @@ class WorkspaceSecret(BaseModel):
     dedicated_event_hub_key: Optional[StrictStr] = Field(default=None, description="the dedicated event hub shared access key", alias="dedicatedEventHubKey")
     __properties: ClassVar[List[str]] = ["dedicatedEventHubKey"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True,
-        "protected_namespaces": (),
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:

cosmotech_api/models/workspace_security.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -26,10 +26,10 @@ from typing_extensions import Self
 
 class WorkspaceSecurity(BaseModel):
     """
-    the workspace security information
+    The workspace security information
     """ # noqa: E501
-    default: StrictStr = Field(description="the role by default")
-    access_control_list: List[WorkspaceAccessControl] = Field(description="the list which can access this Workspace with detailed access control information", alias="accessControlList")
+    default: StrictStr = Field(description="The role by default")
+    access_control_list: List[WorkspaceAccessControl] = Field(description="The list which can access this Workspace with detailed access control information", alias="accessControlList")
     __properties: ClassVar[List[str]] = ["default", "accessControlList"]
 
     model_config = ConfigDict(

cosmotech_api/models/workspace_solution.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,20 +18,28 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
 class WorkspaceSolution(BaseModel):
     """
-    the Workspace Solution configuration
+    The Workspace Solution configuration
     """ # noqa: E501
-    solution_id: Optional[StrictStr] = Field(default=None, description="the Solution Id attached to this workspace", alias="solutionId")
-    run_template_filter: Optional[List[StrictStr]] = Field(default=None, description="the list of Solution Run Template Id to filter", alias="runTemplateFilter")
-    default_run_template_dataset: Optional[Dict[str, Any]] = Field(default=None, description="a map of RunTemplateId/DatasetId to set a default dataset for a Run Template", alias="defaultRunTemplateDataset")
+    solution_id: Annotated[str, Field(strict=True)] = Field(description="The Solution Id attached to this workspace", alias="solutionId")
+    run_template_filter: Optional[List[StrictStr]] = Field(default=None, description="The list of Solution Run Template Id to filter", alias="runTemplateFilter")
+    default_run_template_dataset: Optional[Dict[str, Any]] = Field(default=None, description="A map of RunTemplateId/DatasetId to set a default dataset for a Run Template", alias="defaultRunTemplateDataset")
     __properties: ClassVar[List[str]] = ["solutionId", "runTemplateFilter", "defaultRunTemplateDataset"]
 
+    @field_validator('solution_id')
+    def solution_id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^sol-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^sol-\w{10,20}/")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

cosmotech_api/models/workspace_update_request.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-beta3
+    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, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.workspace_solution import WorkspaceSolution
+from cosmotech_api.models.workspace_web_app import WorkspaceWebApp
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkspaceUpdateRequest(BaseModel):
+    """
+    Request object for updating a workspace
+    """ # noqa: E501
+    key: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="Technical key for resource name convention and version grouping. Must be unique")
+    name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=50)]] = Field(default=None, description="Workspace name")
+    description: Optional[StrictStr] = Field(default=None, description="The Workspace description")
+    tags: Optional[List[StrictStr]] = Field(default=None, description="The list of tags")
+    solution: Optional[WorkspaceSolution] = None
+    web_app: Optional[WorkspaceWebApp] = Field(default=None, alias="webApp")
+    dataset_copy: Optional[StrictBool] = Field(default=None, description="Activate the copy of dataset on scenario creation", alias="datasetCopy")
+    __properties: ClassVar[List[str]] = ["key", "name", "description", "tags", "solution", "webApp", "datasetCopy"]
+
+    model_config = ConfigDict(
+        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 WorkspaceUpdateRequest 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of solution
+        if self.solution:
+            _dict['solution'] = self.solution.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of web_app
+        if self.web_app:
+            _dict['webApp'] = self.web_app.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkspaceUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "solution": WorkspaceSolution.from_dict(obj["solution"]) if obj.get("solution") is not None else None,
+            "webApp": WorkspaceWebApp.from_dict(obj["webApp"]) if obj.get("webApp") is not None else None,
+            "datasetCopy": obj.get("datasetCopy")
+        })
+        return _obj
+
+

cosmotech_api/models/workspace_web_app.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 4.0.0-onprem.8
+    The version of the OpenAPI document: 5.0.0-beta3
     Contact: platform@cosmotech.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -25,10 +25,10 @@ from typing_extensions import Self
 
 class WorkspaceWebApp(BaseModel):
     """
-    a Workspace Web Application
+    A Workspace Web Application
     """ # noqa: E501
-    url: StrictStr = Field(description="the Workspace Web Application URL")
-    iframes: Optional[Dict[str, Any]] = Field(default=None, description="a map of iframeKey/iframeURL")
+    url: StrictStr = Field(description="The Workspace Web Application URL")
+    iframes: Optional[Dict[str, Any]] = Field(default=None, description="A map of iframeKey/iframeURL")
     options: Optional[Dict[str, Any]] = Field(default=None, description="free form options for Web Application")
     __properties: ClassVar[List[str]] = ["url", "iframes", "options"]