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

visier_platform_sdk/models/snapshot_query_execution_dto.py

@@ -0,0 +1,144 @@
+# 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.list_query_source_dto import ListQuerySourceDTO
+from visier_platform_sdk.models.property_column_dto import PropertyColumnDTO
+from visier_platform_sdk.models.query_filter_dto import QueryFilterDTO
+from visier_platform_sdk.models.query_parameter_value_dto import QueryParameterValueDTO
+from visier_platform_sdk.models.query_time_intervals_dto import QueryTimeIntervalsDTO
+from visier_platform_sdk.models.snapshot_query_execution_options_dto import SnapshotQueryExecutionOptionsDTO
+from visier_platform_sdk.models.sort_option_dto import SortOptionDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SnapshotQueryExecutionDTO(BaseModel):
+    """
+    SnapshotQueryExecutionDTO
+    """ # noqa: E501
+    source: Optional[ListQuerySourceDTO] = Field(default=None, description="The source data that you want to query.")
+    columns: Optional[List[PropertyColumnDTO]] = Field(default=None, description="The columns to include in the result. This must contain at least one column.")
+    sort_options: Optional[List[SortOptionDTO]] = Field(default=None, description="The index and direction to sort a column in the `columns` array.", alias="sortOptions")
+    filters: Optional[List[QueryFilterDTO]] = Field(default=None, description="The filters of this query. Omit `filters` if no filtering is required.")
+    time_intervals: Optional[QueryTimeIntervalsDTO] = Field(default=None, description="The time intervals to query.", alias="timeIntervals")
+    parameter_values: Optional[List[QueryParameterValueDTO]] = Field(default=None, description="The parameter values for either member or numeric parameters.", alias="parameterValues")
+    options: Optional[SnapshotQueryExecutionOptionsDTO] = Field(default=None, description="Additional instructions for your query, such as a calendar type or conversion information.")
+    __properties: ClassVar[List[str]] = ["source", "columns", "sortOptions", "filters", "timeIntervals", "parameterValues", "options"]
+
+    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 SnapshotQueryExecutionDTO 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 source
+        if self.source:
+            _dict['source'] = self.source.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in columns (list)
+        _items = []
+        if self.columns:
+            for _item_columns in self.columns:
+                if _item_columns:
+                    _items.append(_item_columns.to_dict())
+            _dict['columns'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in sort_options (list)
+        _items = []
+        if self.sort_options:
+            for _item_sort_options in self.sort_options:
+                if _item_sort_options:
+                    _items.append(_item_sort_options.to_dict())
+            _dict['sortOptions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in filters (list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(_item_filters.to_dict())
+            _dict['filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of time_intervals
+        if self.time_intervals:
+            _dict['timeIntervals'] = self.time_intervals.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in parameter_values (list)
+        _items = []
+        if self.parameter_values:
+            for _item_parameter_values in self.parameter_values:
+                if _item_parameter_values:
+                    _items.append(_item_parameter_values.to_dict())
+            _dict['parameterValues'] = _items
+        # override the default output from pydantic by calling `to_dict()` of options
+        if self.options:
+            _dict['options'] = self.options.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SnapshotQueryExecutionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "source": ListQuerySourceDTO.from_dict(obj["source"]) if obj.get("source") is not None else None,
+            "columns": [PropertyColumnDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None,
+            "sortOptions": [SortOptionDTO.from_dict(_item) for _item in obj["sortOptions"]] if obj.get("sortOptions") is not None else None,
+            "filters": [QueryFilterDTO.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None,
+            "timeIntervals": QueryTimeIntervalsDTO.from_dict(obj["timeIntervals"]) if obj.get("timeIntervals") is not None else None,
+            "parameterValues": [QueryParameterValueDTO.from_dict(_item) for _item in obj["parameterValues"]] if obj.get("parameterValues") is not None else None,
+            "options": SnapshotQueryExecutionOptionsDTO.from_dict(obj["options"]) if obj.get("options") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/snapshot_query_execution_options_dto.py

@@ -0,0 +1,134 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SnapshotQueryExecutionOptionsDTO(BaseModel):
+    """
+    A SnapshotQueryExecutionOptions provides additional instructions to perform a snapshot query.
+    """ # noqa: E501
+    limit: Optional[StrictInt] = Field(default=None, description="The maximum number of entries to return. Default is to return all entries. If `page` is defined but  limit is not defined, limit will be set to a default value of 1000.")
+    query_mode: Optional[StrictStr] = Field(default=None, description="Determines how the query should handle column definitions that the query is unable to resolve. Default is DEFAULT.", alias="queryMode")
+    omit_header: Optional[StrictBool] = Field(default=None, description="Option to omit the header from the result.  If true, queryMode must be either FILL or FAIL.  Default is false.", alias="omitHeader")
+    calendar_type: Optional[StrictStr] = Field(default=None, description="The calendar type to use. This will be used for all time calculations unless explicitly overridden in  the calculation itself. Default is TENANT_CALENDAR.", alias="calendarType")
+    currency_conversion_date: Optional[StrictStr] = Field(default=None, description="The currency conversion date to use. If defined, the currency conversion will use the exchange rates as of this date.", alias="currencyConversionDate")
+    page: Optional[StrictInt] = Field(default=None, description="A page defines a subset of the overall result set. The number of rows per page is equal to limit  with the exception of the last page in the result set which may contain fewer rows. `Page` is an index  that begins at 0. The index to start retrieving results is calculated by multiplying `page` by `limit`.")
+    multiple_tables: Optional[StrictBool] = Field(default=None, description="Option to return multiple table files as zipped archive for derived metrics.  Default is false. If false, one table is returned for the drill-through metric.", alias="multipleTables")
+    currency_conversion_code: Optional[StrictStr] = Field(default=None, description="The optional target currency for all currency conversions.  If not specified, the tenant default currency will be used.", alias="currencyConversionCode")
+    date_time_display_mode: Optional[StrictStr] = Field(default=None, description="Control how date-time values are displayed in the result set.  Supported values:  * `EPOCH`: The number of elapsed milliseconds since January 1, 1970 in UTC timezone. This is the default.  * `DATETIME`: The date-time value displayed in `yyyy-MM-dd HH:mm:ssZZ` format.", alias="dateTimeDisplayMode")
+    __properties: ClassVar[List[str]] = ["limit", "queryMode", "omitHeader", "calendarType", "currencyConversionDate", "page", "multipleTables", "currencyConversionCode", "dateTimeDisplayMode"]
+
+    @field_validator('query_mode')
+    def query_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEFAULT', 'FILL', 'FAIL']):
+            raise ValueError("must be one of enum values ('DEFAULT', 'FILL', 'FAIL')")
+        return value
+
+    @field_validator('calendar_type')
+    def calendar_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['TENANT_CALENDAR', 'GREGORIAN_CALENDAR']):
+            raise ValueError("must be one of enum values ('TENANT_CALENDAR', 'GREGORIAN_CALENDAR')")
+        return value
+
+    @field_validator('date_time_display_mode')
+    def date_time_display_mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['EPOCH', 'DATETIME']):
+            raise ValueError("must be one of enum values ('EPOCH', 'DATETIME')")
+        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 SnapshotQueryExecutionOptionsDTO 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 SnapshotQueryExecutionOptionsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "limit": obj.get("limit"),
+            "queryMode": obj.get("queryMode"),
+            "omitHeader": obj.get("omitHeader"),
+            "calendarType": obj.get("calendarType"),
+            "currencyConversionDate": obj.get("currencyConversionDate"),
+            "page": obj.get("page"),
+            "multipleTables": obj.get("multipleTables"),
+            "currencyConversionCode": obj.get("currencyConversionCode"),
+            "dateTimeDisplayMode": obj.get("dateTimeDisplayMode")
+        })
+        return _obj
+
+

visier_platform_sdk/models/snowflake_auth_params_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 typing import Optional, Set
+from typing_extensions import Self
+
+class SnowflakeAuthParamsDTO(BaseModel):
+    """
+    SnowflakeAuthParamsDTO
+    """ # noqa: E501
+    account_identifier: Optional[StrictStr] = Field(default=None, alias="accountIdentifier")
+    database: Optional[StrictStr] = None
+    var_schema: Optional[StrictStr] = Field(default=None, alias="schema")
+    username: Optional[StrictStr] = None
+    password: Optional[StrictStr] = None
+    warehouse: Optional[StrictStr] = None
+    private_key: Optional[StrictStr] = Field(default=None, alias="privateKey")
+    __properties: ClassVar[List[str]] = ["accountIdentifier", "database", "schema", "username", "password", "warehouse", "privateKey"]
+
+    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 SnowflakeAuthParamsDTO 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 SnowflakeAuthParamsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accountIdentifier": obj.get("accountIdentifier"),
+            "database": obj.get("database"),
+            "schema": obj.get("schema"),
+            "username": obj.get("username"),
+            "password": obj.get("password"),
+            "warehouse": obj.get("warehouse"),
+            "privateKey": obj.get("privateKey")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sort_option_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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SortOptionDTO(BaseModel):
+    """
+    Sort option for a column of a list query.
+    """ # noqa: E501
+    column_index: Optional[StrictInt] = Field(default=None, description="The index of the column of the list query, staring from 0.", alias="columnIndex")
+    sort_direction: Optional[StrictStr] = Field(default=None, description="The sort direction.", alias="sortDirection")
+    __properties: ClassVar[List[str]] = ["columnIndex", "sortDirection"]
+
+    @field_validator('sort_direction')
+    def sort_direction_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SORT_ASCENDING', 'SORT_DESCENDING']):
+            raise ValueError("must be one of enum values ('SORT_ASCENDING', 'SORT_DESCENDING')")
+        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 SortOptionDTO 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 SortOptionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "columnIndex": obj.get("columnIndex"),
+            "sortDirection": obj.get("sortDirection")
+        })
+        return _obj
+
+

