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

qanswer_sdk/models/mcp_server0.py

@@ -0,0 +1,167 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+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[StrictStr] = Field(default=None, description="Server type")
+    transport: Optional[StrictStr] = Field(default='http', description="Transport type")
+    authentication_type: Optional[StrictStr] = 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")
+    uid: StrictStr = Field(description="Server UID")
+    created_at: StrictStr = Field(description="Creation timestamp")
+    updated_at: StrictStr = 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[StrictStr] = Field(default=None, description="Server visibility scope")
+    enabled: Optional[StrictBool] = Field(default=None, description="Whether the server is enabled")
+    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", alias="organizationId")
+    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")
+    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", "uid", "created_at", "updated_at", "callback_link", "number_of_connections", "visibility", "enabled", "canModify", "organizationId", "organizationName", "organizationEnabled", "number_of_tools", "number_of_tools_selected"]
+
+    @field_validator('server_type')
+    def server_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['capability', 'mcp']):
+            raise ValueError("must be one of enum values ('capability', 'mcp')")
+        return value
+
+    @field_validator('transport')
+    def transport_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['http', 'stdio']):
+            raise ValueError("must be one of enum values ('http', 'stdio')")
+        return value
+
+    @field_validator('authentication_type')
+    def authentication_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'oauth2', 'advanced_oauth2', 'api_key']):
+            raise ValueError("must be one of enum values ('none', 'oauth2', 'advanced_oauth2', 'api_key')")
+        return value
+
+    @field_validator('visibility')
+    def visibility_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SYSTEM', 'ORGANIZATION', 'USER']):
+            raise ValueError("must be one of enum values ('SYSTEM', 'ORGANIZATION', 'USER')")
+        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 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,
+        )
+        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") if obj.get("transport") is not None else 'http',
+            "authentication_type": obj.get("authentication_type") if obj.get("authentication_type") is not None else 'none',
+            "authentication_config": obj.get("authentication_config"),
+            "custom_headers": obj.get("custom_headers"),
+            "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"),
+            "canModify": obj.get("canModify"),
+            "organizationId": obj.get("organizationId"),
+            "organizationName": obj.get("organizationName"),
+            "organizationEnabled": obj.get("organizationEnabled"),
+            "number_of_tools": obj.get("number_of_tools"),
+            "number_of_tools_selected": obj.get("number_of_tools_selected")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_server_create.py

@@ -0,0 +1,133 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPServerCreate(BaseModel):
+    """
+    MCPServerCreate
+    """ # noqa: E501
+    name: StrictStr = Field(description="Unique server name")
+    description: Optional[StrictStr] = Field(default=None, description="Server description")
+    server_url: Optional[StrictStr] = Field(default=None, description="Server URL")
+    server_type: Optional[StrictStr] = Field(default=None, description="Server type")
+    transport: Optional[StrictStr] = Field(default='http', description="Transport type")
+    authentication_type: Optional[StrictStr] = 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")
+    uid: Optional[StrictStr] = Field(default=None, description="Optional custom UID for the server")
+    __properties: ClassVar[List[str]] = ["name", "description", "server_url", "server_type", "transport", "authentication_type", "authentication_config", "custom_headers", "uid"]
+
+    @field_validator('server_type')
+    def server_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['capability', 'mcp']):
+            raise ValueError("must be one of enum values ('capability', 'mcp')")
+        return value
+
+    @field_validator('transport')
+    def transport_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['http', 'stdio']):
+            raise ValueError("must be one of enum values ('http', 'stdio')")
+        return value
+
+    @field_validator('authentication_type')
+    def authentication_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'oauth2', 'advanced_oauth2', 'api_key']):
+            raise ValueError("must be one of enum values ('none', 'oauth2', 'advanced_oauth2', 'api_key')")
+        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 MCPServerCreate 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 MCPServerCreate 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") if obj.get("transport") is not None else 'http',
+            "authentication_type": obj.get("authentication_type") if obj.get("authentication_type") is not None else 'none',
+            "authentication_config": obj.get("authentication_config"),
+            "custom_headers": obj.get("custom_headers"),
+            "uid": obj.get("uid")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_server_dto.py

