visier-platform-sdk 22222222.99201.1914__py3-none-any.whl → 22222222.99201.1914b6__py3-none-any.whl

visier_platform_sdk/models/user_group_change_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.99201.1914
+    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.element_ids_dto import ElementIDsDTO
+from visier_platform_sdk.models.user_group_change_users_dto import UserGroupChangeUsersDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserGroupChangeDefinitionDTO(BaseModel):
+    """
+    UserGroupChangeDefinitionDTO
+    """ # noqa: E501
+    user_group_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the user group. Omit if creating a new user group.", alias="userGroupId")
+    display_name: Optional[StrictStr] = Field(default=None, description="An identifiable user group name to display in Visier, such as \"Leadership User Group\".", alias="displayName")
+    description: Optional[StrictStr] = Field(default=None, description="A detailed description of the population and purpose of the user group.")
+    permission_ids: Optional[ElementIDsDTO] = Field(default=None, description="The unique identifiers of permissions assigned to members of this user group.", alias="permissionIds")
+    users: Optional[UserGroupChangeUsersDTO] = Field(default=None, description="The users assigned to the user group. You can define user group members dynamically with `dynamicFilterDefinition` or manually with `includeAllUsers` or `manuallyIncludedIds`.")
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant to which the user group belongs or should be created in.  Omit if creating or updating user groups in the current tenant.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The project ID in which to update or create the user group.  If omitted and the ProjectID request header is not defined, the change is published to production immediately.", alias="projectId")
+    __properties: ClassVar[List[str]] = ["userGroupId", "displayName", "description", "permissionIds", "users", "tenantCode", "projectId"]
+
+    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 UserGroupChangeDefinitionDTO 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 permission_ids
+        if self.permission_ids:
+            _dict['permissionIds'] = self.permission_ids.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of users
+        if self.users:
+            _dict['users'] = self.users.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserGroupChangeDefinitionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "userGroupId": obj.get("userGroupId"),
+            "displayName": obj.get("displayName"),
+            "description": obj.get("description"),
+            "permissionIds": ElementIDsDTO.from_dict(obj["permissionIds"]) if obj.get("permissionIds") is not None else None,
+            "users": UserGroupChangeUsersDTO.from_dict(obj["users"]) if obj.get("users") is not None else None,
+            "tenantCode": obj.get("tenantCode"),
+            "projectId": obj.get("projectId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/user_group_change_dimension_filter_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.99201.1914
+    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.element_ids_dto import ElementIDsDTO
+from visier_platform_sdk.models.user_group_change_member_selection_dto import UserGroupChangeMemberSelectionDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserGroupChangeDimensionFilterDTO(BaseModel):
+    """
+    UserGroupChangeDimensionFilterDTO
+    """ # noqa: E501
+    dimension_id: Optional[StrictStr] = Field(default=None, description="The object name of the dimension.", alias="dimensionId")
+    subject_reference_path: Optional[ElementIDsDTO] = Field(default=None, description="A qualifying path if the dimension is from an analytic object that references Employee.  For example, use `subjectReferencePath` to create a filter on the `Employment_Start_Type` dimension from the `Employment_Start` object, which references `Employee`: `{ \"ids\": [ \"Employee\", \"Employment_Start\" ] }`.", alias="subjectReferencePath")
+    member_selections: Optional[List[UserGroupChangeMemberSelectionDTO]] = Field(default=None, description="The dimension members to select in the dynamic filter.", alias="memberSelections")
+    __properties: ClassVar[List[str]] = ["dimensionId", "subjectReferencePath", "memberSelections"]
+
+    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 UserGroupChangeDimensionFilterDTO 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 subject_reference_path
+        if self.subject_reference_path:
+            _dict['subjectReferencePath'] = self.subject_reference_path.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in member_selections (list)
+        _items = []
+        if self.member_selections:
+            for _item_member_selections in self.member_selections:
+                if _item_member_selections:
+                    _items.append(_item_member_selections.to_dict())
+            _dict['memberSelections'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserGroupChangeDimensionFilterDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimensionId": obj.get("dimensionId"),
+            "subjectReferencePath": ElementIDsDTO.from_dict(obj["subjectReferencePath"]) if obj.get("subjectReferencePath") is not None else None,
+            "memberSelections": [UserGroupChangeMemberSelectionDTO.from_dict(_item) for _item in obj["memberSelections"]] if obj.get("memberSelections") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/user_group_change_failure_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.99201.1914
+    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 UserGroupChangeFailureDTO(BaseModel):
+    """
+    UserGroupChangeFailureDTO
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = Field(default=None, description="The display name of the user group that couldn't be created.", alias="displayName")
+    message: Optional[StrictStr] = Field(default=None, description="The error message containing 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 code of the tenant for which the user group could not be created or updated.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The ID of the project in which the user group could not be created or updated.", alias="projectId")
+    __properties: ClassVar[List[str]] = ["displayName", "message", "rci", "tenantCode", "projectId"]
+
+    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 UserGroupChangeFailureDTO 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 UserGroupChangeFailureDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "displayName": obj.get("displayName"),
+            "message": obj.get("message"),
+            "rci": obj.get("rci"),
+            "tenantCode": obj.get("tenantCode"),
+            "projectId": obj.get("projectId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/user_group_change_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.99201.1914
+    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.user_group_change_dimension_filter_dto import UserGroupChangeDimensionFilterDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserGroupChangeFilterDTO(BaseModel):
+    """
+    UserGroupChangeFilterDTO
+    """ # noqa: E501
+    filter_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the filter. Omit if creating a new filter.", alias="filterId")
+    analytic_object_id: Optional[StrictStr] = Field(default=None, description="The analytic object the filter applies to. Currently, the only supported analytic object is `Employee`. Default is `Employee`.", alias="analyticObjectId")
+    dimension_filters: Optional[List[UserGroupChangeDimensionFilterDTO]] = Field(default=None, description="The dimensions in the dynamic filter.", alias="dimensionFilters")
+    __properties: ClassVar[List[str]] = ["filterId", "analyticObjectId", "dimensionFilters"]
+
+    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 UserGroupChangeFilterDTO 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 dimension_filters (list)
+        _items = []
+        if self.dimension_filters:
+            for _item_dimension_filters in self.dimension_filters:
+                if _item_dimension_filters:
+                    _items.append(_item_dimension_filters.to_dict())
+            _dict['dimensionFilters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserGroupChangeFilterDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "filterId": obj.get("filterId"),
+            "analyticObjectId": obj.get("analyticObjectId"),
+            "dimensionFilters": [UserGroupChangeDimensionFilterDTO.from_dict(_item) for _item in obj["dimensionFilters"]] if obj.get("dimensionFilters") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/user_group_change_member_selection_dto.py

@@ -0,0 +1,90 @@
+# 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.1914
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserGroupChangeMemberSelectionDTO(BaseModel):
+    """
+    UserGroupChangeMemberSelectionDTO
+    """ # noqa: E501
+    is_excluded: Optional[StrictBool] = Field(default=None, description="If `true`, the specified member must not be defined for members of the user group.", alias="isExcluded")
+    name_path: Optional[List[StrictStr]] = Field(default=None, description="The name path for dimension members; for example, `[ \"North America\", \"US\", \"CA\" ]`.", alias="namePath")
+    __properties: ClassVar[List[str]] = ["isExcluded", "namePath"]
+
+    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 UserGroupChangeMemberSelectionDTO 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 UserGroupChangeMemberSelectionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "isExcluded": obj.get("isExcluded"),
+            "namePath": obj.get("namePath")
+        })
+        return _obj
+
+

visier_platform_sdk/models/user_group_change_response_dto.py

@@ -0,0 +1,106 @@
+# 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.1914
+    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.user_group_change_failure_dto import UserGroupChangeFailureDTO
+from visier_platform_sdk.models.user_group_change_success_dto import UserGroupChangeSuccessDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserGroupChangeResponseDTO(BaseModel):
+    """
+    UserGroupChangeResponseDTO
+    """ # noqa: E501
+    successes: Optional[List[UserGroupChangeSuccessDTO]] = Field(default=None, description="The user groups that were created.")
+    failures: Optional[List[UserGroupChangeFailureDTO]] = Field(default=None, description="The user groups that were not created.")
+    __properties: ClassVar[List[str]] = ["successes", "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 UserGroupChangeResponseDTO 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 successes (list)
+        _items = []
+        if self.successes:
+            for _item_successes in self.successes:
+                if _item_successes:
+                    _items.append(_item_successes.to_dict())
+            _dict['successes'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in failures (list)
+        _items = []
+        if self.failures:
+            for _item_failures in self.failures:
+                if _item_failures:
+                    _items.append(_item_failures.to_dict())
+            _dict['failures'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserGroupChangeResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "successes": [UserGroupChangeSuccessDTO.from_dict(_item) for _item in obj["successes"]] if obj.get("successes") is not None else None,
+            "failures": [UserGroupChangeFailureDTO.from_dict(_item) for _item in obj["failures"]] if obj.get("failures") is not None else None
+        })
+        return _obj
+
+