visier_platform_sdk/models/source.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.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 Source(BaseModel):
+    """
+    Source
+    """ # noqa: E501
+    source_id: Optional[StrictStr] = Field(default=None, description="The unique identifier associated with the source that data was transferred to.", alias="sourceId")
+    source_name: Optional[StrictStr] = Field(default=None, description="The object name of the source.", alias="sourceName")
+    data_size: Optional[StrictStr] = Field(default=None, description="The size of the data transfer in bytes.", alias="dataSize")
+    rows: Optional[StrictStr] = Field(default=None, description="The number of rows in the data transfer.")
+    status: Optional[StrictStr] = Field(default=None, description="The status of the data transfer for this source.")
+    message: Optional[StrictStr] = Field(default=None, description="A meaningful message about the data transfer.")
+    __properties: ClassVar[List[str]] = ["sourceId", "sourceName", "dataSize", "rows", "status", "message"]
+
+    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 Source 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 Source from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceId": obj.get("sourceId"),
+            "sourceName": obj.get("sourceName"),
+            "dataSize": obj.get("dataSize"),
+            "rows": obj.get("rows"),
+            "status": obj.get("status"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sources_api_operation_request_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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.clone_files_into_source_parameters_dto import CloneFilesIntoSourceParametersDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SourcesAPIOperationRequestDTO(BaseModel):
+    """
+    SourcesAPIOperationRequestDTO
+    """ # noqa: E501
+    operation: Optional[StrictStr] = Field(default=None, description="The operation to perform. Valid values:  * `exportSources`: Export all sources from the tenant. If successful, returns a ZIP file containing a compressed JSON file with the sources.  * `cloneFilesIntoSource`: Clone a source's files into a different source. If successful, returns a receiving job ID. Use the job ID to monitor the cloning results.")
+    clone_files_into_source_parameters: Optional[CloneFilesIntoSourceParametersDTO] = Field(default=None, description="The parameters for the `cloneFilesIntoSource` option, such as the source to clone files from, the source to clone files into, and the date range of the files to clone.", alias="cloneFilesIntoSourceParameters")
+    __properties: ClassVar[List[str]] = ["operation", "cloneFilesIntoSourceParameters"]
+
+    @field_validator('operation')
+    def operation_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['unknownSourcesAPIOperation', 'exportSources', 'cloneFilesIntoSource']):
+            raise ValueError("must be one of enum values ('unknownSourcesAPIOperation', 'exportSources', 'cloneFilesIntoSource')")
+        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 SourcesAPIOperationRequestDTO 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 clone_files_into_source_parameters
+        if self.clone_files_into_source_parameters:
+            _dict['cloneFilesIntoSourceParameters'] = self.clone_files_into_source_parameters.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SourcesAPIOperationRequestDTO 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"),
+            "cloneFilesIntoSourceParameters": CloneFilesIntoSourceParametersDTO.from_dict(obj["cloneFilesIntoSourceParameters"]) if obj.get("cloneFilesIntoSourceParameters") is not None else None
+        })
+        return _obj
+
+