cosmotech-api 3.2.0.post1__py3-none-any.whl → 5.0.0rc3__py3-none-any.whl

cosmotech_api/models/dataset_create_request.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-rc3
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.dataset_part_create_request import DatasetPartCreateRequest
+from cosmotech_api.models.dataset_security import DatasetSecurity
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetCreateRequest(BaseModel):
+    """
+    Dataset creation request
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True)]
+    description: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    additional_data: Optional[Dict[str, Any]] = Field(default=None, description="Free form additional data", alias="additionalData")
+    parts: Optional[List[DatasetPartCreateRequest]] = None
+    security: Optional[DatasetSecurity] = None
+    __properties: ClassVar[List[str]] = ["name", "description", "tags", "additionalData", "parts", "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 DatasetCreateRequest 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 each item in parts (list)
+        _items = []
+        if self.parts:
+            for _item_parts in self.parts:
+                if _item_parts:
+                    _items.append(_item_parts.to_dict())
+            _dict['parts'] = _items
+        # 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 DatasetCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "additionalData": obj.get("additionalData"),
+            "parts": [DatasetPartCreateRequest.from_dict(_item) for _item in obj["parts"]] if obj.get("parts") is not None else None,
+            "security": DatasetSecurity.from_dict(obj["security"]) if obj.get("security") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/dataset_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-rc3
+    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 DatasetEditInfo(BaseModel):
+    """
+    DatasetEditInfo
+    """ # 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 DatasetEditInfo 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 DatasetEditInfo 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/dataset_part.py

@@ -0,0 +1,132 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-rc3
+    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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.dataset_edit_info import DatasetEditInfo
+from cosmotech_api.models.dataset_part_type_enum import DatasetPartTypeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetPart(BaseModel):
+    """
+    Dataset part object
+    """ # noqa: E501
+    id: Annotated[str, Field(strict=True)]
+    name: Annotated[str, Field(min_length=1, strict=True)]
+    source_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="the source data name (e.g. filename associated to the dataset part)", alias="sourceName")
+    description: Optional[StrictStr] = None
+    tags: List[StrictStr]
+    additional_data: Optional[Dict[str, Any]] = Field(default=None, description="Free form additional data", alias="additionalData")
+    type: DatasetPartTypeEnum
+    organization_id: StrictStr = Field(description="the associated Organization Id", alias="organizationId")
+    workspace_id: StrictStr = Field(description="the associated Workspace Id", alias="workspaceId")
+    dataset_id: StrictStr = Field(description="the associated Dataset Id", alias="datasetId")
+    create_info: DatasetEditInfo = Field(description="The details of the Dataset creation", alias="createInfo")
+    update_info: DatasetEditInfo = Field(description="The details of the Dataset last update", alias="updateInfo")
+    __properties: ClassVar[List[str]] = ["id", "name", "sourceName", "description", "tags", "additionalData", "type", "organizationId", "workspaceId", "datasetId", "createInfo", "updateInfo"]
+
+    @field_validator('id')
+    def id_validate_regular_expression(cls, value):
+        """Validates the regular expression"""
+        if not re.match(r"^dp-\w{10,20}", value):
+            raise ValueError(r"must validate the regular expression /^dp-\w{10,20}/")
+        return value
+
+    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 DatasetPart 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([
+            "organization_id",
+            "workspace_id",
+            "dataset_id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            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()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetPart 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"),
+            "sourceName": obj.get("sourceName"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "additionalData": obj.get("additionalData"),
+            "type": obj.get("type") if obj.get("type") is not None else DatasetPartTypeEnum.FILE,
+            "organizationId": obj.get("organizationId"),
+            "workspaceId": obj.get("workspaceId"),
+            "datasetId": obj.get("datasetId"),
+            "createInfo": DatasetEditInfo.from_dict(obj["createInfo"]) if obj.get("createInfo") is not None else None,
+            "updateInfo": DatasetEditInfo.from_dict(obj["updateInfo"]) if obj.get("updateInfo") is not None else None
+        })
+        return _obj
+
+

cosmotech_api/models/dataset_part_create_request.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-rc3
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from cosmotech_api.models.dataset_part_type_enum import DatasetPartTypeEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetPartCreateRequest(BaseModel):
+    """
+    Dataset part create request object
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True)]
+    source_name: Annotated[str, Field(min_length=1, strict=True)] = Field(description="the source data name (e.g. filename associated to the dataset part)", alias="sourceName")
+    description: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    additional_data: Optional[Dict[str, Any]] = Field(default=None, description="Free form additional data", alias="additionalData")
+    type: Optional[DatasetPartTypeEnum] = DatasetPartTypeEnum.FILE
+    __properties: ClassVar[List[str]] = ["name", "sourceName", "description", "tags", "additionalData", "type"]
+
+    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 DatasetPartCreateRequest 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 DatasetPartCreateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "sourceName": obj.get("sourceName"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "additionalData": obj.get("additionalData"),
+            "type": obj.get("type") if obj.get("type") is not None else DatasetPartTypeEnum.FILE
+        })
+        return _obj
+
+

