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

qanswer_sdk/models/microsoft_connector_config.py

@@ -0,0 +1,110 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MicrosoftConnectorConfig(BaseModel):
+    """
+    MicrosoftConnectorConfig
+    """ # noqa: E501
+    client_id: Optional[StrictStr] = None
+    client_secret: Optional[StrictStr] = None
+    tenant_id: Optional[StrictStr] = None
+    redirect_uri: Optional[StrictStr] = None
+    scopes: Optional[StrictStr] = None
+    additional_properties: Optional[Dict[str, Any]] = Field(default=None, alias="additionalProperties")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["client_id", "client_secret", "tenant_id", "redirect_uri", "scopes", "additionalProperties"]
+
+    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 MicrosoftConnectorConfig 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MicrosoftConnectorConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "client_id": obj.get("client_id"),
+            "client_secret": obj.get("client_secret"),
+            "tenant_id": obj.get("tenant_id"),
+            "redirect_uri": obj.get("redirect_uri"),
+            "scopes": obj.get("scopes"),
+            "additionalProperties": obj.get("additionalProperties")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

qanswer_sdk/models/modify_connector_request.py

@@ -0,0 +1,107 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModifyConnectorRequest(BaseModel):
+    """
+    ModifyConnectorRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    connector_name: Optional[StrictStr] = None
+    refresh_frequency: Optional[StrictStr] = None
+    conversation_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "connector_name", "refresh_frequency", "conversation_id"]
+
+    @field_validator('refresh_frequency')
+    def refresh_frequency_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['never', 'daily', 'weekly', 'monthly']):
+            raise ValueError("must be one of enum values ('never', 'daily', 'weekly', 'monthly')")
+        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 ModifyConnectorRequest 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 ModifyConnectorRequest 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"),
+            "dataset": obj.get("dataset"),
+            "connector_id": obj.get("connector_id"),
+            "connector_name": obj.get("connector_name"),
+            "refresh_frequency": obj.get("refresh_frequency"),
+            "conversation_id": obj.get("conversation_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/modify_file_display_name_request.py

@@ -0,0 +1,97 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ModifyFileDisplayNameRequest(BaseModel):
+    """
+    ModifyFileDisplayNameRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    file_id: StrictStr
+    new_display_name: StrictStr
+    conversation_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "file_id", "new_display_name", "conversation_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 ModifyFileDisplayNameRequest 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 ModifyFileDisplayNameRequest 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"),
+            "dataset": obj.get("dataset"),
+            "connector_id": obj.get("connector_id"),
+            "file_id": obj.get("file_id"),
+            "new_display_name": obj.get("new_display_name"),
+            "conversation_id": obj.get("conversation_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/notification_dto.py

@@ -0,0 +1,137 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.notification_payload_dto import NotificationPayloadDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationDto(BaseModel):
+    """
+    NotificationDto
+    """ # noqa: E501
+    notification_id: Optional[StrictInt] = Field(default=None, alias="notificationId")
+    user_id: Optional[StrictInt] = Field(default=None, alias="userId")
+    sender_id: Optional[StrictInt] = Field(default=None, alias="senderId")
+    sender_type: Optional[StrictStr] = Field(default=None, alias="senderType")
+    title: Optional[StrictStr] = None
+    message: Optional[StrictStr] = None
+    notification_type: Optional[StrictStr] = Field(default=None, alias="notificationType")
+    is_read: Optional[StrictBool] = Field(default=False, alias="isRead")
+    created_at: Optional[datetime] = Field(default=None, alias="createdAt")
+    read_at: Optional[datetime] = Field(default=None, alias="readAt")
+    data: Optional[NotificationPayloadDto] = None
+    __properties: ClassVar[List[str]] = ["notificationId", "userId", "senderId", "senderType", "title", "message", "notificationType", "isRead", "createdAt", "readAt", "data"]
+
+    @field_validator('sender_type')
+    def sender_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USER', 'TEAM', 'ORGANIZATION']):
+            raise ValueError("must be one of enum values ('USER', 'TEAM', 'ORGANIZATION')")
+        return value
+
+    @field_validator('notification_type')
+    def notification_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ADD_TO_ORGANIZATION', 'ADD_TO_TEAM', 'AI_ASSISTANT_SHARED', 'CONVERSATION_SHARED', 'HUMAN_TAKEOVER_ACCEPTED', 'PASSWORD_RESET', 'QUOTA_REACHING', 'QUOTA_REACHED', 'WELCOME']):
+            raise ValueError("must be one of enum values ('ADD_TO_ORGANIZATION', 'ADD_TO_TEAM', 'AI_ASSISTANT_SHARED', 'CONVERSATION_SHARED', 'HUMAN_TAKEOVER_ACCEPTED', 'PASSWORD_RESET', 'QUOTA_REACHING', 'QUOTA_REACHED', 'WELCOME')")
+        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 NotificationDto 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 data
+        if self.data:
+            _dict['data'] = self.data.to_dict()
+        # set to None if data (nullable) is None
+        # and model_fields_set contains the field
+        if self.data is None and "data" in self.model_fields_set:
+            _dict['data'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "notificationId": obj.get("notificationId"),
+            "userId": obj.get("userId"),
+            "senderId": obj.get("senderId"),
+            "senderType": obj.get("senderType"),
+            "title": obj.get("title"),
+            "message": obj.get("message"),
+            "notificationType": obj.get("notificationType"),
+            "isRead": obj.get("isRead") if obj.get("isRead") is not None else False,
+            "createdAt": obj.get("createdAt"),
+            "readAt": obj.get("readAt"),
+            "data": NotificationPayloadDto.from_dict(obj["data"]) if obj.get("data") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/notification_filter.py

@@ -0,0 +1,116 @@
+# 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 date
+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 NotificationFilter(BaseModel):
+    """
+    NotificationFilter
+    """ # noqa: E501
+    user_id: Optional[StrictInt] = Field(default=None, alias="userId")
+    sender_id: Optional[StrictInt] = Field(default=None, alias="senderId")
+    title: Optional[StrictStr] = None
+    message: Optional[StrictStr] = None
+    notification_type: Optional[StrictStr] = Field(default=None, alias="notificationType")
+    is_read: Optional[StrictBool] = Field(default=None, alias="isRead")
+    from_date: Optional[date] = Field(default=None, alias="fromDate")
+    to_date: Optional[date] = Field(default=None, alias="toDate")
+    page: Optional[StrictInt] = None
+    page_size: Optional[StrictInt] = Field(default=None, alias="pageSize")
+    __properties: ClassVar[List[str]] = ["userId", "senderId", "title", "message", "notificationType", "isRead", "fromDate", "toDate", "page", "pageSize"]
+
+    @field_validator('notification_type')
+    def notification_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ADD_TO_ORGANIZATION', 'ADD_TO_TEAM', 'AI_ASSISTANT_SHARED', 'CONVERSATION_SHARED', 'HUMAN_TAKEOVER_ACCEPTED', 'PASSWORD_RESET', 'QUOTA_REACHING', 'QUOTA_REACHED', 'WELCOME']):
+            raise ValueError("must be one of enum values ('ADD_TO_ORGANIZATION', 'ADD_TO_TEAM', 'AI_ASSISTANT_SHARED', 'CONVERSATION_SHARED', 'HUMAN_TAKEOVER_ACCEPTED', 'PASSWORD_RESET', 'QUOTA_REACHING', 'QUOTA_REACHED', 'WELCOME')")
+        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 NotificationFilter 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 NotificationFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "userId": obj.get("userId"),
+            "senderId": obj.get("senderId"),
+            "title": obj.get("title"),
+            "message": obj.get("message"),
+            "notificationType": obj.get("notificationType"),
+            "isRead": obj.get("isRead"),
+            "fromDate": obj.get("fromDate"),
+            "toDate": obj.get("toDate"),
+            "page": obj.get("page"),
+            "pageSize": obj.get("pageSize")
+        })
+        return _obj
+
+

qanswer_sdk/models/notification_list_dto.py

@@ -0,0 +1,101 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.notification_dto import NotificationDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class NotificationListDto(BaseModel):
+    """
+    NotificationListDto
+    """ # noqa: E501
+    notifications: Optional[List[NotificationDto]] = None
+    page: Optional[StrictInt] = None
+    page_size: Optional[StrictInt] = Field(default=None, alias="pageSize")
+    total: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["notifications", "page", "pageSize", "total"]
+
+    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 NotificationListDto 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 notifications (list)
+        _items = []
+        if self.notifications:
+            for _item_notifications in self.notifications:
+                if _item_notifications:
+                    _items.append(_item_notifications.to_dict())
+            _dict['notifications'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of NotificationListDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "notifications": [NotificationDto.from_dict(_item) for _item in obj["notifications"]] if obj.get("notifications") is not None else None,
+            "page": obj.get("page"),
+            "pageSize": obj.get("pageSize"),
+            "total": obj.get("total")
+        })
+        return _obj
+
+