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

visier_platform_sdk/models/servicing_project_dto.py

@@ -1,111 +0,0 @@
-# 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, StrictInt, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ServicingProjectDTO(BaseModel):
-    """
-    ServicingProjectDTO
-    """ # noqa: E501
-    id: Optional[StrictStr] = Field(default=None, description="The unique ID of the project. Omit when creating a new project.")
-    name: Optional[StrictStr] = Field(default=None, description="An identifiable project name to display in Visier.")
-    description: Optional[StrictStr] = Field(default=None, description="A description of the project.")
-    release_version: Optional[StrictStr] = Field(default=None, description="The release version of the project.", alias="releaseVersion")
-    ticket_number: Optional[StrictStr] = Field(default=None, description="The change management ticket number of the project.", alias="ticketNumber")
-    version_number: Optional[StrictInt] = Field(default=None, description="The version number of the project.", alias="versionNumber")
-    capabilities: Optional[List[StrictStr]] = Field(default=None, description="The current user's capabilities for the project. Users with `canWrite`, `canShare`, or `owner` capabilities can add and commit changes to the project.  **canRead**: The project has been shared to the user with `View` access.  **canWrite**: The project has been shared to the user with `Edit` access.  **canShare**: The project has been shared to the user with `Share` access.  **owner**: The user is the owner of the project.  Omit when creating a new project.")
-    __properties: ClassVar[List[str]] = ["id", "name", "description", "releaseVersion", "ticketNumber", "versionNumber", "capabilities"]
-
-    @field_validator('capabilities')
-    def capabilities_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        for i in value:
-            if i not in set(['canRead', 'canWrite', 'canShare', 'owner']):
-                raise ValueError("each list item must be one of ('canRead', 'canWrite', 'canShare', 'owner')")
-        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 ServicingProjectDTO 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 ServicingProjectDTO 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"),
-            "name": obj.get("name"),
-            "description": obj.get("description"),
-            "releaseVersion": obj.get("releaseVersion"),
-            "ticketNumber": obj.get("ticketNumber"),
-            "versionNumber": obj.get("versionNumber"),
-            "capabilities": obj.get("capabilities")
-        })
-        return _obj
-
-

visier_platform_sdk/models/servicing_project_operation_request_dto.py

@@ -1,98 +0,0 @@
-# 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, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ServicingProjectOperationRequestDTO(BaseModel):
-    """
-    ServicingProjectOperationRequestDTO
-    """ # noqa: E501
-    operation: Optional[StrictStr] = Field(default=None, description="The operation to perform on a draft project. Valid values:  * `commitAndPublish`: Commits the requesting user's changes and publishes the draft project to production.")
-    __properties: ClassVar[List[str]] = ["operation"]
-
-    @field_validator('operation')
-    def operation_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['unknown', 'commitAndPublish']):
-            raise ValueError("must be one of enum values ('unknown', 'commitAndPublish')")
-        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 ServicingProjectOperationRequestDTO 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 ServicingProjectOperationRequestDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "operation": obj.get("operation")
-        })
-        return _obj
-
-

visier_platform_sdk/models/servicing_project_operation_response_dto.py

@@ -1,92 +0,0 @@
-# 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.servicing_commit_and_publish_operation_response_dto import ServicingCommitAndPublishOperationResponseDTO
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ServicingProjectOperationResponseDTO(BaseModel):
-    """
-    ServicingProjectOperationResponseDTO
-    """ # noqa: E501
-    commit_and_publish: Optional[ServicingCommitAndPublishOperationResponseDTO] = Field(default=None, description="The result of the `commitAndPublish` operation.", alias="commitAndPublish")
-    __properties: ClassVar[List[str]] = ["commitAndPublish"]
-
-    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 ServicingProjectOperationResponseDTO 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 commit_and_publish
-        if self.commit_and_publish:
-            _dict['commitAndPublish'] = self.commit_and_publish.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ServicingProjectOperationResponseDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "commitAndPublish": ServicingCommitAndPublishOperationResponseDTO.from_dict(obj["commitAndPublish"]) if obj.get("commitAndPublish") is not None else None
-        })
-        return _obj
-
-

visier_platform_sdk/models/servicing_property_access_config_dto.py