@@ -0,0 +1,167 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class McpServerDto(BaseModel):
+    """
+    McpServerDto
+    """ # 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[StrictStr] = Field(default=None, description="Server type")
+    transport: Optional[StrictStr] = Field(default='http', description="Transport type")
+    authentication_type: Optional[StrictStr] = 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")
+    uid: StrictStr = Field(description="Server UID")
+    created_at: StrictStr = Field(description="Creation timestamp")
+    updated_at: StrictStr = 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[StrictStr] = Field(default=None, description="Server visibility scope")
+    enabled: Optional[StrictBool] = Field(default=None, description="Whether the server is enabled")
+    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", alias="organizationId")
+    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")
+    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", "uid", "created_at", "updated_at", "callback_link", "number_of_connections", "visibility", "enabled", "canModify", "organizationId", "organizationName", "organizationEnabled", "number_of_tools", "number_of_tools_selected"]
+
+    @field_validator('server_type')
+    def server_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['capability', 'mcp']):
+            raise ValueError("must be one of enum values ('capability', 'mcp')")
+        return value
+
+    @field_validator('transport')
+    def transport_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['http', 'stdio']):
+            raise ValueError("must be one of enum values ('http', 'stdio')")
+        return value
+
+    @field_validator('authentication_type')
+    def authentication_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'oauth2', 'advanced_oauth2', 'api_key']):
+            raise ValueError("must be one of enum values ('none', 'oauth2', 'advanced_oauth2', 'api_key')")
+        return value
+
+    @field_validator('visibility')
+    def visibility_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SYSTEM', 'ORGANIZATION', 'USER']):
+            raise ValueError("must be one of enum values ('SYSTEM', 'ORGANIZATION', 'USER')")
+        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 McpServerDto 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 McpServerDto 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") if obj.get("transport") is not None else 'http',
+            "authentication_type": obj.get("authentication_type") if obj.get("authentication_type") is not None else 'none',
+            "authentication_config": obj.get("authentication_config"),
+            "custom_headers": obj.get("custom_headers"),
+            "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"),
+            "canModify": obj.get("canModify"),
+            "organizationId": obj.get("organizationId"),
+            "organizationName": obj.get("organizationName"),
+            "organizationEnabled": obj.get("organizationEnabled"),
+            "number_of_tools": obj.get("number_of_tools"),
+            "number_of_tools_selected": obj.get("number_of_tools_selected")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_server_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 MCPServerType(str, Enum):
+    """
+    MCPServerType
+    """
+
+    """
+    allowed enum values
+    """
+    CAPABILITY = 'capability'
+    MCP = 'mcp'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MCPServerType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_server_update.py

@@ -0,0 +1,131 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPServerUpdate(BaseModel):
+    """
+    MCPServerUpdate
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, 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[StrictStr] = Field(default=None, description="Server type")
+    transport: Optional[StrictStr] = Field(default=None, description="Transport type")
+    authentication_type: Optional[StrictStr] = 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")
+    __properties: ClassVar[List[str]] = ["name", "description", "server_url", "server_type", "transport", "authentication_type", "authentication_config", "custom_headers"]
+
+    @field_validator('server_type')
+    def server_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['capability', 'mcp']):
+            raise ValueError("must be one of enum values ('capability', 'mcp')")
+        return value
+
+    @field_validator('transport')
+    def transport_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['http', 'stdio']):
+            raise ValueError("must be one of enum values ('http', 'stdio')")
+        return value
+
+    @field_validator('authentication_type')
+    def authentication_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'oauth2', 'advanced_oauth2', 'api_key']):
+            raise ValueError("must be one of enum values ('none', 'oauth2', 'advanced_oauth2', 'api_key')")
+        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 MCPServerUpdate 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 MCPServerUpdate 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")
+        })
+        return _obj
+
+