visier-platform-sdk 22222222.99200.21494__py3-none-any.whl

visier_platform_sdk/models/concept_definition_dto.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.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 visier_platform_sdk.models.basic_information_dto import BasicInformationDTO
+from visier_platform_sdk.models.concept_type_details_dto import ConceptTypeDetailsDTO
+from visier_platform_sdk.models.version_information_dto import VersionInformationDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConceptDefinitionDTO(BaseModel):
+    """
+    Information about the concept, such as its UUID and concept type.
+    """ # noqa: E501
+    uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the concept.")
+    object_name: Optional[StrictStr] = Field(default=None, description="The object name of the concept.", alias="objectName")
+    basic_information: Optional[BasicInformationDTO] = Field(default=None, description="Fields that identify and describe the concept, such as its display name, description, and explanation.", alias="basicInformation")
+    details: Optional[ConceptTypeDetailsDTO] = Field(default=None, description="The concept type and its details.")
+    version_information: Optional[VersionInformationDTO] = Field(default=None, description="The object's version information. Version information is read-only. It indicates where the object originates from and whether the object has been modified in your tenant.", alias="versionInformation")
+    __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "details", "versionInformation"]
+
+    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 ConceptDefinitionDTO 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 basic_information
+        if self.basic_information:
+            _dict['basicInformation'] = self.basic_information.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of details
+        if self.details:
+            _dict['details'] = self.details.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of version_information
+        if self.version_information:
+            _dict['versionInformation'] = self.version_information.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConceptDefinitionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uuid": obj.get("uuid"),
+            "objectName": obj.get("objectName"),
+            "basicInformation": BasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None,
+            "details": ConceptTypeDetailsDTO.from_dict(obj["details"]) if obj.get("details") is not None else None,
+            "versionInformation": VersionInformationDTO.from_dict(obj["versionInformation"]) if obj.get("versionInformation") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/concept_delete_request_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.concept_delete_with_context_dto import ConceptDeleteWithContextDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConceptDeleteRequestDTO(BaseModel):
+    """
+    The concepts to delete.
+    """ # noqa: E501
+    concepts: Optional[List[ConceptDeleteWithContextDTO]] = Field(default=None, description="The concepts in the request.")
+    __properties: ClassVar[List[str]] = ["concepts"]
+
+    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 ConceptDeleteRequestDTO 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 concepts (list)
+        _items = []
+        if self.concepts:
+            for _item_concepts in self.concepts:
+                if _item_concepts:
+                    _items.append(_item_concepts.to_dict())
+            _dict['concepts'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConceptDeleteRequestDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "concepts": [ConceptDeleteWithContextDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/concept_delete_with_context_dto.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.execution_context_dto import ExecutionContextDTO
+from visier_platform_sdk.models.object_id_dto import ObjectIdDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConceptDeleteWithContextDTO(BaseModel):
+    """
+    Information about the concept to delete and the context of the API request, such as the tenant code and project ID.
+    """ # noqa: E501
+    execution_context: Optional[ExecutionContextDTO] = Field(default=None, description="The context of the API request, such as the tenant code and project ID.", alias="executionContext")
+    concept: Optional[ObjectIdDTO] = Field(default=None, description="Information identifying the concept to delete.")
+    __properties: ClassVar[List[str]] = ["executionContext", "concept"]
+
+    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 ConceptDeleteWithContextDTO 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 execution_context
+        if self.execution_context:
+            _dict['executionContext'] = self.execution_context.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of concept
+        if self.concept:
+            _dict['concept'] = self.concept.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConceptDeleteWithContextDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "executionContext": ExecutionContextDTO.from_dict(obj["executionContext"]) if obj.get("executionContext") is not None else None,
+            "concept": ObjectIdDTO.from_dict(obj["concept"]) if obj.get("concept") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/concept_request_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.concept_with_context_dto import ConceptWithContextDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConceptRequestDTO(BaseModel):
+    """
+    The concepts to create or update.
+    """ # noqa: E501
+    concepts: Optional[List[ConceptWithContextDTO]] = Field(default=None, description="The concepts in the request.")
+    __properties: ClassVar[List[str]] = ["concepts"]
+
+    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 ConceptRequestDTO 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 concepts (list)
+        _items = []
+        if self.concepts:
+            for _item_concepts in self.concepts:
+                if _item_concepts:
+                    _items.append(_item_concepts.to_dict())
+            _dict['concepts'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConceptRequestDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "concepts": [ConceptWithContextDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/concept_response_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.concept_with_context_dto import ConceptWithContextDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConceptResponseDTO(BaseModel):
+    """
+    The response for retrieving concepts.
+    """ # noqa: E501
+    concepts: Optional[List[ConceptWithContextDTO]] = Field(default=None, description="The concepts in the response.")
+    __properties: ClassVar[List[str]] = ["concepts"]
+
+    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 ConceptResponseDTO 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 concepts (list)
+        _items = []
+        if self.concepts:
+            for _item_concepts in self.concepts:
+                if _item_concepts:
+                    _items.append(_item_concepts.to_dict())
+            _dict['concepts'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConceptResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "concepts": [ConceptWithContextDTO.from_dict(_item) for _item in obj["concepts"]] if obj.get("concepts") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/concept_type_details_dto.py

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99200.21494
+    Contact: alpine@visier.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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.calculated_selection_concept_dto import CalculatedSelectionConceptDTO
+from visier_platform_sdk.models.member_selection_concept_dto import MemberSelectionConceptDTO
+from visier_platform_sdk.models.process_concept_definition_dto import ProcessConceptDefinitionDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConceptTypeDetailsDTO(BaseModel):
+    """
+    ConceptTypeDetailsDTO
+    """ # noqa: E501
+    process: Optional[ProcessConceptDefinitionDTO] = Field(default=None, description="The process concept's associated objects, such as its analytic object and status dimension.")
+    member_selection: Optional[MemberSelectionConceptDTO] = Field(default=None, description="The member selection concept's configuration, such as its dimension members.", alias="memberSelection")
+    calculated_selection: Optional[CalculatedSelectionConceptDTO] = Field(default=None, description="The calculated selection concept's configuration, such as its formula.", alias="calculatedSelection")
+    __properties: ClassVar[List[str]] = ["process", "memberSelection", "calculatedSelection"]
+
+    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 ConceptTypeDetailsDTO 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 process
+        if self.process:
+            _dict['process'] = self.process.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of member_selection
+        if self.member_selection:
+            _dict['memberSelection'] = self.member_selection.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of calculated_selection
+        if self.calculated_selection:
+            _dict['calculatedSelection'] = self.calculated_selection.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConceptTypeDetailsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "process": ProcessConceptDefinitionDTO.from_dict(obj["process"]) if obj.get("process") is not None else None,
+            "memberSelection": MemberSelectionConceptDTO.from_dict(obj["memberSelection"]) if obj.get("memberSelection") is not None else None,
+            "calculatedSelection": CalculatedSelectionConceptDTO.from_dict(obj["calculatedSelection"]) if obj.get("calculatedSelection") is not None else None
+        })
+        return _obj
+
+