@@ -1,116 +0,0 @@
-# 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, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ServicingPropertyAccessConfigDTO(BaseModel):
-    """
-    ServicingPropertyAccessConfigDTO
-    """ # noqa: E501
-    property_id: Optional[StrictStr] = Field(default=None, description="The property ID associated with the property access configuration.", alias="propertyId")
-    analytic_object_id: Optional[StrictStr] = Field(default=None, description="The analytic object ID of the property.", alias="analyticObjectId")
-    analytic_object_reference_paths: Optional[List[StrictStr]] = Field(default=None, description="The path to the analytic object reference. Empty if the configuration is not a reference.", alias="analyticObjectReferencePaths")
-    access_level: Optional[StrictStr] = Field(default=None, description="The access level of the property. Valid values are: `Aggregate`, `Detailed`.  * **Aggregate**: The property can only be accessed as part of an aggregate.  * **Detailed**: The property can be accessed at a detailed level.", alias="accessLevel")
-    property_status: Optional[StrictStr] = Field(default=None, description="The property's validity status. Valid values: `Valid`, `NoData`, `NotFound`.  * **Valid**: The object exists and has loaded data.  * **NoData**: The object exists but doesn't have loaded data.  * **NotFound**: The object doesn't exist.", alias="propertyStatus")
-    __properties: ClassVar[List[str]] = ["propertyId", "analyticObjectId", "analyticObjectReferencePaths", "accessLevel", "propertyStatus"]
-
-    @field_validator('access_level')
-    def access_level_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['None', 'Aggregate', 'Detailed']):
-            raise ValueError("must be one of enum values ('None', 'Aggregate', 'Detailed')")
-        return value
-
-    @field_validator('property_status')
-    def property_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 ServicingPropertyAccessConfigDTO 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 ServicingPropertyAccessConfigDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "propertyId": obj.get("propertyId"),
-            "analyticObjectId": obj.get("analyticObjectId"),
-            "analyticObjectReferencePaths": obj.get("analyticObjectReferencePaths"),
-            "accessLevel": obj.get("accessLevel"),
-            "propertyStatus": obj.get("propertyStatus")
-        })
-        return _obj
-
-

visier_platform_sdk/models/servicing_property_set_config_dto.py

@@ -1,102 +0,0 @@
-# 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.servicing_property_access_config_dto import ServicingPropertyAccessConfigDTO
-from visier_platform_sdk.models.servicing_shareable_data_access_set import ServicingShareableDataAccessSet
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ServicingPropertySetConfigDTO(BaseModel):
-    """
-    ServicingPropertySetConfigDTO
-    """ # noqa: E501
-    property_access_configs: Optional[List[ServicingPropertyAccessConfigDTO]] = Field(default=None, description="The data access for a property.", alias="propertyAccessConfigs")
-    shareable_data_access_set: Optional[ServicingShareableDataAccessSet] = Field(default=None, description="A shareable data access set. Shareable data access sets may be linked in multiple permissions.", alias="shareableDataAccessSet")
-    __properties: ClassVar[List[str]] = ["propertyAccessConfigs", "shareableDataAccessSet"]
-
-    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 ServicingPropertySetConfigDTO 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 property_access_configs (list)
-        _items = []
-        if self.property_access_configs:
-            for _item_property_access_configs in self.property_access_configs:
-                if _item_property_access_configs:
-                    _items.append(_item_property_access_configs.to_dict())
-            _dict['propertyAccessConfigs'] = _items
-        # override the default output from pydantic by calling `to_dict()` of shareable_data_access_set
-        if self.shareable_data_access_set:
-            _dict['shareableDataAccessSet'] = self.shareable_data_access_set.to_dict()
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ServicingPropertySetConfigDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "propertyAccessConfigs": [ServicingPropertyAccessConfigDTO.from_dict(_item) for _item in obj["propertyAccessConfigs"]] if obj.get("propertyAccessConfigs") is not None else None,
-            "shareableDataAccessSet": ServicingShareableDataAccessSet.from_dict(obj["shareableDataAccessSet"]) if obj.get("shareableDataAccessSet") is not None else None
-        })
-        return _obj
-
-

visier_platform_sdk/models/servicing_question_categories_api_response_dto.py

@@ -1,96 +0,0 @@
-# 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.servicing_question_category_api_response_dto import ServicingQuestionCategoryAPIResponseDTO
-from typing import Optional, Set
-from typing_extensions import Self
-
-class ServicingQuestionCategoriesAPIResponseDTO(BaseModel):
-    """
-    ServicingQuestionCategoriesAPIResponseDTO
-    """ # noqa: E501
-    categories: Optional[List[ServicingQuestionCategoryAPIResponseDTO]] = Field(default=None, description="A list of available categories for Vee sample questions.")
-    __properties: ClassVar[List[str]] = ["categories"]
-
-    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 ServicingQuestionCategoriesAPIResponseDTO 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 categories (list)
-        _items = []
-        if self.categories:
-            for _item_categories in self.categories:
-                if _item_categories:
-                    _items.append(_item_categories.to_dict())
-            _dict['categories'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of ServicingQuestionCategoriesAPIResponseDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "categories": [ServicingQuestionCategoryAPIResponseDTO.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None
-        })
-        return _obj
-
-