scorable 1.6.4__py3-none-any.whl

root/generated/openapi_aclient/models/objective.py

@@ -0,0 +1,157 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Annotated, Self
+
+from root.generated.openapi_aclient.models.nested_user_details import NestedUserDetails
+from root.generated.openapi_aclient.models.objective_validator import ObjectiveValidator
+from root.generated.openapi_aclient.models.status_enum import StatusEnum
+
+
+class Objective(BaseModel):
+    """
+    Objective
+    """  # noqa: E501
+
+    id: StrictStr
+    intent: Optional[Annotated[str, Field(strict=True, max_length=100000)]] = None
+    status: Optional[StatusEnum] = None
+    test_set: Optional[List[List[StrictStr]]] = Field(description="Deprecated: Use test_dataset_id instead.")
+    validators: Optional[List[ObjectiveValidator]] = None
+    created_at: datetime
+    owner: NestedUserDetails
+    version_id: StrictStr
+    test_dataset_id: Optional[StrictStr] = None
+    meta: Dict[str, Any] = Field(alias="_meta")
+    __properties: ClassVar[List[str]] = [
+        "id",
+        "intent",
+        "status",
+        "test_set",
+        "validators",
+        "created_at",
+        "owner",
+        "version_id",
+        "test_dataset_id",
+        "_meta",
+    ]
+
+    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 Objective 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "id",
+                "test_set",
+                "created_at",
+                "owner",
+                "version_id",
+                "meta",
+            ]
+        )
+
+        _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 validators (list)
+        _items = []
+        if self.validators:
+            for _item in self.validators:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["validators"] = _items
+        # override the default output from pydantic by calling `to_dict()` of owner
+        if self.owner:
+            _dict["owner"] = self.owner.to_dict()
+        # set to None if test_set (nullable) is None
+        # and model_fields_set contains the field
+        if self.test_set is None and "test_set" in self.model_fields_set:
+            _dict["test_set"] = None
+
+        # set to None if test_dataset_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.test_dataset_id is None and "test_dataset_id" in self.model_fields_set:
+            _dict["test_dataset_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Objective from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "intent": obj.get("intent"),
+                "status": obj.get("status"),
+                "test_set": obj.get("test_set"),
+                "validators": [ObjectiveValidator.from_dict(_item) for _item in obj["validators"]]
+                if obj.get("validators") is not None
+                else None,
+                "created_at": obj.get("created_at"),
+                "owner": NestedUserDetails.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
+                "version_id": obj.get("version_id"),
+                "test_dataset_id": obj.get("test_dataset_id"),
+                "_meta": obj.get("_meta"),
+            }
+        )
+        return _obj

root/generated/openapi_aclient/models/objective_list.py

@@ -0,0 +1,128 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Annotated, Self
+
+from root.generated.openapi_aclient.models.nested_user_details import NestedUserDetails
+from root.generated.openapi_aclient.models.objective_validator import ObjectiveValidator
+from root.generated.openapi_aclient.models.status_enum import StatusEnum
+
+
+class ObjectiveList(BaseModel):
+    """
+    ObjectiveList
+    """  # noqa: E501
+
+    id: StrictStr
+    intent: Optional[Annotated[str, Field(strict=True, max_length=100000)]] = None
+    status: Optional[StatusEnum] = None
+    owner: NestedUserDetails
+    created_at: datetime
+    validators: List[ObjectiveValidator]
+    meta: Dict[str, Any] = Field(alias="_meta")
+    __properties: ClassVar[List[str]] = ["id", "intent", "status", "owner", "created_at", "validators", "_meta"]
+
+    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 ObjectiveList 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.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "id",
+                "owner",
+                "created_at",
+                "validators",
+                "meta",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of owner
+        if self.owner:
+            _dict["owner"] = self.owner.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in validators (list)
+        _items = []
+        if self.validators:
+            for _item in self.validators:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["validators"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ObjectiveList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "id": obj.get("id"),
+                "intent": obj.get("intent"),
+                "status": obj.get("status"),
+                "owner": NestedUserDetails.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
+                "created_at": obj.get("created_at"),
+                "validators": [ObjectiveValidator.from_dict(_item) for _item in obj["validators"]]
+                if obj.get("validators") is not None
+                else None,
+                "_meta": obj.get("_meta"),
+            }
+        )
+        return _obj

