qanswer-sdk 0.1.0.dev0__py3-none-any.whl

qanswer_sdk/models/logs_visibility_policy_response.py

@@ -0,0 +1,92 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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 pydantic import BaseModel, ConfigDict, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.logs_visibility_policy import LogsVisibilityPolicy
+from typing import Optional, Set
+from typing_extensions import Self
+
+class LogsVisibilityPolicyResponse(BaseModel):
+    """
+    LogsVisibilityPolicyResponse
+    """ # noqa: E501
+    logs_visibility_policy: LogsVisibilityPolicy
+    status: Optional[StrictBool] = True
+    message: Optional[StrictStr] = 'Logs visibility policy updated successfully'
+    __properties: ClassVar[List[str]] = ["logs_visibility_policy", "status", "message"]
+
+    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 LogsVisibilityPolicyResponse 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 LogsVisibilityPolicyResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "logs_visibility_policy": obj.get("logs_visibility_policy"),
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "message": obj.get("message") if obj.get("message") is not None else 'Logs visibility policy updated successfully'
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_auth_field_definition.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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 pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.mcp_auth_field_type import MCPAuthFieldType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPAuthFieldDefinition(BaseModel):
+    """
+    Per-server declaration of a user-supplied value collected at connection time.  The value is stored on the connection and attached as an HTTP header (header key = ``name`` verbatim) on every MCP session for that connection.
+    """ # noqa: E501
+    name: StrictStr = Field(description="HTTP header key, used verbatim")
+    display_name: Optional[StrictStr] = Field(default=None, description="Label shown in the UI; falls back to `name` when null")
+    description: Optional[StrictStr] = Field(default=None, description="Help text under the input")
+    placeholder: Optional[StrictStr] = Field(default=None, description="Input placeholder text")
+    required: Optional[StrictBool] = Field(default=False, description="Whether the field is required")
+    field_type: Optional[MCPAuthFieldType] = Field(default=None, description="`secret` values are masked in API responses; `plain` are returned as-is")
+    __properties: ClassVar[List[str]] = ["name", "display_name", "description", "placeholder", "required", "field_type"]
+
+    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 MCPAuthFieldDefinition 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 MCPAuthFieldDefinition 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"),
+            "display_name": obj.get("display_name"),
+            "description": obj.get("description"),
+            "placeholder": obj.get("placeholder"),
+            "required": obj.get("required") if obj.get("required") is not None else False,
+            "field_type": obj.get("field_type")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_auth_field_type.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class MCPAuthFieldType(str, Enum):
+    """
+    MCPAuthFieldType
+    """
+
+    """
+    allowed enum values
+    """
+    SECRET = 'secret'
+    PLAIN = 'plain'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MCPAuthFieldType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_authentication_type.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class MCPAuthenticationType(str, Enum):
+    """
+    MCPAuthenticationType
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'none'
+    OAUTH2 = 'oauth2'
+    ADVANCED_OAUTH2 = 'advanced_oauth2'
+    API_KEY = 'api_key'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MCPAuthenticationType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_connection.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPConnection(BaseModel):
+    """
+    MCPConnection
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username for this connection")
+    name: Optional[StrictStr] = Field(default=None, description="Optional name to distinguish multiple connections for the same server")
+    api_key: Optional[StrictStr] = Field(default=None, description="API key for API key authentication")
+    access_token: Optional[StrictStr] = Field(default=None, description="OAuth access token")
+    refresh_token: Optional[StrictStr] = Field(default=None, description="OAuth refresh token")
+    token_expiry: Optional[datetime] = Field(default=None, description="OAuth token expiry time")
+    auth_field_values: Optional[Dict[str, StrictStr]] = Field(default=None, description="Values for the server's auth_fields, attached as HTTP headers on each MCP request")
+    uid: StrictStr = Field(description="Connection UID")
+    server_uid: StrictStr = Field(description="MCP server UID")
+    created_at: datetime = Field(description="Creation timestamp")
+    updated_at: datetime = Field(description="Last update timestamp")
+    __properties: ClassVar[List[str]] = ["username", "name", "api_key", "access_token", "refresh_token", "token_expiry", "auth_field_values", "uid", "server_uid", "created_at", "updated_at"]
+
+    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 MCPConnection 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 MCPConnection from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "name": obj.get("name"),
+            "api_key": obj.get("api_key"),
+            "access_token": obj.get("access_token"),
+            "refresh_token": obj.get("refresh_token"),
+            "token_expiry": obj.get("token_expiry"),
+            "auth_field_values": obj.get("auth_field_values"),
+            "uid": obj.get("uid"),
+            "server_uid": obj.get("server_uid"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_connection_create.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPConnectionCreate(BaseModel):
+    """
+    MCPConnectionCreate
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username for this connection")
+    name: Optional[StrictStr] = Field(default=None, description="Optional name to distinguish multiple connections for the same server")
+    api_key: Optional[StrictStr] = Field(default=None, description="API key for API key authentication")
+    access_token: Optional[StrictStr] = Field(default=None, description="OAuth access token")
+    refresh_token: Optional[StrictStr] = Field(default=None, description="OAuth refresh token")
+    token_expiry: Optional[datetime] = Field(default=None, description="OAuth token expiry time")
+    auth_field_values: Optional[Dict[str, StrictStr]] = Field(default=None, description="Values for the server's auth_fields, attached as HTTP headers on each MCP request")
+    __properties: ClassVar[List[str]] = ["username", "name", "api_key", "access_token", "refresh_token", "token_expiry", "auth_field_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 MCPConnectionCreate 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 MCPConnectionCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "name": obj.get("name"),
+            "api_key": obj.get("api_key"),
+            "access_token": obj.get("access_token"),
+            "refresh_token": obj.get("refresh_token"),
+            "token_expiry": obj.get("token_expiry"),
+            "auth_field_values": obj.get("auth_field_values")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_server.py

@@ -0,0 +1,146 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.mcp_auth_field_definition import MCPAuthFieldDefinition
+from qanswer_sdk.models.mcp_authentication_type import MCPAuthenticationType
+from qanswer_sdk.models.mcp_server_type import MCPServerType
+from qanswer_sdk.models.mcp_transport import MCPTransport
+from qanswer_sdk.models.mcp_visibility import McpVisibility
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPServer(BaseModel):
+    """
+    MCPServer
+    """ # noqa: E501
+    name: StrictStr = Field(description="Server name")
+    description: Optional[StrictStr] = Field(default=None, description="Server description")
+    server_url: Optional[StrictStr] = Field(default=None, description="Server URL")
+    server_type: Optional[MCPServerType] = Field(default=None, description="Server type")
+    transport: Optional[MCPTransport] = Field(default=None, description="Transport type")
+    authentication_type: Optional[MCPAuthenticationType] = Field(default=None, description="Authentication type")
+    authentication_config: Optional[Dict[str, Any]] = Field(default=None, description="Authentication configuration")
+    custom_headers: Optional[Dict[str, StrictStr]] = Field(default=None, description="Custom headers for MCP server connections")
+    auth_fields: Optional[List[MCPAuthFieldDefinition]] = Field(default=None, description="Per-server auth fields collected at connection time; values become HTTP headers")
+    uid: StrictStr = Field(description="Server UID")
+    created_at: datetime = Field(description="Creation timestamp")
+    updated_at: datetime = Field(description="Last update timestamp")
+    callback_link: Optional[StrictStr] = Field(default=None, description="OAuth2 callback link for authentication")
+    number_of_connections: Optional[StrictInt] = Field(default=0, description="Number of connections for the current user")
+    visibility: Optional[McpVisibility] = Field(default=None, description="Server visibility scope")
+    enabled: Optional[StrictBool] = Field(default=None, description="Whether the server is enabled")
+    default_selection_enabled: Optional[StrictBool] = Field(default=None, description="Whether the server's tools are selected by default for users")
+    can_modify: Optional[StrictBool] = Field(default=None, description="Whether the current user can modify this server", alias="canModify")
+    organization_id: Optional[StrictInt] = Field(default=None, description="Organization ID if visibility is ORGANIZATION")
+    organization_name: Optional[StrictStr] = Field(default=None, description="Organization name if visibility is ORGANIZATION", alias="organizationName")
+    organization_enabled: Optional[StrictBool] = Field(default=None, description="Whether the server is enabled at organization level", alias="organizationEnabled")
+    organization_default: Optional[StrictBool] = Field(default=None, description="Whether the server's tools are defaults for the selected organization")
+    number_of_tools: Optional[StrictInt] = Field(default=None, description="Total number of tools in this server")
+    number_of_tools_selected: Optional[StrictInt] = Field(default=None, description="Number of tools selected by the current user")
+    __properties: ClassVar[List[str]] = ["name", "description", "server_url", "server_type", "transport", "authentication_type", "authentication_config", "custom_headers", "auth_fields", "uid", "created_at", "updated_at", "callback_link", "number_of_connections", "visibility", "enabled", "default_selection_enabled", "canModify", "organization_id", "organizationName", "organizationEnabled", "organization_default", "number_of_tools", "number_of_tools_selected"]
+
+    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 MCPServer 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 auth_fields (list)
+        _items = []
+        if self.auth_fields:
+            for _item_auth_fields in self.auth_fields:
+                if _item_auth_fields:
+                    _items.append(_item_auth_fields.to_dict())
+            _dict['auth_fields'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MCPServer 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"),
+            "description": obj.get("description"),
+            "server_url": obj.get("server_url"),
+            "server_type": obj.get("server_type"),
+            "transport": obj.get("transport"),
+            "authentication_type": obj.get("authentication_type"),
+            "authentication_config": obj.get("authentication_config"),
+            "custom_headers": obj.get("custom_headers"),
+            "auth_fields": [MCPAuthFieldDefinition.from_dict(_item) for _item in obj["auth_fields"]] if obj.get("auth_fields") is not None else None,
+            "uid": obj.get("uid"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "callback_link": obj.get("callback_link"),
+            "number_of_connections": obj.get("number_of_connections") if obj.get("number_of_connections") is not None else 0,
+            "visibility": obj.get("visibility"),
+            "enabled": obj.get("enabled"),
+            "default_selection_enabled": obj.get("default_selection_enabled"),
+            "canModify": obj.get("canModify"),
+            "organization_id": obj.get("organization_id"),
+            "organizationName": obj.get("organizationName"),
+            "organizationEnabled": obj.get("organizationEnabled"),
+            "organization_default": obj.get("organization_default"),
+            "number_of_tools": obj.get("number_of_tools"),
+            "number_of_tools_selected": obj.get("number_of_tools_selected")
+        })
+        return _obj
+
+