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

visier_platform_sdk/models/dimension_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 DimensionDeleteWithContextDTO(BaseModel):
+    """
+    Information about the dimension 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")
+    dimension: Optional[ObjectIdDTO] = Field(default=None, description="Information identifying the dimension to delete.")
+    __properties: ClassVar[List[str]] = ["executionContext", "dimension"]
+
+    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 DimensionDeleteWithContextDTO 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 dimension
+        if self.dimension:
+            _dict['dimension'] = self.dimension.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionDeleteWithContextDTO 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,
+            "dimension": ObjectIdDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_details_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.leveled_details_dto import LeveledDetailsDTO
+from visier_platform_sdk.models.parent_child_details_dto import ParentChildDetailsDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionDetailsDTO(BaseModel):
+    """
+    The dimension type and its details.
+    """ # noqa: E501
+    leveled: Optional[LeveledDetailsDTO] = Field(default=None, description="The leveled dimension's configuration, such as its levels and settings.")
+    parent_child: Optional[ParentChildDetailsDTO] = Field(default=None, description="The parent-child dimension's configuration, such as its levels and name property.", alias="parentChild")
+    __properties: ClassVar[List[str]] = ["leveled", "parentChild"]
+
+    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 DimensionDetailsDTO 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 leveled
+        if self.leveled:
+            _dict['leveled'] = self.leveled.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of parent_child
+        if self.parent_child:
+            _dict['parentChild'] = self.parent_child.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionDetailsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "leveled": LeveledDetailsDTO.from_dict(obj["leveled"]) if obj.get("leveled") is not None else None,
+            "parentChild": ParentChildDetailsDTO.from_dict(obj["parentChild"]) if obj.get("parentChild") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_dto.py

@@ -0,0 +1,120 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.level_dto import LevelDTO
+from visier_platform_sdk.models.tag_map_element_dto import TagMapElementDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionDTO(BaseModel):
+    """
+    A dimension organizes unique values of an attribute into a list or a hierarchical structure for use as a filter or group-by in your solution.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique ID of the dimension.")
+    display_name: Optional[StrictStr] = Field(default=None, description="The localized display name of the dimension.", alias="displayName")
+    description: Optional[StrictStr] = Field(default=None, description="The localized description of the dimension.")
+    levels: Optional[List[LevelDTO]] = Field(default=None, description="The levels defined for the dimension. Note: For parent-child dimensions, a level name is generated by Visier.")
+    unknown_member: Optional[List[StrictStr]] = Field(default=None, description="The optional path to the unknown member, if defined.", alias="unknownMember")
+    member_count: Optional[StrictInt] = Field(default=None, description="The total number of members for the dimension, excluding the (All) member.", alias="memberCount")
+    visible_in_app: Optional[StrictBool] = Field(default=None, description="`true` if this dimension is set to be visible in your solution.", alias="visibleInApp")
+    tags: Optional[List[TagMapElementDTO]] = Field(default=None, description="The optional collection of tags defined for this element.")
+    explanation: Optional[StrictStr] = Field(default=None, description="The localized explanation of the dimension.")
+    __properties: ClassVar[List[str]] = ["id", "displayName", "description", "levels", "unknownMember", "memberCount", "visibleInApp", "tags", "explanation"]
+
+    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 DimensionDTO 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 levels (list)
+        _items = []
+        if self.levels:
+            for _item_levels in self.levels:
+                if _item_levels:
+                    _items.append(_item_levels.to_dict())
+            _dict['levels'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tags (list)
+        _items = []
+        if self.tags:
+            for _item_tags in self.tags:
+                if _item_tags:
+                    _items.append(_item_tags.to_dict())
+            _dict['tags'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionDTO 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"),
+            "description": obj.get("description"),
+            "levels": [LevelDTO.from_dict(_item) for _item in obj["levels"]] if obj.get("levels") is not None else None,
+            "unknownMember": obj.get("unknownMember"),
+            "memberCount": obj.get("memberCount"),
+            "visibleInApp": obj.get("visibleInApp"),
+            "tags": [TagMapElementDTO.from_dict(_item) for _item in obj["tags"]] if obj.get("tags") is not None else None,
+            "explanation": obj.get("explanation")
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_filter_dto.py

@@ -0,0 +1,100 @@
+# 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.member_selection_list_dto import MemberSelectionListDTO
+from visier_platform_sdk.models.qualifying_path_dto import QualifyingPathDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionFilterDTO(BaseModel):
+    """
+    A dimension associated with the selection concept.
+    """ # noqa: E501
+    dimension_name: Optional[StrictStr] = Field(default=None, description="The display name of the dimension.", alias="dimensionName")
+    qualifying_path: Optional[QualifyingPathDTO] = Field(default=None, description="The objects that qualify the path to the dimension from its parent analytic object. For example, let's say the analytic object is `Applicant` and the dimension is `Location`. To get from `Location` to `Applicant` there are multiple paths, one of which is to follow references `Requisition` and then `Hiring Manager` to `Location`. `Location` is available on `Hiring_Manager` because a hiring manager is an `Employee`. In this example, the qualifying path is `Requisition.Hiring_Manager`.", alias="qualifyingPath")
+    member_selection_list: Optional[MemberSelectionListDTO] = Field(default=None, description="The dimension members in a member selection concept.", alias="memberSelectionList")
+    __properties: ClassVar[List[str]] = ["dimensionName", "qualifyingPath", "memberSelectionList"]
+
+    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 DimensionFilterDTO 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 qualifying_path
+        if self.qualifying_path:
+            _dict['qualifyingPath'] = self.qualifying_path.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of member_selection_list
+        if self.member_selection_list:
+            _dict['memberSelectionList'] = self.member_selection_list.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionFilterDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimensionName": obj.get("dimensionName"),
+            "qualifyingPath": QualifyingPathDTO.from_dict(obj["qualifyingPath"]) if obj.get("qualifyingPath") is not None else None,
+            "memberSelectionList": MemberSelectionListDTO.from_dict(obj["memberSelectionList"]) if obj.get("memberSelectionList") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_filter_list_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.dimension_filter_dto import DimensionFilterDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionFilterListDTO(BaseModel):
+    """
+    The dimensions associated with the selection concept.
+    """ # noqa: E501
+    filters: Optional[List[DimensionFilterDTO]] = Field(default=None, description="The dimensions associated with the selection concept.")
+    __properties: ClassVar[List[str]] = ["filters"]
+
+    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 DimensionFilterListDTO 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 filters (list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(_item_filters.to_dict())
+            _dict['filters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionFilterListDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "filters": [DimensionFilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/dimension_mapping_validation_dto.py

@@ -0,0 +1,102 @@
+# 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.dimension_member_reference_dto import DimensionMemberReferenceDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DimensionMappingValidationDTO(BaseModel):
+    """
+    DimensionMappingValidationDTO
+    """ # noqa: E501
+    dimension_map_id: Optional[StrictStr] = Field(default=None, alias="dimensionMapId")
+    dimension_id: Optional[StrictStr] = Field(default=None, alias="dimensionId")
+    unmapped_members: Optional[List[DimensionMemberReferenceDTO]] = Field(default=None, alias="unmappedMembers")
+    failures: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["dimensionMapId", "dimensionId", "unmappedMembers", "failures"]
+
+    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 DimensionMappingValidationDTO 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 unmapped_members (list)
+        _items = []
+        if self.unmapped_members:
+            for _item_unmapped_members in self.unmapped_members:
+                if _item_unmapped_members:
+                    _items.append(_item_unmapped_members.to_dict())
+            _dict['unmappedMembers'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DimensionMappingValidationDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimensionMapId": obj.get("dimensionMapId"),
+            "dimensionId": obj.get("dimensionId"),
+            "unmappedMembers": [DimensionMemberReferenceDTO.from_dict(_item) for _item in obj["unmappedMembers"]] if obj.get("unmappedMembers") is not None else None,
+            "failures": obj.get("failures")
+        })
+        return _obj
+
+