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

visier_platform_sdk/models/servicing_local_tenant_profile_assignment_response_dto.py

@@ -0,0 +1,118 @@
+# 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, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.servicing_failed_local_tenant_profile_assignment_dto import ServicingFailedLocalTenantProfileAssignmentDTO
+from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO
+from visier_platform_sdk.models.servicing_user_id_error_dto import ServicingUserIdErrorDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingLocalTenantProfileAssignmentResponseDTO(BaseModel):
+    """
+    ServicingLocalTenantProfileAssignmentResponseDTO
+    """ # noqa: E501
+    errors: Optional[StrictBool] = Field(default=None, description="If true, an error was generated by the request.")
+    bad_user_ids: Optional[List[ServicingUserIdErrorDTO]] = Field(default=None, description="A list of objects representing the user IDs that may not be valid.", alias="badUserIds")
+    failed_assignments: Optional[List[ServicingFailedLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of objects representing any errors that occurred during the assignment operation.", alias="failedAssignments")
+    successful_assignments: Optional[List[ServicingSuccessfulLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of the user IDs that were successfully assigned the profile.", alias="successfulAssignments")
+    __properties: ClassVar[List[str]] = ["errors", "badUserIds", "failedAssignments", "successfulAssignments"]
+
+    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 ServicingLocalTenantProfileAssignmentResponseDTO 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 bad_user_ids (list)
+        _items = []
+        if self.bad_user_ids:
+            for _item_bad_user_ids in self.bad_user_ids:
+                if _item_bad_user_ids:
+                    _items.append(_item_bad_user_ids.to_dict())
+            _dict['badUserIds'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in failed_assignments (list)
+        _items = []
+        if self.failed_assignments:
+            for _item_failed_assignments in self.failed_assignments:
+                if _item_failed_assignments:
+                    _items.append(_item_failed_assignments.to_dict())
+            _dict['failedAssignments'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in successful_assignments (list)
+        _items = []
+        if self.successful_assignments:
+            for _item_successful_assignments in self.successful_assignments:
+                if _item_successful_assignments:
+                    _items.append(_item_successful_assignments.to_dict())
+            _dict['successfulAssignments'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServicingLocalTenantProfileAssignmentResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "errors": obj.get("errors"),
+            "badUserIds": [ServicingUserIdErrorDTO.from_dict(_item) for _item in obj["badUserIds"]] if obj.get("badUserIds") is not None else None,
+            "failedAssignments": [ServicingFailedLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["failedAssignments"]] if obj.get("failedAssignments") is not None else None,
+            "successfulAssignments": [ServicingSuccessfulLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["successfulAssignments"]] if obj.get("successfulAssignments") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_local_tenant_profile_revoke_request_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 ServicingLocalTenantProfileRevokeRequestDTO(BaseModel):
+    """
+    ServicingLocalTenantProfileRevokeRequestDTO
+    """ # noqa: E501
+    target_user_ids: Optional[List[StrictStr]] = Field(default=None, description="A list of users to remove this profile from.", alias="targetUserIds")
+    __properties: ClassVar[List[str]] = ["targetUserIds"]
+
+    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 ServicingLocalTenantProfileRevokeRequestDTO 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 ServicingLocalTenantProfileRevokeRequestDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "targetUserIds": obj.get("targetUserIds")
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_local_tenant_profile_revoke_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.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_failed_local_tenant_profile_revoke_dto import ServicingFailedLocalTenantProfileRevokeDTO
+from visier_platform_sdk.models.servicing_successful_local_tenant_profile_assignment_dto import ServicingSuccessfulLocalTenantProfileAssignmentDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingLocalTenantProfileRevokeResponseDTO(BaseModel):
+    """
+    ServicingLocalTenantProfileRevokeResponseDTO
+    """ # noqa: E501
+    failed: Optional[List[ServicingFailedLocalTenantProfileRevokeDTO]] = Field(default=None, description="A list of objects representing any errors that occurred during the assignment operation.")
+    succeeded: Optional[List[ServicingSuccessfulLocalTenantProfileAssignmentDTO]] = Field(default=None, description="A list of the user IDs that successfully had a profile removed.")
+    __properties: ClassVar[List[str]] = ["failed", "succeeded"]
+
+    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 ServicingLocalTenantProfileRevokeResponseDTO 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 failed (list)
+        _items = []
+        if self.failed:
+            for _item_failed in self.failed:
+                if _item_failed:
+                    _items.append(_item_failed.to_dict())
+            _dict['failed'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in succeeded (list)
+        _items = []
+        if self.succeeded:
+            for _item_succeeded in self.succeeded:
+                if _item_succeeded:
+                    _items.append(_item_succeeded.to_dict())
+            _dict['succeeded'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ServicingLocalTenantProfileRevokeResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "failed": [ServicingFailedLocalTenantProfileRevokeDTO.from_dict(_item) for _item in obj["failed"]] if obj.get("failed") is not None else None,
+            "succeeded": [ServicingSuccessfulLocalTenantProfileAssignmentDTO.from_dict(_item) for _item in obj["succeeded"]] if obj.get("succeeded") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_member_filter_config_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.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_dimension_filter_dto import ServicingDimensionFilterDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingMemberFilterConfigDTO(BaseModel):
+    """
+    ServicingMemberFilterConfigDTO
+    """ # noqa: E501
+    dimension_filters: Optional[List[ServicingDimensionFilterDTO]] = Field(default=None, description="A list of objects representing the custom filters that define population access for the item.   A custom filter can be a \"member filter\" (`staticDimensionFilter`) or a \"dynamic filter\" (`dynamicDimensionFilter`).", alias="dimensionFilters")
+    __properties: ClassVar[List[str]] = ["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 ServicingMemberFilterConfigDTO 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 ServicingMemberFilterConfigDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimensionFilters": [ServicingDimensionFilterDTO.from_dict(_item) for _item in obj["dimensionFilters"]] if obj.get("dimensionFilters") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_member_selection_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.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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServicingMemberSelectionDTO(BaseModel):
+    """
+    ServicingMemberSelectionDTO
+    """ # noqa: E501
+    name_path: Optional[List[StrictStr]] = Field(default=None, description="The member name path.", alias="namePath")
+    excluded: Optional[StrictBool] = Field(default=None, description="If `true`, population access is granted for all members except this member.")
+    dimension_member_status: Optional[StrictStr] = Field(default=None, description="The dimension member's validity status. Valid values: Valid, NotFound.  * **Valid**: The object exists and has loaded data.  * **NotFound**: The object doesn't exist.", alias="dimensionMemberStatus")
+    __properties: ClassVar[List[str]] = ["namePath", "excluded", "dimensionMemberStatus"]
+
+    @field_validator('dimension_member_status')
+    def dimension_member_status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Unset', 'Valid', 'NoData', 'NotFound']):
+            raise ValueError("must be one of enum values ('Unset', 'Valid', 'NoData', 'NotFound')")
+        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 ServicingMemberSelectionDTO 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 ServicingMemberSelectionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "namePath": obj.get("namePath"),
+            "excluded": obj.get("excluded"),
+            "dimensionMemberStatus": obj.get("dimensionMemberStatus")
+        })
+        return _obj
+
+

visier_platform_sdk/models/servicing_objectconfiguration_calculated_property_type_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.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 ServicingObjectconfigurationCalculatedPropertyTypeDTO(BaseModel):
+    """
+    ServicingObjectconfigurationCalculatedPropertyTypeDTO
+    """ # noqa: E501
+    data_type: Optional[StrictStr] = Field(default=None, description="The data type of the property, such as Categorical, HourDuration, or Ratio.", alias="dataType")
+    formula: Optional[StrictStr] = Field(default=None, description="The formula used to calculate the property's value, written in Visier Formula Language.")
+    __properties: ClassVar[List[str]] = ["dataType", "formula"]
+
+    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 ServicingObjectconfigurationCalculatedPropertyTypeDTO 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 ServicingObjectconfigurationCalculatedPropertyTypeDTO 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"),
+            "formula": obj.get("formula")
+        })
+        return _obj
+
+