cosmotech_api/models/dataset_part_type_enum.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-rc3
+    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 DatasetPartTypeEnum(str, Enum):
+    """
+    The dataset part Type
+    """
+
+    """
+    allowed enum values
+    """
+    FILE = 'File'
+    DB = 'DB'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DatasetPartTypeEnum from a JSON string"""
+        return cls(json.loads(json_str))
+
+

cosmotech_api/models/dataset_part_update_request.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Cosmo Tech Platform API
+
+    Cosmo Tech Platform API
+
+    The version of the OpenAPI document: 5.0.0-rc3
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetPartUpdateRequest(BaseModel):
+    """
+    Dataset part update request object
+    """ # noqa: E501
+    source_name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = Field(default=None, description="the source data name (e.g. filename associated to the dataset part)", alias="sourceName")
+    description: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    additional_data: Optional[Dict[str, Any]] = Field(default=None, description="Free form additional data", alias="additionalData")
+    __properties: ClassVar[List[str]] = ["sourceName", "description", "tags", "additionalData"]
+
+    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 DatasetPartUpdateRequest 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 DatasetPartUpdateRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceName": obj.get("sourceName"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "additionalData": obj.get("additionalData")
+        })
+        return _obj
+
+

cosmotech_api/models/dataset_role.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 3.2.0
+    The version of the OpenAPI document: 5.0.0-rc3
     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
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,11 +30,11 @@ class DatasetRole(BaseModel):
     role: StrictStr = Field(description="the Dataset Role")
     __properties: ClassVar[List[str]] = ["role"]
 
-    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/dataset_search.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 3.2.0
+    The version of the OpenAPI document: 3.3.6
     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
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,11 +30,11 @@ class DatasetSearch(BaseModel):
     dataset_tags: List[StrictStr] = Field(description="the dataset tag list to search", alias="datasetTags")
     __properties: ClassVar[List[str]] = ["datasetTags"]
 
-    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/dataset_security.py

@@ -5,7 +5,7 @@
 
     Cosmo Tech Platform API
 
-    The version of the OpenAPI document: 3.2.0
+    The version of the OpenAPI document: 5.0.0-rc3
     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
 from cosmotech_api.models.dataset_access_control import DatasetAccessControl
 from typing import Optional, Set
@@ -32,11 +32,11 @@ class DatasetSecurity(BaseModel):
     access_control_list: List[DatasetAccessControl] = Field(description="the list which can access this Dataset with detailed access control information", alias="accessControlList")
     __properties: ClassVar[List[str]] = ["default", "accessControlList"]
 
-    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:
@@ -74,9 +74,9 @@ class DatasetSecurity(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of each item in access_control_list (list)
         _items = []
         if self.access_control_list:
-            for _item in self.access_control_list:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_access_control_list in self.access_control_list:
+                if _item_access_control_list:
+                    _items.append(_item_access_control_list.to_dict())
             _dict['accessControlList'] = _items
         return _dict