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

arthur_client/api_bindings/models/dimension.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 Dimension(BaseModel):
+    """
+    Dimension
+    """ # noqa: E501
+    name: StrictStr = Field(description="Name of the dimension.")
+    value: StrictStr = Field(description="Value of the dimension.")
+    __properties: ClassVar[List[str]] = ["name", "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 Dimension 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 Dimension 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"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/example_config.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExampleConfig(BaseModel):
+    """
+    ExampleConfig
+    """ # noqa: E501
+    example: StrictStr = Field(description="Custom example for the sensitive data")
+    result: StrictBool = Field(description="Boolean value representing if the example passes or fails the the sensitive data rule ")
+    __properties: ClassVar[List[str]] = ["example", "result"]
+
+    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 ExampleConfig 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 ExampleConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "example": obj.get("example"),
+            "result": obj.get("result")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/examples_config.py

@@ -0,0 +1,102 @@
+# 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.example_config import ExampleConfig
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExamplesConfig(BaseModel):
+    """
+    ExamplesConfig
+    """ # noqa: E501
+    examples: List[ExampleConfig] = Field(description="List of all the examples for Sensitive Data Rule")
+    hint: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["examples", "hint"]
+
+    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 ExamplesConfig 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 examples (list)
+        _items = []
+        if self.examples:
+            for _item_examples in self.examples:
+                if _item_examples:
+                    _items.append(_item_examples.to_dict())
+            _dict['examples'] = _items
+        # set to None if hint (nullable) is None
+        # and model_fields_set contains the field
+        if self.hint is None and "hint" in self.model_fields_set:
+            _dict['hint'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExamplesConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "examples": [ExampleConfig.from_dict(_item) for _item in obj["examples"]] if obj.get("examples") is not None else None,
+            "hint": obj.get("hint")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/extended_role.py

@@ -0,0 +1,129 @@
+# 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.base_role import BaseRole
+from arthur_client.api_bindings.models.permission import Permission
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExtendedRole(BaseModel):
+    """
+    ExtendedRole
+    """ # 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="ID of the role.")
+    name: StrictStr = Field(description="Name of the role.")
+    description: Optional[StrictStr]
+    organization_bindable: StrictBool = Field(description="Whether the role can be bound to an organization.")
+    workspace_bindable: StrictBool = Field(description="Whether the role can be bound to a workspace.")
+    project_bindable: StrictBool = Field(description="Whether the role can be bound to a project.")
+    data_plane_bindable: StrictBool = Field(description="Whether the role can be bound to a data plane.")
+    permissions: List[Permission] = Field(description="Permissions granted by the role.")
+    base_roles: List[BaseRole] = Field(description="List of IDs of the roles this role inherits permissions from, if any.")
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "name", "description", "organization_bindable", "workspace_bindable", "project_bindable", "data_plane_bindable", "permissions", "base_roles"]
+
+    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 ExtendedRole 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 permissions (list)
+        _items = []
+        if self.permissions:
+            for _item_permissions in self.permissions:
+                if _item_permissions:
+                    _items.append(_item_permissions.to_dict())
+            _dict['permissions'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in base_roles (list)
+        _items = []
+        if self.base_roles:
+            for _item_base_roles in self.base_roles:
+                if _item_base_roles:
+                    _items.append(_item_base_roles.to_dict())
+            _dict['base_roles'] = _items
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ExtendedRole 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"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "organization_bindable": obj.get("organization_bindable"),
+            "workspace_bindable": obj.get("workspace_bindable"),
+            "project_bindable": obj.get("project_bindable"),
+            "data_plane_bindable": obj.get("data_plane_bindable"),
+            "permissions": [Permission.from_dict(_item) for _item in obj["permissions"]] if obj.get("permissions") is not None else None,
+            "base_roles": [BaseRole.from_dict(_item) for _item in obj["base_roles"]] if obj.get("base_roles") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/fetch_data_job_spec.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
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.connector_pagination_options import ConnectorPaginationOptions
+from arthur_client.api_bindings.models.data_result_filter import DataResultFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FetchDataJobSpec(BaseModel):
+    """
+    FetchDataJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'fetch_data'
+    dataset_id: Optional[StrictStr] = None
+    available_dataset_id: Optional[StrictStr] = None
+    start_timestamp: datetime = Field(description="The start timestamp to use for fetching data.")
+    end_timestamp: datetime = Field(description="The end timestamp to use for fetching data.")
+    operation_id: StrictStr = Field(description="The id of the data retrieval operation.")
+    data_filters: List[DataResultFilter] = Field(description="Filters to apply to the metrics data.")
+    pagination_options: ConnectorPaginationOptions = Field(description="Pagination options to use for fetching data.")
+    __properties: ClassVar[List[str]] = ["job_type", "dataset_id", "available_dataset_id", "start_timestamp", "end_timestamp", "operation_id", "data_filters", "pagination_options"]
+
+    @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(['fetch_data']):
+            raise ValueError("must be one of enum values ('fetch_data')")
+        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 FetchDataJobSpec 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 data_filters (list)
+        _items = []
+        if self.data_filters:
+            for _item_data_filters in self.data_filters:
+                if _item_data_filters:
+                    _items.append(_item_data_filters.to_dict())
+            _dict['data_filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of pagination_options
+        if self.pagination_options:
+            _dict['pagination_options'] = self.pagination_options.to_dict()
+        # set to None if dataset_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.dataset_id is None and "dataset_id" in self.model_fields_set:
+            _dict['dataset_id'] = None
+
+        # set to None if available_dataset_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.available_dataset_id is None and "available_dataset_id" in self.model_fields_set:
+            _dict['available_dataset_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FetchDataJobSpec 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 'fetch_data',
+            "dataset_id": obj.get("dataset_id"),
+            "available_dataset_id": obj.get("available_dataset_id"),
+            "start_timestamp": obj.get("start_timestamp"),
+            "end_timestamp": obj.get("end_timestamp"),
+            "operation_id": obj.get("operation_id"),
+            "data_filters": [DataResultFilter.from_dict(_item) for _item in obj["data_filters"]] if obj.get("data_filters") is not None else None,
+            "pagination_options": ConnectorPaginationOptions.from_dict(obj["pagination_options"]) if obj.get("pagination_options") is not None else None
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/fetch_model_task_job_spec.py

@@ -0,0 +1,99 @@
+# 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 FetchModelTaskJobSpec(BaseModel):
+    """
+    FetchModelTaskJobSpec
+    """ # noqa: E501
+    job_type: Optional[StrictStr] = 'fetch_model_task'
+    scope_model_id: StrictStr = Field(description="The id of the model to fetch its corresponding task.")
+    __properties: ClassVar[List[str]] = ["job_type", "scope_model_id"]
+
+    @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(['fetch_model_task']):
+            raise ValueError("must be one of enum values ('fetch_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 FetchModelTaskJobSpec 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 FetchModelTaskJobSpec 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 'fetch_model_task',
+            "scope_model_id": obj.get("scope_model_id")
+        })
+        return _obj
+
+