arthur-client 1.4.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

arthur_client/api_bindings/models/connector_check_result.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 arthur_client.api_bindings.models.connector_check_outcome import ConnectorCheckOutcome
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorCheckResult(BaseModel):
+    """
+    ConnectorCheckResult
+    """ # noqa: E501
+    connection_check_outcome: ConnectorCheckOutcome = Field(description="Result of the connector check.")
+    failure_reason: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["connection_check_outcome", "failure_reason"]
+
+    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 ConnectorCheckResult 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 failure_reason (nullable) is None
+        # and model_fields_set contains the field
+        if self.failure_reason is None and "failure_reason" in self.model_fields_set:
+            _dict['failure_reason'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectorCheckResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connection_check_outcome": obj.get("connection_check_outcome"),
+            "failure_reason": obj.get("failure_reason")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_field_data_type.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class ConnectorFieldDataType(str, Enum):
+    """
+    ConnectorFieldDataType
+    """
+
+    """
+    allowed enum values
+    """
+    STRING = 'string'
+    DICT = 'dict'
+    ENUM = 'enum'
+    INT = 'int'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ConnectorFieldDataType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/connector_pagination_options.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorPaginationOptions(BaseModel):
+    """
+    ConnectorPaginationOptions
+    """ # noqa: E501
+    page: Optional[Annotated[int, Field(strict=True, ge=1)]] = 1
+    page_size: Optional[Annotated[int, Field(le=500, strict=True)]] = 25
+    __properties: ClassVar[List[str]] = ["page", "page_size"]
+
+    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 ConnectorPaginationOptions 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 ConnectorPaginationOptions from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "page": obj.get("page") if obj.get("page") is not None else 1,
+            "page_size": obj.get("page_size") if obj.get("page_size") is not None else 25
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_spec.py

@@ -0,0 +1,135 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.connector_check_result import ConnectorCheckResult
+from arthur_client.api_bindings.models.connector_spec_field_with_metadata import ConnectorSpecFieldWithMetadata
+from arthur_client.api_bindings.models.connector_type import ConnectorType
+from arthur_client.api_bindings.models.user import User
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpec(BaseModel):
+    """
+    ConnectorSpec
+    """ # noqa: E501
+    created_at: datetime = Field(description="Time of record creation.")
+    updated_at: datetime = Field(description="Time of last record update.")
+    id: StrictStr = Field(description="Connector id.")
+    connector_type: ConnectorType = Field(description="Type of connector.")
+    name: StrictStr = Field(description="Name of connector.")
+    temporary: StrictBool = Field(description="True if connector is temporary (ie for testing only), false otherwise.")
+    fields: List[ConnectorSpecFieldWithMetadata] = Field(description="List of fields for the connector.")
+    last_updated_by_user: Optional[User] = None
+    connector_check_result: Optional[ConnectorCheckResult] = None
+    project_id: StrictStr = Field(description="ID of parent project.")
+    data_plane_id: StrictStr = Field(description="ID of the data plane that will execute the connection. Should be formatted as a UUID.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "connector_type", "name", "temporary", "fields", "last_updated_by_user", "connector_check_result", "project_id", "data_plane_id"]
+
+    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 ConnectorSpec 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 fields (list)
+        _items = []
+        if self.fields:
+            for _item_fields in self.fields:
+                if _item_fields:
+                    _items.append(_item_fields.to_dict())
+            _dict['fields'] = _items
+        # override the default output from pydantic by calling `to_dict()` of last_updated_by_user
+        if self.last_updated_by_user:
+            _dict['last_updated_by_user'] = self.last_updated_by_user.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of connector_check_result
+        if self.connector_check_result:
+            _dict['connector_check_result'] = self.connector_check_result.to_dict()
+        # set to None if last_updated_by_user (nullable) is None
+        # and model_fields_set contains the field
+        if self.last_updated_by_user is None and "last_updated_by_user" in self.model_fields_set:
+            _dict['last_updated_by_user'] = None
+
+        # set to None if connector_check_result (nullable) is None
+        # and model_fields_set contains the field
+        if self.connector_check_result is None and "connector_check_result" in self.model_fields_set:
+            _dict['connector_check_result'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectorSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "id": obj.get("id"),
+            "connector_type": obj.get("connector_type"),
+            "name": obj.get("name"),
+            "temporary": obj.get("temporary"),
+            "fields": [ConnectorSpecFieldWithMetadata.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "last_updated_by_user": User.from_dict(obj["last_updated_by_user"]) if obj.get("last_updated_by_user") is not None else None,
+            "connector_check_result": ConnectorCheckResult.from_dict(obj["connector_check_result"]) if obj.get("connector_check_result") is not None else None,
+            "project_id": obj.get("project_id"),
+            "data_plane_id": obj.get("data_plane_id")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_spec_field.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecField(BaseModel):
+    """
+    ConnectorSpecField
+    """ # noqa: E501
+    key: StrictStr = Field(description="Name of connector field.")
+    value: StrictStr = Field(description="Value of connector field.")
+    __properties: ClassVar[List[str]] = ["key", "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 ConnectorSpecField 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 ConnectorSpecField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_spec_field_with_metadata.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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
+from arthur_client.api_bindings.models.connector_field_data_type import ConnectorFieldDataType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecFieldWithMetadata(BaseModel):
+    """
+    ConnectorSpecFieldWithMetadata
+    """ # noqa: E501
+    key: StrictStr = Field(description="Name of connector field.")
+    value: StrictStr = Field(description="Value of connector field.")
+    d_type: ConnectorFieldDataType = Field(description="Data type of connector field.")
+    is_sensitive: StrictBool = Field(description="Whether or not this is a sensitive field.")
+    __properties: ClassVar[List[str]] = ["key", "value", "d_type", "is_sensitive"]
+
+    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 ConnectorSpecFieldWithMetadata 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 ConnectorSpecFieldWithMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "value": obj.get("value"),
+            "d_type": obj.get("d_type"),
+            "is_sensitive": obj.get("is_sensitive")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_spec_schema.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.connector_spec_schema_field import ConnectorSpecSchemaField
+from arthur_client.api_bindings.models.connector_type import ConnectorType
+from arthur_client.api_bindings.models.dataset_locator_schema import DatasetLocatorSchema
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecSchema(BaseModel):
+    """
+    ConnectorSpecSchema
+    """ # noqa: E501
+    created_at: datetime = Field(description="Time of record creation.")
+    updated_at: datetime = Field(description="Time of last record update.")
+    connector_type: ConnectorType = Field(description="Connector type for the schema. Must be unique.")
+    fields: List[ConnectorSpecSchemaField] = Field(description="Metadata for optional and required connector fields.")
+    dataset_locator_schema: DatasetLocatorSchema = Field(description="Schema with dataset locator metadata for all datasets using the connector type.")
+    supports_dataset_listing: StrictBool = Field(description="Indicates whether this connector supports listing available datasets.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "connector_type", "fields", "dataset_locator_schema", "supports_dataset_listing"]
+
+    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 ConnectorSpecSchema 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 fields (list)
+        _items = []
+        if self.fields:
+            for _item_fields in self.fields:
+                if _item_fields:
+                    _items.append(_item_fields.to_dict())
+            _dict['fields'] = _items
+        # override the default output from pydantic by calling `to_dict()` of dataset_locator_schema
+        if self.dataset_locator_schema:
+            _dict['dataset_locator_schema'] = self.dataset_locator_schema.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectorSpecSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "connector_type": obj.get("connector_type"),
+            "fields": [ConnectorSpecSchemaField.from_dict(_item) for _item in obj["fields"]] if obj.get("fields") is not None else None,
+            "dataset_locator_schema": DatasetLocatorSchema.from_dict(obj["dataset_locator_schema"]) if obj.get("dataset_locator_schema") is not None else None,
+            "supports_dataset_listing": obj.get("supports_dataset_listing")
+        })
+        return _obj
+
+