Source code for arize._generated.api_client.models.agent_integration

# coding: utf-8

"""
    Arize REST API

    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 

    The version of the OpenAPI document: 2.0.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 arize._generated.api_client.models.agent_config import AgentConfig
from arize._generated.api_client.models.integration_scoping import IntegrationScoping
from typing import Optional, Set
from typing_extensions import Self



class AgentIntegration(BaseModel):
    """
    An agent integration (type=AGENT): a customer-hosted HTTPS endpoint plus a JSON Schema describing the request payload. 
    """ # noqa: E501
    id: StrictStr = Field(description="The unique identifier for the integration.")
    type: StrictStr = Field(description="Discriminator identifying an agent integration.")
    name: StrictStr = Field(description="The integration name. Unique among active AGENT and EVALUATOR integrations in the account.")
    description: Optional[StrictStr] = Field(default=None, description="Optional human-readable description of the integration.")
    scopings: List[IntegrationScoping] = Field(description="Visibility scoping rules. Account-wide when empty.")
    created_at: datetime = Field(description="When the integration was created.")
    updated_at: datetime = Field(description="When the integration was last updated.")
    created_by_user_id: Optional[StrictStr] = Field(description="Unique identifier of the user who created the integration. Null if that user has since been deleted.")
    config: AgentConfig
    __properties: ClassVar[List[str]] = ["id", "type", "name", "description", "scopings", "created_at", "updated_at", "created_by_user_id", "config"]



    @field_validator('type')
    def type_validate_enum(cls, value):
        """Validates the enum"""
        if value not in set(['AGENT']):
            raise ValueError("must be one of enum values ('AGENT')")
        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 AgentIntegration 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 scopings (list)
        _items = []
        if self.scopings:
            for _item_scopings in self.scopings:
                if _item_scopings:
                    _items.append(_item_scopings.to_dict())
            _dict['scopings'] = _items
        # override the default output from pydantic by calling `to_dict()` of config
        if self.config:
            _dict['config'] = self.config.to_dict()
        # 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

        # set to None if created_by_user_id (nullable) is None
        # and model_fields_set contains the field
        if self.created_by_user_id is None and "created_by_user_id" in self.model_fields_set:
            _dict['created_by_user_id'] = None

        return _dict




    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of AgentIntegration 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"),
            "type": obj.get("type"),
            "name": obj.get("name"),
            "description": obj.get("description"),
            "scopings": [IntegrationScoping.from_dict(_item) for _item in obj["scopings"]] if obj.get("scopings") is not None else None,
            "created_at": obj.get("created_at"),
            "updated_at": obj.get("updated_at"),
            "created_by_user_id": obj.get("created_by_user_id"),
            "config": AgentConfig.from_dict(obj["config"]) if obj.get("config") is not None else None
        })
        return _obj