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

qanswer_sdk/models/serve_pdf200_response.py

@@ -0,0 +1,87 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ServePdf200Response(BaseModel):
+    """
+    ServePdf200Response
+    """ # noqa: E501
+    link: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["link"]
+
+    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 ServePdf200Response 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 ServePdf200Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "link": obj.get("link")
+        })
+        return _obj
+
+

qanswer_sdk/models/share_point_connector_settings.py

@@ -0,0 +1,99 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharePointConnectorSettings(BaseModel):
+    """
+    SharePointConnectorSettings
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username owning the connector")
+    dataset: StrictStr = Field(description="Dataset name")
+    connector_id: Annotated[int, Field(strict=True, ge=1)] = Field(description="Connector ID")
+    include_unpublished_pages: Optional[StrictBool] = Field(default=True, description="Whether to include unpublished SharePoint pages when listing or indexing.")
+    enforce_document_permissions: Optional[StrictBool] = Field(default=False, description="Whether to capture SharePoint document ACLs at indexing time and enforce them at query time so each user only sees documents they have access to.")
+    permissions_last_synced_at: Optional[datetime] = Field(default=None, description="When document permissions were most recently fetched for this connector (most recent across its files). Read-only.")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "include_unpublished_pages", "enforce_document_permissions", "permissions_last_synced_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 SharePointConnectorSettings 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 SharePointConnectorSettings 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"),
+            "include_unpublished_pages": obj.get("include_unpublished_pages") if obj.get("include_unpublished_pages") is not None else True,
+            "enforce_document_permissions": obj.get("enforce_document_permissions") if obj.get("enforce_document_permissions") is not None else False,
+            "permissions_last_synced_at": obj.get("permissions_last_synced_at")
+        })
+        return _obj
+
+

qanswer_sdk/models/share_point_download_by_ids.py

@@ -0,0 +1,99 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharePointDownloadByIds(BaseModel):
+    """
+    SharePointDownloadByIds
+    """ # noqa: E501
+    sites: Optional[List[StrictStr]] = None
+    drives: Optional[List[StrictStr]] = None
+    folders: Optional[List[StrictStr]] = None
+    files: Optional[List[StrictStr]] = None
+    pages: Optional[List[StrictStr]] = None
+    notebooks: Optional[List[StrictStr]] = None
+    notes: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["sites", "drives", "folders", "files", "pages", "notebooks", "notes"]
+
+    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 SharePointDownloadByIds 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 SharePointDownloadByIds from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sites": obj.get("sites"),
+            "drives": obj.get("drives"),
+            "folders": obj.get("folders"),
+            "files": obj.get("files"),
+            "pages": obj.get("pages"),
+            "notebooks": obj.get("notebooks"),
+            "notes": obj.get("notes")
+        })
+        return _obj
+
+

qanswer_sdk/models/share_point_download_request.py

@@ -0,0 +1,103 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.share_point_download_by_ids import SharePointDownloadByIds
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharePointDownloadRequest(BaseModel):
+    """
+    SharePointDownloadRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    account_id: Optional[StrictStr] = None
+    connector_id: StrictInt
+    quota: Optional[StrictInt] = Field(default=0, description="Quota of the user")
+    external_sources_quota: Optional[StrictInt] = Field(default=-1, description="Quota of the user for external sources")
+    ids: SharePointDownloadByIds
+    __properties: ClassVar[List[str]] = ["username", "dataset", "account_id", "connector_id", "quota", "external_sources_quota", "ids"]
+
+    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 SharePointDownloadRequest 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 ids
+        if self.ids:
+            _dict['ids'] = self.ids.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SharePointDownloadRequest 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"),
+            "account_id": obj.get("account_id"),
+            "connector_id": obj.get("connector_id"),
+            "quota": obj.get("quota") if obj.get("quota") is not None else 0,
+            "external_sources_quota": obj.get("external_sources_quota") if obj.get("external_sources_quota") is not None else -1,
+            "ids": SharePointDownloadByIds.from_dict(obj["ids"]) if obj.get("ids") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/shared_by.py

@@ -0,0 +1,38 @@
+# 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 SharedBy(str, Enum):
+    """
+    SharedBy
+    """
+
+    """
+    allowed enum values
+    """
+    USER = 'USER'
+    TEAM = 'TEAM'
+    ORGANIZATION = 'ORGANIZATION'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SharedBy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/shared_entity_type.py

@@ -0,0 +1,38 @@
+# 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 SharedEntityType(str, Enum):
+    """
+    SharedEntityType
+    """
+
+    """
+    allowed enum values
+    """
+    USER = 'USER'
+    TEAM = 'TEAM'
+    ORGANIZATION = 'ORGANIZATION'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SharedEntityType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/shared_organization_access_dto.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 pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.access_type_shared import AccessTypeShared
+from qanswer_sdk.models.organization_dto import OrganizationDto
+from qanswer_sdk.models.user_dto import UserDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharedOrganizationAccessDto(BaseModel):
+    """
+    SharedOrganizationAccessDto
+    """ # noqa: E501
+    id: StrictInt
+    organization: Optional[OrganizationDto] = None
+    shared_access_type: Optional[AccessTypeShared] = Field(default=None, alias="sharedAccessType")
+    ai_assistant: Optional[Any] = Field(default=None, alias="aiAssistant")
+    authorized: Optional[StrictBool] = False
+    user_authorized: Optional[UserDto] = Field(default=None, alias="userAuthorized")
+    user_requested_authorization: Optional[UserDto] = Field(default=None, alias="userRequestedAuthorization")
+    __properties: ClassVar[List[str]] = ["id", "organization", "sharedAccessType", "aiAssistant", "authorized", "userAuthorized", "userRequestedAuthorization"]
+
+    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 SharedOrganizationAccessDto 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 organization
+        if self.organization:
+            _dict['organization'] = self.organization.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of user_authorized
+        if self.user_authorized:
+            _dict['userAuthorized'] = self.user_authorized.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of user_requested_authorization
+        if self.user_requested_authorization:
+            _dict['userRequestedAuthorization'] = self.user_requested_authorization.to_dict()
+        # set to None if ai_assistant (nullable) is None
+        # and model_fields_set contains the field
+        if self.ai_assistant is None and "ai_assistant" in self.model_fields_set:
+            _dict['aiAssistant'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SharedOrganizationAccessDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "organization": OrganizationDto.from_dict(obj["organization"]) if obj.get("organization") is not None else None,
+            "sharedAccessType": obj.get("sharedAccessType"),
+            "aiAssistant": obj.get("aiAssistant"),
+            "authorized": obj.get("authorized") if obj.get("authorized") is not None else False,
+            "userAuthorized": UserDto.from_dict(obj["userAuthorized"]) if obj.get("userAuthorized") is not None else None,
+            "userRequestedAuthorization": UserDto.from_dict(obj["userRequestedAuthorization"]) if obj.get("userRequestedAuthorization") is not None else None
+        })
+        return _obj
+
+