root/generated/openapi_aclient/models/objective_request.py

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing_extensions import Annotated, Self
+
+from root.generated.openapi_aclient.models.objective_validator_request import ObjectiveValidatorRequest
+from root.generated.openapi_aclient.models.status_enum import StatusEnum
+
+
+class ObjectiveRequest(BaseModel):
+    """
+    ObjectiveRequest
+    """  # noqa: E501
+
+    intent: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=100000)]] = None
+    status: Optional[StatusEnum] = None
+    validators: Optional[List[ObjectiveValidatorRequest]] = None
+    force_create: Optional[StrictBool] = Field(
+        default=None, description="Force creation of a new objective. Applies only to PUT requests."
+    )
+    test_dataset_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["intent", "status", "validators", "force_create", "test_dataset_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 ObjectiveRequest 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 validators (list)
+        _items = []
+        if self.validators:
+            for _item in self.validators:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["validators"] = _items
+        # set to None if test_dataset_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.test_dataset_id is None and "test_dataset_id" in self.model_fields_set:
+            _dict["test_dataset_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ObjectiveRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "intent": obj.get("intent"),
+                "status": obj.get("status"),
+                "validators": [ObjectiveValidatorRequest.from_dict(_item) for _item in obj["validators"]]
+                if obj.get("validators") is not None
+                else None,
+                "force_create": obj.get("force_create"),
+                "test_dataset_id": obj.get("test_dataset_id"),
+            }
+        )
+        return _obj

root/generated/openapi_aclient/models/objective_validator.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt
+from typing_extensions import Self
+
+from root.generated.openapi_aclient.models.nested_objective_evaluator import NestedObjectiveEvaluator
+
+
+class ObjectiveValidator(BaseModel):
+    """
+    ObjectiveValidator
+    """  # noqa: E501
+
+    evaluator: NestedObjectiveEvaluator
+    threshold: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["evaluator", "threshold"]
+
+    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 ObjectiveValidator 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.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "evaluator",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of evaluator
+        if self.evaluator:
+            _dict["evaluator"] = self.evaluator.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ObjectiveValidator from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "evaluator": NestedObjectiveEvaluator.from_dict(obj["evaluator"])
+                if obj.get("evaluator") is not None
+                else None,
+                "threshold": obj.get("threshold"),
+            }
+        )
+        return _obj

root/generated/openapi_aclient/models/objective_validator_request.py

@@ -0,0 +1,90 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing_extensions import Annotated, Self
+
+
+class ObjectiveValidatorRequest(BaseModel):
+    """
+    ObjectiveValidatorRequest
+    """  # noqa: E501
+
+    evaluator_id: Optional[StrictStr] = None
+    evaluator_name: Optional[Annotated[str, Field(min_length=1, strict=True)]] = None
+    threshold: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["evaluator_id", "evaluator_name", "threshold"]
+
+    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 ObjectiveValidatorRequest 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 ObjectiveValidatorRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "evaluator_id": obj.get("evaluator_id"),
+                "evaluator_name": obj.get("evaluator_name"),
+                "threshold": obj.get("threshold"),
+            }
+        )
+        return _obj

root/generated/openapi_aclient/models/paginated_data_set_list_list.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing_extensions import Self
+
+from root.generated.openapi_aclient.models.data_set_list import DataSetList
+
+
+class PaginatedDataSetListList(BaseModel):
+    """
+    PaginatedDataSetListList
+    """  # noqa: E501
+
+    next: Optional[StrictStr] = None
+    previous: Optional[StrictStr] = None
+    results: List[DataSetList]
+    __properties: ClassVar[List[str]] = ["next", "previous", "results"]
+
+    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 PaginatedDataSetListList 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 results (list)
+        _items = []
+        if self.results:
+            for _item in self.results:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["results"] = _items
+        # set to None if next (nullable) is None
+        # and model_fields_set contains the field
+        if self.next is None and "next" in self.model_fields_set:
+            _dict["next"] = None
+
+        # set to None if previous (nullable) is None
+        # and model_fields_set contains the field
+        if self.previous is None and "previous" in self.model_fields_set:
+            _dict["previous"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PaginatedDataSetListList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "next": obj.get("next"),
+                "previous": obj.get("previous"),
+                "results": [DataSetList.from_dict(_item) for _item in obj["results"]]
+                if obj.get("results") is not None
+                else None,
+            }
+        )
+        return _obj