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

visier_platform_sdk/models/all_user_groups_assigned_for_local_tenant_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.user_group_assigned_for_local_tenant_dto import UserGroupAssignedForLocalTenantDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AllUserGroupsAssignedForLocalTenantDTO(BaseModel):
+    """
+    AllUserGroupsAssignedForLocalTenantDTO
+    """ # noqa: E501
+    assigned_user_groups: Optional[List[UserGroupAssignedForLocalTenantDTO]] = Field(default=None, description="A list of objects representing the available user groups.", alias="assignedUserGroups")
+    __properties: ClassVar[List[str]] = ["assignedUserGroups"]
+
+    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 AllUserGroupsAssignedForLocalTenantDTO 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 assigned_user_groups (list)
+        _items = []
+        if self.assigned_user_groups:
+            for _item_assigned_user_groups in self.assigned_user_groups:
+                if _item_assigned_user_groups:
+                    _items.append(_item_assigned_user_groups.to_dict())
+            _dict['assignedUserGroups'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AllUserGroupsAssignedForLocalTenantDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "assignedUserGroups": [UserGroupAssignedForLocalTenantDTO.from_dict(_item) for _item in obj["assignedUserGroups"]] if obj.get("assignedUserGroups") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/all_users_get_api_response_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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.user_get_api_response_dto import UserGetAPIResponseDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AllUsersGetAPIResponseDTO(BaseModel):
+    """
+    AllUsersGetAPIResponseDTO
+    """ # noqa: E501
+    users: Optional[List[UserGetAPIResponseDTO]] = Field(default=None, description="A list of available users.")
+    limit: Optional[StrictInt] = Field(default=None, description="The number of results to return. The maximum number of users to retrieve is 1000.")
+    start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving results from, also known as offset. The index begins at 0.")
+    __properties: ClassVar[List[str]] = ["users", "limit", "start"]
+
+    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 AllUsersGetAPIResponseDTO 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 AllUsersGetAPIResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "users": [UserGetAPIResponseDTO.from_dict(_item) for _item in obj["users"]] if obj.get("users") is not None else None,
+            "limit": obj.get("limit"),
+            "start": obj.get("start")
+        })
+        return _obj
+
+

visier_platform_sdk/models/analytic_object_definition_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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalyticObjectDefinitionDTO(BaseModel):
+    """
+    Information about the analytic object, such as its UUID and object name.
+    """ # noqa: E501
+    uuid: Optional[StrictStr] = Field(default=None, description="The UUID identifying the analytic object.")
+    object_name: Optional[StrictStr] = Field(default=None, description="The object name of the analytic object.", alias="objectName")
+    update_operation: Optional[StrictStr] = Field(default=None, description="Update the analytic object. Required for `PUT` requests. Valid values:  - `unspecified`: Do not update the object.  - `revertToBP`: Undo any tenant overrides and revert the object back to its Blueprint state.", alias="updateOperation")
+    __properties: ClassVar[List[str]] = ["uuid", "objectName", "updateOperation"]
+
+    @field_validator('update_operation')
+    def update_operation_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['unspecified', 'revertToBP']):
+            raise ValueError("must be one of enum values ('unspecified', 'revertToBP')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AnalyticObjectDefinitionDTO 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 AnalyticObjectDefinitionDTO 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"),
+            "updateOperation": obj.get("updateOperation")
+        })
+        return _obj
+
+

visier_platform_sdk/models/analytic_object_dto.py

