hotdata 0.0.1__py3-none-any.whl

hotdata/exceptions.py

@@ -0,0 +1,219 @@
+"""
+    Hotdata API
+
+    Powerful data platform API for datasets, queries, and analytics.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: developers@hotdata.dev
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

hotdata/models/__init__.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    Hotdata API
+
+    Powerful data platform API for datasets, queries, and analytics.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: developers@hotdata.dev
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from hotdata.models.api_error_detail import ApiErrorDetail
+from hotdata.models.api_error_response import ApiErrorResponse
+from hotdata.models.async_query_response import AsyncQueryResponse
+from hotdata.models.boolean_profile_detail import BooleanProfileDetail
+from hotdata.models.categorical_profile_detail import CategoricalProfileDetail
+from hotdata.models.category_value_info import CategoryValueInfo
+from hotdata.models.column_info import ColumnInfo
+from hotdata.models.column_profile_detail import ColumnProfileDetail
+from hotdata.models.column_profile_detail_one_of import ColumnProfileDetailOneOf
+from hotdata.models.column_profile_detail_one_of1 import ColumnProfileDetailOneOf1
+from hotdata.models.column_profile_detail_one_of2 import ColumnProfileDetailOneOf2
+from hotdata.models.column_profile_detail_one_of3 import ColumnProfileDetailOneOf3
+from hotdata.models.column_profile_detail_one_of4 import ColumnProfileDetailOneOf4
+from hotdata.models.column_profile_info import ColumnProfileInfo
+from hotdata.models.column_type_spec import ColumnTypeSpec
+from hotdata.models.connection_health_response import ConnectionHealthResponse
+from hotdata.models.connection_info import ConnectionInfo
+from hotdata.models.connection_refresh_result import ConnectionRefreshResult
+from hotdata.models.connection_schema_error import ConnectionSchemaError
+from hotdata.models.connection_type_detail import ConnectionTypeDetail
+from hotdata.models.connection_type_summary import ConnectionTypeSummary
+from hotdata.models.create_connection_request import CreateConnectionRequest
+from hotdata.models.create_connection_response import CreateConnectionResponse
+from hotdata.models.create_dataset_request import CreateDatasetRequest
+from hotdata.models.create_dataset_response import CreateDatasetResponse
+from hotdata.models.create_embedding_provider_request import CreateEmbeddingProviderRequest
+from hotdata.models.create_embedding_provider_response import CreateEmbeddingProviderResponse
+from hotdata.models.create_index_request import CreateIndexRequest
+from hotdata.models.create_saved_query_request import CreateSavedQueryRequest
+from hotdata.models.create_secret_request import CreateSecretRequest
+from hotdata.models.create_secret_response import CreateSecretResponse
+from hotdata.models.create_workspace_request import CreateWorkspaceRequest
+from hotdata.models.create_workspace_response import CreateWorkspaceResponse
+from hotdata.models.dataset_source import DatasetSource
+from hotdata.models.dataset_summary import DatasetSummary
+from hotdata.models.dataset_version_summary import DatasetVersionSummary
+from hotdata.models.discovery_status import DiscoveryStatus
+from hotdata.models.embedding_provider_response import EmbeddingProviderResponse
+from hotdata.models.error import Error
+from hotdata.models.execute_saved_query_request import ExecuteSavedQueryRequest
+from hotdata.models.get_connection_response import GetConnectionResponse
+from hotdata.models.get_dataset_response import GetDatasetResponse
+from hotdata.models.get_result_response import GetResultResponse
+from hotdata.models.get_secret_response import GetSecretResponse
+from hotdata.models.get_workspace_context_response import GetWorkspaceContextResponse
+from hotdata.models.index_info_response import IndexInfoResponse
+from hotdata.models.index_status import IndexStatus
+from hotdata.models.information_schema_response import InformationSchemaResponse
+from hotdata.models.inline_data import InlineData
+from hotdata.models.inline_dataset_source import InlineDatasetSource
+from hotdata.models.job_result import JobResult
+from hotdata.models.job_status import JobStatus
+from hotdata.models.job_status_response import JobStatusResponse
+from hotdata.models.job_type import JobType
+from hotdata.models.list_connection_types_response import ListConnectionTypesResponse
+from hotdata.models.list_connections_response import ListConnectionsResponse
+from hotdata.models.list_dataset_versions_response import ListDatasetVersionsResponse
+from hotdata.models.list_datasets_response import ListDatasetsResponse
+from hotdata.models.list_embedding_providers_response import ListEmbeddingProvidersResponse
+from hotdata.models.list_indexes_response import ListIndexesResponse
+from hotdata.models.list_jobs_response import ListJobsResponse
+from hotdata.models.list_query_runs_response import ListQueryRunsResponse
+from hotdata.models.list_results_response import ListResultsResponse
+from hotdata.models.list_saved_queries_response import ListSavedQueriesResponse
+from hotdata.models.list_saved_query_versions_response import ListSavedQueryVersionsResponse
+from hotdata.models.list_secrets_response import ListSecretsResponse
+from hotdata.models.list_uploads_response import ListUploadsResponse
+from hotdata.models.list_workspace_contexts_response import ListWorkspaceContextsResponse
+from hotdata.models.list_workspaces_response import ListWorkspacesResponse
+from hotdata.models.numeric_profile_detail import NumericProfileDetail
+from hotdata.models.query_request import QueryRequest
+from hotdata.models.query_response import QueryResponse
+from hotdata.models.query_run_info import QueryRunInfo
+from hotdata.models.refresh_dataset_response import RefreshDatasetResponse
+from hotdata.models.refresh_request import RefreshRequest
+from hotdata.models.refresh_response import RefreshResponse
+from hotdata.models.refresh_warning import RefreshWarning
+from hotdata.models.result_info import ResultInfo
+from hotdata.models.saved_query_dataset_source import SavedQueryDatasetSource
+from hotdata.models.saved_query_detail import SavedQueryDetail
+from hotdata.models.saved_query_summary import SavedQuerySummary
+from hotdata.models.saved_query_version_info import SavedQueryVersionInfo
+from hotdata.models.schema_refresh_result import SchemaRefreshResult
+from hotdata.models.secret_metadata_response import SecretMetadataResponse
+from hotdata.models.sql_query_dataset_source import SqlQueryDatasetSource
+from hotdata.models.submit_job_response import SubmitJobResponse
+from hotdata.models.table_info import TableInfo
+from hotdata.models.table_profile_response import TableProfileResponse
+from hotdata.models.table_refresh_error import TableRefreshError
+from hotdata.models.table_refresh_result import TableRefreshResult
+from hotdata.models.temporal_profile_detail import TemporalProfileDetail
+from hotdata.models.text_profile_detail import TextProfileDetail
+from hotdata.models.update_dataset_request import UpdateDatasetRequest
+from hotdata.models.update_dataset_response import UpdateDatasetResponse
+from hotdata.models.update_embedding_provider_request import UpdateEmbeddingProviderRequest
+from hotdata.models.update_embedding_provider_response import UpdateEmbeddingProviderResponse
+from hotdata.models.update_saved_query_request import UpdateSavedQueryRequest
+from hotdata.models.update_secret_request import UpdateSecretRequest
+from hotdata.models.update_secret_response import UpdateSecretResponse
+from hotdata.models.upload_dataset_source import UploadDatasetSource
+from hotdata.models.upload_info import UploadInfo
+from hotdata.models.upload_response import UploadResponse
+from hotdata.models.upsert_workspace_context_request import UpsertWorkspaceContextRequest
+from hotdata.models.upsert_workspace_context_response import UpsertWorkspaceContextResponse
+from hotdata.models.url_dataset_source import UrlDatasetSource
+from hotdata.models.workspace_context_entry import WorkspaceContextEntry
+from hotdata.models.workspace_detail import WorkspaceDetail
+from hotdata.models.workspace_list_item import WorkspaceListItem
+

hotdata/models/api_error_detail.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Hotdata API
+
+    Powerful data platform API for datasets, queries, and analytics.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: developers@hotdata.dev
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ApiErrorDetail(BaseModel):
+    """
+    Error detail within an API error response
+    """ # noqa: E501
+    code: StrictStr
+    message: StrictStr
+    __properties: ClassVar[List[str]] = ["code", "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 ApiErrorDetail 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 ApiErrorDetail from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "code": obj.get("code"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

hotdata/models/api_error_response.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    Hotdata API
+
+    Powerful data platform API for datasets, queries, and analytics.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: developers@hotdata.dev
+    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
+from typing import Any, ClassVar, Dict, List
+from hotdata.models.api_error_detail import ApiErrorDetail
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ApiErrorResponse(BaseModel):
+    """
+    Standard error response body
+    """ # noqa: E501
+    error: ApiErrorDetail
+    __properties: ClassVar[List[str]] = ["error"]
+
+    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 ApiErrorResponse 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 error
+        if self.error:
+            _dict['error'] = self.error.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ApiErrorResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "error": ApiErrorDetail.from_dict(obj["error"]) if obj.get("error") is not None else None
+        })
+        return _obj
+
+

hotdata/models/async_query_response.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Hotdata API
+
+    Powerful data platform API for datasets, queries, and analytics.
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: developers@hotdata.dev
+    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 AsyncQueryResponse(BaseModel):
+    """
+    Response returned when a query is submitted asynchronously (202 Accepted).  Poll GET /query-runs/{id} to track progress. Once status is \"succeeded\", retrieve results via GET /results/{result_id}.
+    """ # noqa: E501
+    query_run_id: StrictStr = Field(description="Unique identifier for the query run.")
+    reason: Optional[StrictStr] = Field(default=None, description="Human-readable reason why the query went async (e.g., caching tables for the first time).")
+    status: StrictStr = Field(description="Current status of the query run.")
+    status_url: StrictStr = Field(description="URL to poll for query run status.")
+    __properties: ClassVar[List[str]] = ["query_run_id", "reason", "status", "status_url"]
+
+    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 AsyncQueryResponse 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,
+        )
+        # set to None if reason (nullable) is None
+        # and model_fields_set contains the field
+        if self.reason is None and "reason" in self.model_fields_set:
+            _dict['reason'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AsyncQueryResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "query_run_id": obj.get("query_run_id"),
+            "reason": obj.get("reason"),
+            "status": obj.get("status"),
+            "status_url": obj.get("status_url")
+        })
+        return _obj
+
+