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

qanswer_sdk/models/response_audit_stats_response.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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.response_audit_model import ResponseAuditModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ResponseAuditStatsResponse(BaseModel):
+    """
+    ResponseAuditStatsResponse
+    """ # noqa: E501
+    response_audits: List[ResponseAuditModel]
+    total: StrictInt
+    limit: StrictInt
+    offset: StrictInt
+    __properties: ClassVar[List[str]] = ["response_audits", "total", "limit", "offset"]
+
+    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 ResponseAuditStatsResponse 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 response_audits (list)
+        _items = []
+        if self.response_audits:
+            for _item_response_audits in self.response_audits:
+                if _item_response_audits:
+                    _items.append(_item_response_audits.to_dict())
+            _dict['response_audits'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ResponseAuditStatsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "response_audits": [ResponseAuditModel.from_dict(_item) for _item in obj["response_audits"]] if obj.get("response_audits") is not None else None,
+            "total": obj.get("total"),
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset")
+        })
+        return _obj
+
+

qanswer_sdk/models/response_get_dummy_union_connector_config_model_api_connectors_config_dummy_models_union_get.py

@@ -0,0 +1,228 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, Dict, Optional
+from qanswer_sdk.models.e_consilium_connector_config import EConsiliumConnectorConfig
+from qanswer_sdk.models.google_drive_connector_config import GoogleDriveConnectorConfig
+from qanswer_sdk.models.microsoft_connector_config import MicrosoftConnectorConfig
+from qanswer_sdk.models.publication_office_connector_config import PublicationOfficeConnectorConfig
+from qanswer_sdk.models.websearch_connector_config import WebsearchConnectorConfig
+from qanswer_sdk.models.website_connector_config import WebsiteConnectorConfig
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RESPONSEGETDUMMYUNIONCONNECTORCONFIGMODELAPICONNECTORSCONFIGDUMMYMODELSUNIONGET_ANY_OF_SCHEMAS = ["Dict[str, object]", "EConsiliumConnectorConfig", "GoogleDriveConnectorConfig", "MicrosoftConnectorConfig", "PublicationOfficeConnectorConfig", "WebsearchConnectorConfig", "WebsiteConnectorConfig"]
+
+class ResponseGetDummyUnionConnectorConfigModelApiConnectorsConfigDummyModelsUnionGet(BaseModel):
+    """
+    ResponseGetDummyUnionConnectorConfigModelApiConnectorsConfigDummyModelsUnionGet
+    """
+
+    # data type: Dict[str, object]
+    anyof_schema_1_validator: Optional[Dict[str, Any]] = None
+    # data type: Dict[str, object]
+    anyof_schema_2_validator: Optional[Dict[str, Any]] = None
+    # data type: WebsiteConnectorConfig
+    anyof_schema_3_validator: Optional[WebsiteConnectorConfig] = None
+    # data type: GoogleDriveConnectorConfig
+    anyof_schema_4_validator: Optional[GoogleDriveConnectorConfig] = None
+    # data type: MicrosoftConnectorConfig
+    anyof_schema_5_validator: Optional[MicrosoftConnectorConfig] = None
+    # data type: WebsearchConnectorConfig
+    anyof_schema_6_validator: Optional[WebsearchConnectorConfig] = None
+    # data type: EConsiliumConnectorConfig
+    anyof_schema_7_validator: Optional[EConsiliumConnectorConfig] = None
+    # data type: PublicationOfficeConnectorConfig
+    anyof_schema_8_validator: Optional[PublicationOfficeConnectorConfig] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[Dict[str, object], EConsiliumConnectorConfig, GoogleDriveConnectorConfig, MicrosoftConnectorConfig, PublicationOfficeConnectorConfig, WebsearchConnectorConfig, WebsiteConnectorConfig]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "Dict[str, object]", "EConsiliumConnectorConfig", "GoogleDriveConnectorConfig", "MicrosoftConnectorConfig", "PublicationOfficeConnectorConfig", "WebsearchConnectorConfig", "WebsiteConnectorConfig" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = ResponseGetDummyUnionConnectorConfigModelApiConnectorsConfigDummyModelsUnionGet.model_construct()
+        error_messages = []
+        # validate data type: Dict[str, object]
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: Dict[str, object]
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: WebsiteConnectorConfig
+        if not isinstance(v, WebsiteConnectorConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `WebsiteConnectorConfig`")
+        else:
+            return v
+
+        # validate data type: GoogleDriveConnectorConfig
+        if not isinstance(v, GoogleDriveConnectorConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `GoogleDriveConnectorConfig`")
+        else:
+            return v
+
+        # validate data type: MicrosoftConnectorConfig
+        if not isinstance(v, MicrosoftConnectorConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `MicrosoftConnectorConfig`")
+        else:
+            return v
+
+        # validate data type: WebsearchConnectorConfig
+        if not isinstance(v, WebsearchConnectorConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `WebsearchConnectorConfig`")
+        else:
+            return v
+
+        # validate data type: EConsiliumConnectorConfig
+        if not isinstance(v, EConsiliumConnectorConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `EConsiliumConnectorConfig`")
+        else:
+            return v
+
+        # validate data type: PublicationOfficeConnectorConfig
+        if not isinstance(v, PublicationOfficeConnectorConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PublicationOfficeConnectorConfig`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ResponseGetDummyUnionConnectorConfigModelApiConnectorsConfigDummyModelsUnionGet with anyOf schemas: Dict[str, object], EConsiliumConnectorConfig, GoogleDriveConnectorConfig, MicrosoftConnectorConfig, PublicationOfficeConnectorConfig, WebsearchConnectorConfig, WebsiteConnectorConfig. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # deserialize data into Dict[str, object]
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into Dict[str, object]
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[WebsiteConnectorConfig] = None
+        try:
+            instance.actual_instance = WebsiteConnectorConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[GoogleDriveConnectorConfig] = None
+        try:
+            instance.actual_instance = GoogleDriveConnectorConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_5_validator: Optional[MicrosoftConnectorConfig] = None
+        try:
+            instance.actual_instance = MicrosoftConnectorConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_6_validator: Optional[WebsearchConnectorConfig] = None
+        try:
+            instance.actual_instance = WebsearchConnectorConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_7_validator: Optional[EConsiliumConnectorConfig] = None
+        try:
+            instance.actual_instance = EConsiliumConnectorConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_8_validator: Optional[PublicationOfficeConnectorConfig] = None
+        try:
+            instance.actual_instance = PublicationOfficeConnectorConfig.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into ResponseGetDummyUnionConnectorConfigModelApiConnectorsConfigDummyModelsUnionGet with anyOf schemas: Dict[str, object], EConsiliumConnectorConfig, GoogleDriveConnectorConfig, MicrosoftConnectorConfig, PublicationOfficeConnectorConfig, WebsearchConnectorConfig, WebsiteConnectorConfig. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], Dict[str, object], EConsiliumConnectorConfig, GoogleDriveConnectorConfig, MicrosoftConnectorConfig, PublicationOfficeConnectorConfig, WebsearchConnectorConfig, WebsiteConnectorConfig]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

qanswer_sdk/models/retention_policy_dto.py

@@ -0,0 +1,106 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.retention_scope_type import RetentionScopeType
+from qanswer_sdk.models.retention_unit import RetentionUnit
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RetentionPolicyDto(BaseModel):
+    """
+    Read view of a stored retention policy.
+    """ # noqa: E501
+    scope_type: RetentionScopeType
+    organization_id: Optional[StrictInt] = None
+    assistant_id: Optional[StrictStr] = None
+    enabled: Optional[StrictBool] = False
+    retention_value: Optional[StrictInt] = None
+    retention_unit: Optional[RetentionUnit] = None
+    last_run_at: Optional[datetime] = None
+    updated_at: Optional[datetime] = None
+    next_run_at: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["scope_type", "organization_id", "assistant_id", "enabled", "retention_value", "retention_unit", "last_run_at", "updated_at", "next_run_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 RetentionPolicyDto 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 RetentionPolicyDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "scope_type": obj.get("scope_type"),
+            "organization_id": obj.get("organization_id"),
+            "assistant_id": obj.get("assistant_id"),
+            "enabled": obj.get("enabled") if obj.get("enabled") is not None else False,
+            "retention_value": obj.get("retention_value"),
+            "retention_unit": obj.get("retention_unit"),
+            "last_run_at": obj.get("last_run_at"),
+            "updated_at": obj.get("updated_at"),
+            "next_run_at": obj.get("next_run_at")
+        })
+        return _obj
+
+

qanswer_sdk/models/retention_policy_update.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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RetentionPolicyUpdate(BaseModel):
+    """
+    Write payload for creating/updating a retention policy at a given scope.
+    """ # noqa: E501
+    enabled: Optional[StrictBool] = False
+    retention_value: Optional[StrictInt] = Field(default=None, description="Required (> 0) when enabled is true.")
+    retention_unit: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["enabled", "retention_value", "retention_unit"]
+
+    @field_validator('retention_unit')
+    def retention_unit_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['days', 'months', 'years']):
+            raise ValueError("must be one of enum values ('days', 'months', 'years')")
+        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 RetentionPolicyUpdate 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 RetentionPolicyUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "enabled": obj.get("enabled") if obj.get("enabled") is not None else False,
+            "retention_value": obj.get("retention_value"),
+            "retention_unit": obj.get("retention_unit")
+        })
+        return _obj
+
+

qanswer_sdk/models/retention_preview_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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RetentionPreviewResponse(BaseModel):
+    """
+    Dry-run count of conversations a scope's effective policy would delete.
+    """ # noqa: E501
+    affected_count: Optional[StrictInt] = 0
+    cutoff_date: Optional[datetime] = None
+    enabled: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["affected_count", "cutoff_date", "enabled"]
+
+    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 RetentionPreviewResponse 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 RetentionPreviewResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "affected_count": obj.get("affected_count") if obj.get("affected_count") is not None else 0,
+            "cutoff_date": obj.get("cutoff_date"),
+            "enabled": obj.get("enabled") if obj.get("enabled") is not None else False
+        })
+        return _obj
+
+