visier-platform-sdk 22222222.99201.2243__py3-none-any.whl → 22222222.99201.2263__py3-none-any.whl

visier_platform_sdk/models/sql_source_query_action_dto.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.2263
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.sql_source_query_output_dto import SqlSourceQueryOutputDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceQueryActionDTO(BaseModel):
+    """
+    A query action. Executes the specified SQL query within the tenant's context.
+    """ # noqa: E501
+    query: Optional[StrictStr] = Field(default=None, description="The SQL query to execute.")
+    timeout_seconds: Optional[StrictInt] = Field(default=None, description="The maximum amount of time (in seconds) to run the query for before cancelling it.", alias="timeoutSeconds")
+    output: Optional[SqlSourceQueryOutputDTO] = Field(default=None, description="The output configuration for the query, if desired.")
+    rollback_on_empty: Optional[StrictBool] = Field(default=None, description="If `true`, the transaction rolls back if the query returns no rows. Use this to implement a validation step.", alias="rollbackOnEmpty")
+    __properties: ClassVar[List[str]] = ["query", "timeoutSeconds", "output", "rollbackOnEmpty"]
+
+    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 SqlSourceQueryActionDTO 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 output
+        if self.output:
+            _dict['output'] = self.output.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceQueryActionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query": obj.get("query"),
+            "timeoutSeconds": obj.get("timeoutSeconds"),
+            "output": SqlSourceQueryOutputDTO.from_dict(obj["output"]) if obj.get("output") is not None else None,
+            "rollbackOnEmpty": obj.get("rollbackOnEmpty")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_query_output_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.99201.2263
+    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.sql_source_io_format_dto import SqlSourceIoFormatDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceQueryOutputDTO(BaseModel):
+    """
+    Output configuration for a query. If specified, query output will be written to a file that can be retrieved later.
+    """ # noqa: E501
+    format: Optional[SqlSourceIoFormatDTO] = Field(default=None, description="The format to write the output in.")
+    filename: Optional[StrictStr] = Field(default=None, description="The filename to write the output to.")
+    __properties: ClassVar[List[str]] = ["format", "filename"]
+
+    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 SqlSourceQueryOutputDTO 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 format
+        if self.format:
+            _dict['format'] = self.format.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceQueryOutputDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "format": SqlSourceIoFormatDTO.from_dict(obj["format"]) if obj.get("format") is not None else None,
+            "filename": obj.get("filename")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_replace_action_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.2263
+    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 SqlSourceReplaceActionDTO(BaseModel):
+    """
+    A replace action. Replaces all rows in the target table with the rows in the source table.  Preserves rows that exist in both the source and the target.
+    """ # noqa: E501
+    source: Optional[StrictStr] = Field(default=None, description="The SQL table (identifier) containing rows to replace.")
+    target: Optional[StrictStr] = Field(default=None, description="The SQL table (identifier) to replace the rows in.")
+    __properties: ClassVar[List[str]] = ["source", "target"]
+
+    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 SqlSourceReplaceActionDTO 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 SqlSourceReplaceActionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "source": obj.get("source"),
+            "target": obj.get("target")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_table_dto.py

