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

arthur_client/api_bindings/models/connector_spec_schema_field.py

@@ -0,0 +1,103 @@
+# 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, Optional
+from arthur_client.api_bindings.models.connector_field_data_type import ConnectorFieldDataType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorSpecSchemaField(BaseModel):
+    """
+    ConnectorSpecSchemaField
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of connector field.")
+    is_sensitive: StrictBool = Field(description="If field stores sensitive data.")
+    is_optional: StrictBool = Field(description="If field is optional or required.")
+    d_type: ConnectorFieldDataType = Field(description="Data type of the value stored by the field.")
+    description: StrictStr = Field(description="Description of connector field.")
+    allowed_values: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["name", "is_sensitive", "is_optional", "d_type", "description", "allowed_values"]
+
+    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 ConnectorSpecSchemaField 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 allowed_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.allowed_values is None and "allowed_values" in self.model_fields_set:
+            _dict['allowed_values'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConnectorSpecSchemaField from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "is_sensitive": obj.get("is_sensitive"),
+            "is_optional": obj.get("is_optional"),
+            "d_type": obj.get("d_type"),
+            "description": obj.get("description"),
+            "allowed_values": obj.get("allowed_values")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/connector_type.py

@@ -0,0 +1,40 @@
+# 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 ConnectorType(str, Enum):
+    """
+    ConnectorType
+    """
+
+    """
+    allowed enum values
+    """
+    SHIELD = 'shield'
+    S3 = 'S3'
+    GCS = 'GCS'
+    BIGQUERY = 'BigQuery'
+    ENGINE_INTERNAL = 'engine_internal'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ConnectorType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/connectors_sort.py

@@ -0,0 +1,38 @@
+# 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 ConnectorsSort(str, Enum):
+    """
+    ConnectorsSort
+    """
+
+    """
+    allowed enum values
+    """
+    CREATED_AT = 'created_at'
+    UPDATED_AT = 'updated_at'
+    NAME = 'name'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ConnectorsSort from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/create_model_link_task_job_spec.py

@@ -0,0 +1,108 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateModelLinkTaskJobSpec(BaseModel):
+    """
+    CreateModelLinkTaskJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'link_model_task'
+    task_id: StrictStr = Field(description="The id of the Shield task to link when creating the new model.")
+    connector_id: StrictStr = Field(description="The id of the engine internal connector to use to link the task.")
+    onboarding_identifier: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["job_type", "task_id", "connector_id", "onboarding_identifier"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['link_model_task']):
+            raise ValueError("must be one of enum values ('link_model_task')")
+        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 CreateModelLinkTaskJobSpec 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 onboarding_identifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.onboarding_identifier is None and "onboarding_identifier" in self.model_fields_set:
+            _dict['onboarding_identifier'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateModelLinkTaskJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'link_model_task',
+            "task_id": obj.get("task_id"),
+            "connector_id": obj.get("connector_id"),
+            "onboarding_identifier": obj.get("onboarding_identifier")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/create_model_task_job_spec.py

@@ -0,0 +1,118 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.new_rule_request import NewRuleRequest
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateModelTaskJobSpec(BaseModel):
+    """
+    CreateModelTaskJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'create_model_task'
+    connector_id: StrictStr = Field(description="The id of the engine internal connector to use to create the task.")
+    task_name: StrictStr = Field(description="The name of the task.")
+    onboarding_identifier: Optional[StrictStr] = None
+    initial_rules: List[NewRuleRequest] = Field(description="The initial rules to apply to the created model.")
+    __properties: ClassVar[List[str]] = ["job_type", "connector_id", "task_name", "onboarding_identifier", "initial_rules"]
+
+    @field_validator('job_type')
+    def job_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['create_model_task']):
+            raise ValueError("must be one of enum values ('create_model_task')")
+        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 CreateModelTaskJobSpec 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 initial_rules (list)
+        _items = []
+        if self.initial_rules:
+            for _item_initial_rules in self.initial_rules:
+                if _item_initial_rules:
+                    _items.append(_item_initial_rules.to_dict())
+            _dict['initial_rules'] = _items
+        # set to None if onboarding_identifier (nullable) is None
+        # and model_fields_set contains the field
+        if self.onboarding_identifier is None and "onboarding_identifier" in self.model_fields_set:
+            _dict['onboarding_identifier'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateModelTaskJobSpec from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_type": obj.get("job_type") if obj.get("job_type") is not None else 'create_model_task',
+            "connector_id": obj.get("connector_id"),
+            "task_name": obj.get("task_name"),
+            "onboarding_identifier": obj.get("onboarding_identifier"),
+            "initial_rules": [NewRuleRequest.from_dict(_item) for _item in obj["initial_rules"]] if obj.get("initial_rules") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/created_alerts.py

@@ -0,0 +1,110 @@
+# 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 arthur_client.api_bindings.models.alert import Alert
+from arthur_client.api_bindings.models.alert_webhook_called import AlertWebhookCalled
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreatedAlerts(BaseModel):
+    """
+    CreatedAlerts
+    """ # noqa: E501
+    alerts: List[Alert] = Field(description="The list of created alerts.")
+    webhooks_called: Optional[List[AlertWebhookCalled]] = None
+    __properties: ClassVar[List[str]] = ["alerts", "webhooks_called"]
+
+    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 CreatedAlerts 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 alerts (list)
+        _items = []
+        if self.alerts:
+            for _item_alerts in self.alerts:
+                if _item_alerts:
+                    _items.append(_item_alerts.to_dict())
+            _dict['alerts'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in webhooks_called (list)
+        _items = []
+        if self.webhooks_called:
+            for _item_webhooks_called in self.webhooks_called:
+                if _item_webhooks_called:
+                    _items.append(_item_webhooks_called.to_dict())
+            _dict['webhooks_called'] = _items
+        # set to None if webhooks_called (nullable) is None
+        # and model_fields_set contains the field
+        if self.webhooks_called is None and "webhooks_called" in self.model_fields_set:
+            _dict['webhooks_called'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreatedAlerts from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "alerts": [Alert.from_dict(_item) for _item in obj["alerts"]] if obj.get("alerts") is not None else None,
+            "webhooks_called": [AlertWebhookCalled.from_dict(_item) for _item in obj["webhooks_called"]] if obj.get("webhooks_called") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/credentials.py

@@ -0,0 +1,134 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from arthur_client.api_bindings.models.service_account_credentials import ServiceAccountCredentials
+from arthur_client.api_bindings.models.user_credentials import UserCredentials
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+CREDENTIALS_ANY_OF_SCHEMAS = ["ServiceAccountCredentials", "UserCredentials"]
+
+class Credentials(BaseModel):
+    """
+    The user credentials.
+    """
+
+    # data type: ServiceAccountCredentials
+    anyof_schema_1_validator: Optional[ServiceAccountCredentials] = None
+    # data type: UserCredentials
+    anyof_schema_2_validator: Optional[UserCredentials] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[ServiceAccountCredentials, UserCredentials]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "ServiceAccountCredentials", "UserCredentials" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = Credentials.model_construct()
+        error_messages = []
+        # validate data type: ServiceAccountCredentials
+        if not isinstance(v, ServiceAccountCredentials):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ServiceAccountCredentials`")
+        else:
+            return v
+
+        # validate data type: UserCredentials
+        if not isinstance(v, UserCredentials):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `UserCredentials`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in Credentials with anyOf schemas: ServiceAccountCredentials, UserCredentials. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[ServiceAccountCredentials] = None
+        try:
+            instance.actual_instance = ServiceAccountCredentials.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[UserCredentials] = None
+        try:
+            instance.actual_instance = UserCredentials.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into Credentials with anyOf schemas: ServiceAccountCredentials, UserCredentials. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], ServiceAccountCredentials, UserCredentials]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+