visier-platform-sdk 22222222.99201.1892b3__py3-none-any.whl

visier_platform_sdk/models/servicing_objectconfiguration_property_delete_failure_dto.py

@@ -0,0 +1,117 @@
+# 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.99201.1892
+    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.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingObjectconfigurationPropertyDeleteFailureDTO(BaseModel):
+    """
+    Details about a failed property deletion.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the property.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the property.", alias="displayName")
+    message: Optional[StrictStr] = Field(default=None, description="An error message describing the cause of the failure.")
+    rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.")
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant in which the property wasn't deleted.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The project in which the property wasn't deleted.", alias="projectId")
+    derived_dependents_to_delete: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="The derived dependents that would have been deleted if the deletion was successful.", alias="derivedDependentsToDelete")
+    reference_dependents_to_ignore: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="Dependents that reference this property and could be affected.", alias="referenceDependentsToIgnore")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "message", "rci", "tenantCode", "projectId", "derivedDependentsToDelete", "referenceDependentsToIgnore"]
+
+    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 ServicingObjectconfigurationPropertyDeleteFailureDTO 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 derived_dependents_to_delete (list)
+        _items = []
+        if self.derived_dependents_to_delete:
+            for _item_derived_dependents_to_delete in self.derived_dependents_to_delete:
+                if _item_derived_dependents_to_delete:
+                    _items.append(_item_derived_dependents_to_delete.to_dict())
+            _dict['derivedDependentsToDelete'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in reference_dependents_to_ignore (list)
+        _items = []
+        if self.reference_dependents_to_ignore:
+            for _item_reference_dependents_to_ignore in self.reference_dependents_to_ignore:
+                if _item_reference_dependents_to_ignore:
+                    _items.append(_item_reference_dependents_to_ignore.to_dict())
+            _dict['referenceDependentsToIgnore'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServicingObjectconfigurationPropertyDeleteFailureDTO 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"),
+            "displayName": obj.get("displayName"),
+            "message": obj.get("message"),
+            "rci": obj.get("rci"),
+            "tenantCode": obj.get("tenantCode"),
+            "projectId": obj.get("projectId"),
+            "derivedDependentsToDelete": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["derivedDependentsToDelete"]] if obj.get("derivedDependentsToDelete") is not None else None,
+            "referenceDependentsToIgnore": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["referenceDependentsToIgnore"]] if obj.get("referenceDependentsToIgnore") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_objectconfiguration_property_delete_success_dto.py

@@ -0,0 +1,113 @@
+# 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.99201.1892
+    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.servicing_objectconfiguration_dependent_dto import ServicingObjectconfigurationDependentDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingObjectconfigurationPropertyDeleteSuccessDTO(BaseModel):
+    """
+    Details about a successful property deletion.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the property.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the property.", alias="displayName")
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant in which the property was deleted.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The project in which the property was deleted.", alias="projectId")
+    derived_dependents_deleted: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="The derived dependents that were deleted along with the property.", alias="derivedDependentsDeleted")
+    reference_dependents_ignored: Optional[List[ServicingObjectconfigurationDependentDTO]] = Field(default=None, description="Dependents that reference the property and were ignored during deletion.", alias="referenceDependentsIgnored")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "tenantCode", "projectId", "derivedDependentsDeleted", "referenceDependentsIgnored"]
+
+    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 ServicingObjectconfigurationPropertyDeleteSuccessDTO 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 derived_dependents_deleted (list)
+        _items = []
+        if self.derived_dependents_deleted:
+            for _item_derived_dependents_deleted in self.derived_dependents_deleted:
+                if _item_derived_dependents_deleted:
+                    _items.append(_item_derived_dependents_deleted.to_dict())
+            _dict['derivedDependentsDeleted'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in reference_dependents_ignored (list)
+        _items = []
+        if self.reference_dependents_ignored:
+            for _item_reference_dependents_ignored in self.reference_dependents_ignored:
+                if _item_reference_dependents_ignored:
+                    _items.append(_item_reference_dependents_ignored.to_dict())
+            _dict['referenceDependentsIgnored'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServicingObjectconfigurationPropertyDeleteSuccessDTO 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"),
+            "displayName": obj.get("displayName"),
+            "tenantCode": obj.get("tenantCode"),
+            "projectId": obj.get("projectId"),
+            "derivedDependentsDeleted": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["derivedDependentsDeleted"]] if obj.get("derivedDependentsDeleted") is not None else None,
+            "referenceDependentsIgnored": [ServicingObjectconfigurationDependentDTO.from_dict(_item) for _item in obj["referenceDependentsIgnored"]] if obj.get("referenceDependentsIgnored") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_objectconfiguration_property_type_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.99201.1892
+    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.servicing_objectconfiguration_calculated_property_type_dto import ServicingObjectconfigurationCalculatedPropertyTypeDTO
+from visier_platform_sdk.models.servicing_objectconfiguration_simple_property_type_dto import ServicingObjectconfigurationSimplePropertyTypeDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingObjectconfigurationPropertyTypeDTO(BaseModel):
+    """
+    ServicingObjectconfigurationPropertyTypeDTO
+    """ # noqa: E501
+    simple: Optional[ServicingObjectconfigurationSimplePropertyTypeDTO] = Field(default=None, description="The simple property type, which provides a single value directly from the data.")
+    calculated: Optional[ServicingObjectconfigurationCalculatedPropertyTypeDTO] = Field(default=None, description="The calculated property type, which derives its value using a formula.")
+    __properties: ClassVar[List[str]] = ["simple", "calculated"]
+
+    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 ServicingObjectconfigurationPropertyTypeDTO 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 simple
+        if self.simple:
+            _dict['simple'] = self.simple.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of calculated
+        if self.calculated:
+            _dict['calculated'] = self.calculated.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServicingObjectconfigurationPropertyTypeDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "simple": ServicingObjectconfigurationSimplePropertyTypeDTO.from_dict(obj["simple"]) if obj.get("simple") is not None else None,
+            "calculated": ServicingObjectconfigurationCalculatedPropertyTypeDTO.from_dict(obj["calculated"]) if obj.get("calculated") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_objectconfiguration_simple_property_type_dto.py

@@ -0,0 +1,88 @@
+# 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.99201.1892
+    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 typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingObjectconfigurationSimplePropertyTypeDTO(BaseModel):
+    """
+    ServicingObjectconfigurationSimplePropertyTypeDTO
+    """ # noqa: E501
+    data_type: Optional[StrictStr] = Field(default=None, description="The data type of the property, such as Categorical, HourDuration, or Ratio.", alias="dataType")
+    __properties: ClassVar[List[str]] = ["dataType"]
+
+    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 ServicingObjectconfigurationSimplePropertyTypeDTO 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 ServicingObjectconfigurationSimplePropertyTypeDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dataType": obj.get("dataType")
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_objectconfiguration_tags_dto.py

@@ -0,0 +1,88 @@
+# 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.99201.1892
+    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 typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingObjectconfigurationTagsDTO(BaseModel):
+    """
+    Wrapper to distinguish between an empty list and a null/unset list.
+    """ # noqa: E501
+    ids: Optional[List[StrictStr]] = Field(default=None, description="The tag ids.")
+    __properties: ClassVar[List[str]] = ["ids"]
+
+    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 ServicingObjectconfigurationTagsDTO 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 ServicingObjectconfigurationTagsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ids": obj.get("ids")
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_permission_assigned_by_tenant_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.99201.1892
+    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.servicing_permission_assigned_user_dto import ServicingPermissionAssignedUserDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingPermissionAssignedByTenantDTO(BaseModel):
+    """
+    The users assigned a specific permission, grouped by tenant.
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the tenant.", alias="tenantCode")
+    users: Optional[List[ServicingPermissionAssignedUserDTO]] = Field(default=None, description="A list of objects representing the users that the permission is assigned to.")
+    __properties: ClassVar[List[str]] = ["tenantCode", "users"]
+
+    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 ServicingPermissionAssignedByTenantDTO 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 users (list)
+        _items = []
+        if self.users:
+            for _item_users in self.users:
+                if _item_users:
+                    _items.append(_item_users.to_dict())
+            _dict['users'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServicingPermissionAssignedByTenantDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenantCode": obj.get("tenantCode"),
+            "users": [ServicingPermissionAssignedUserDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None
+        })
+        return _obj
+
+