@@ -0,0 +1,110 @@
+# 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.2263
+    Contact: alpine@visier.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.basic_information_dto import BasicInformationDTO
+from visier_platform_sdk.models.sql_source_column_dto import SqlSourceColumnDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceTableDTO(BaseModel):
+    """
+    SqlSourceTableDTO
+    """ # noqa: E501
+    uuid: Optional[StrictStr] = Field(default=None, description="The unique identifier for the table. This UUID is generated automatically when the table is created and cannot be changed.  Do not provide a value when creating a new table.")
+    object_name: Optional[StrictStr] = Field(default=None, description="The object name for the table. This determines the name of the table accessible from SQL.", alias="objectName")
+    basic_information: Optional[BasicInformationDTO] = Field(default=None, description="Fields that identify and describe the table, such as its display name, description, and explanation.", alias="basicInformation")
+    columns: Optional[List[SqlSourceColumnDTO]] = Field(default=None, description="The columns contained within the table.")
+    can_children_inherit: Optional[StrictBool] = Field(default=None, description="If `true`, analytic tenants inherit the table definition. To also inherit the table data, set `canChildrenInheritData` to `true`. Default is `false`.", alias="canChildrenInherit")
+    can_children_inherit_data: Optional[StrictBool] = Field(default=None, description="If `true`, analytic tenants inherit the table data. Analytic tenants can read the data but cannot write to it. Default is `false`.", alias="canChildrenInheritData")
+    __properties: ClassVar[List[str]] = ["uuid", "objectName", "basicInformation", "columns", "canChildrenInherit", "canChildrenInheritData"]
+
+    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 SqlSourceTableDTO 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 basic_information
+        if self.basic_information:
+            _dict['basicInformation'] = self.basic_information.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
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceTableDTO 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"),
+            "basicInformation": BasicInformationDTO.from_dict(obj["basicInformation"]) if obj.get("basicInformation") is not None else None,
+            "columns": [SqlSourceColumnDTO.from_dict(_item) for _item in obj["columns"]] if obj.get("columns") is not None else None,
+            "canChildrenInherit": obj.get("canChildrenInherit"),
+            "canChildrenInheritData": obj.get("canChildrenInheritData")
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_table_list_response_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.2263
+    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.sql_source_table_dto import SqlSourceTableDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SqlSourceTableListResponseDTO(BaseModel):
+    """
+    SqlSourceTableListResponseDTO
+    """ # noqa: E501
+    tables: Optional[List[SqlSourceTableDTO]] = Field(default=None, description="The list of tables.")
+    __properties: ClassVar[List[str]] = ["tables"]
+
+    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 SqlSourceTableListResponseDTO 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 tables (list)
+        _items = []
+        if self.tables:
+            for _item_tables in self.tables:
+                if _item_tables:
+                    _items.append(_item_tables.to_dict())
+            _dict['tables'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SqlSourceTableListResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tables": [SqlSourceTableDTO.from_dict(_item) for _item in obj["tables"]] if obj.get("tables") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/sql_source_transaction_state_dto.py

@@ -0,0 +1,112 @@
+# 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.2263
+    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 SqlSourceTransactionStateDTO(BaseModel):
+    """
+    SqlSourceTransactionStateDTO
+    """ # noqa: E501
+    transaction_id: Optional[StrictStr] = Field(default=None, description="The transaction ID.", alias="transactionId")
+    status: Optional[StrictStr] = Field(default=None, description="The current status of the transaction.  * `UNSPECIFIED`: The transaction is in an unspecified state.  * `OPEN`: The transaction is open and can accept new actions.  * `CLOSED`: The transaction is closed and cannot accept new actions.  * `COMMITTED`: The transaction has been committed and is closed.  * `ROLLED_BACK`: The transaction has been rolled back and is closed.")
+    created_at: Optional[StrictStr] = Field(default=None, description="The timestamp when the transaction was created in ISO 8601 format.", alias="createdAt")
+    created_by: Optional[StrictStr] = Field(default=None, description="The name of the user who created the transaction.", alias="createdBy")
+    expire_at: Optional[StrictStr] = Field(default=None, description="The timestamp when the transaction will expire in ISO 8601 format.", alias="expireAt")
+    started_at: Optional[StrictStr] = Field(default=None, description="The timestamp when work began on the transaction in ISO 8601 format.", alias="startedAt")
+    closed_at: Optional[StrictStr] = Field(default=None, description="The timestamp when the transaction was closed in ISO 8601 format.", alias="closedAt")
+    tables_to_modify: Optional[List[StrictStr]] = Field(default=None, description="The tables to modify in the transaction.", alias="tablesToModify")
+    __properties: ClassVar[List[str]] = ["transactionId", "status", "createdAt", "createdBy", "expireAt", "startedAt", "closedAt", "tablesToModify"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['UNSPECIFIED', 'OPEN', 'CLOSED', 'COMMITTED', 'ROLLED_BACK']):
+            raise ValueError("must be one of enum values ('UNSPECIFIED', 'OPEN', 'CLOSED', 'COMMITTED', 'ROLLED_BACK')")
+        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 SqlSourceTransactionStateDTO 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 SqlSourceTransactionStateDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "transactionId": obj.get("transactionId"),
+            "status": obj.get("status"),
+            "createdAt": obj.get("createdAt"),
+            "createdBy": obj.get("createdBy"),
+            "expireAt": obj.get("expireAt"),
+            "startedAt": obj.get("startedAt"),
+            "closedAt": obj.get("closedAt"),
+            "tablesToModify": obj.get("tablesToModify")
+        })
+        return _obj
+
+