@@ -0,0 +1,132 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.related_analytic_object_dto import RelatedAnalyticObjectDTO
+from visier_platform_sdk.models.securable_dimension_dto import SecurableDimensionDTO
+from visier_platform_sdk.models.securable_property_dto import SecurablePropertyDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalyticObjectDTO(BaseModel):
+    """
+    AnalyticObjectDTO
+    """ # noqa: E501
+    analytic_object_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analytic object.", alias="analyticObjectId")
+    display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name to display in Visier, such as \"Employee\".", alias="displayName")
+    object_type: Optional[StrictStr] = Field(default=None, description="The analytic object type.", alias="objectType")
+    related_objects: Optional[List[RelatedAnalyticObjectDTO]] = Field(default=None, description="The analytic objects related to the data security object.", alias="relatedObjects")
+    securable_properties: Optional[List[SecurablePropertyDTO]] = Field(default=None, description="All available properties from the data security object and its related analytic objects that you can configure data access for.", alias="securableProperties")
+    securable_dimensions: Optional[List[SecurableDimensionDTO]] = Field(default=None, description="A list of dimensions that are available to define population access filters in the permission.", alias="securableDimensions")
+    __properties: ClassVar[List[str]] = ["analyticObjectId", "displayName", "objectType", "relatedObjects", "securableProperties", "securableDimensions"]
+
+    @field_validator('object_type')
+    def object_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Event', 'Subject', 'BusinessOutcomeOverlay', 'PlanOrBudgetOverlay', 'ExternalBenchmark', 'VisierBenchmark', 'UsageOverlay', 'OtherOverlay', 'InternalComparison', 'PlanAnalyticObject']):
+            raise ValueError("must be one of enum values ('Event', 'Subject', 'BusinessOutcomeOverlay', 'PlanOrBudgetOverlay', 'ExternalBenchmark', 'VisierBenchmark', 'UsageOverlay', 'OtherOverlay', 'InternalComparison', 'PlanAnalyticObject')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AnalyticObjectDTO 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 related_objects (list)
+        _items = []
+        if self.related_objects:
+            for _item_related_objects in self.related_objects:
+                if _item_related_objects:
+                    _items.append(_item_related_objects.to_dict())
+            _dict['relatedObjects'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in securable_properties (list)
+        _items = []
+        if self.securable_properties:
+            for _item_securable_properties in self.securable_properties:
+                if _item_securable_properties:
+                    _items.append(_item_securable_properties.to_dict())
+            _dict['securableProperties'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in securable_dimensions (list)
+        _items = []
+        if self.securable_dimensions:
+            for _item_securable_dimensions in self.securable_dimensions:
+                if _item_securable_dimensions:
+                    _items.append(_item_securable_dimensions.to_dict())
+            _dict['securableDimensions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AnalyticObjectDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "analyticObjectId": obj.get("analyticObjectId"),
+            "displayName": obj.get("displayName"),
+            "objectType": obj.get("objectType"),
+            "relatedObjects": [RelatedAnalyticObjectDTO.from_dict(_item) for _item in obj["relatedObjects"]] if obj.get("relatedObjects") is not None else None,
+            "securableProperties": [SecurablePropertyDTO.from_dict(_item) for _item in obj["securableProperties"]] if obj.get("securableProperties") is not None else None,
+            "securableDimensions": [SecurableDimensionDTO.from_dict(_item) for _item in obj["securableDimensions"]] if obj.get("securableDimensions") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/analytic_object_filter_dto.py

@@ -0,0 +1,94 @@
+# 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_filter_list_dto import DimensionFilterListDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalyticObjectFilterDTO(BaseModel):
+    """
+    The analytic objects associated with the object.
+    """ # noqa: E501
+    analytic_object_name: Optional[StrictStr] = Field(default=None, description="The analytic object name to which the dimension applies.", alias="analyticObjectName")
+    dimension_filter_list: Optional[DimensionFilterListDTO] = Field(default=None, description="The dimensions associated with the selection concept.", alias="dimensionFilterList")
+    __properties: ClassVar[List[str]] = ["analyticObjectName", "dimensionFilterList"]
+
+    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 AnalyticObjectFilterDTO 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 dimension_filter_list
+        if self.dimension_filter_list:
+            _dict['dimensionFilterList'] = self.dimension_filter_list.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AnalyticObjectFilterDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "analyticObjectName": obj.get("analyticObjectName"),
+            "dimensionFilterList": DimensionFilterListDTO.from_dict(obj["dimensionFilterList"]) if obj.get("dimensionFilterList") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/analytic_object_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.analytic_object_filter_dto import AnalyticObjectFilterDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AnalyticObjectFilterListDTO(BaseModel):
+    """
+    The analytic objects associated with the object.
+    """ # noqa: E501
+    analytic_object_filters: Optional[List[AnalyticObjectFilterDTO]] = Field(default=None, description="The list of analytic object associated with the dimension.", alias="analyticObjectFilters")
+    __properties: ClassVar[List[str]] = ["analyticObjectFilters"]
+
+    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 AnalyticObjectFilterListDTO 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 analytic_object_filters (list)
+        _items = []
+        if self.analytic_object_filters:
+            for _item_analytic_object_filters in self.analytic_object_filters:
+                if _item_analytic_object_filters:
+                    _items.append(_item_analytic_object_filters.to_dict())
+            _dict['analyticObjectFilters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AnalyticObjectFilterListDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "analyticObjectFilters": [AnalyticObjectFilterDTO.from_dict(_item) for _item in obj["analyticObjectFilters"]] if obj.get("analyticObjectFilters") is not None else None
+        })
+        return _obj
+
+