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

qanswer_sdk/models/org_user_profile_dto.py

@@ -0,0 +1,210 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.org_role import OrgRole
+from qanswer_sdk.models.organization_admin_dto import OrganizationAdminDto
+from qanswer_sdk.models.pricing_plan import PricingPlan
+from qanswer_sdk.models.role import Role
+from qanswer_sdk.models.user_credits_dto import UserCreditsDto
+from qanswer_sdk.models.user_team_dto import UserTeamDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OrgUserProfileDto(BaseModel):
+    """
+    UserProfileDto extended with org role; organizations is always empty.
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    name: StrictStr
+    email: StrictStr
+    created: Optional[datetime] = None
+    last_login: Optional[datetime] = Field(default=None, alias="lastLogin")
+    selected_org: Optional[StrictInt] = Field(default=None, alias="selectedOrg")
+    can_unselect_org: Optional[StrictBool] = Field(default=None, alias="canUnselectOrg")
+    quota_dataset_number: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumber")
+    quota_dataset_number_used: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumberUsed")
+    quota_dataset_space_mb: Optional[StrictInt] = Field(default=None, alias="quotaDatasetSpaceMb")
+    quota_dataset_space_mb_used: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="quotaDatasetSpaceMbUsed")
+    quota_external_resources: Optional[StrictInt] = Field(default=None, alias="quotaExternalResources")
+    rate_limit_bucket: Optional[StrictInt] = Field(default=None, alias="rateLimitBucket")
+    question_credits_start: Optional[datetime] = Field(default=None, alias="questionCreditsStart")
+    quota_question_credits: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCredits")
+    quota_question_credits_used: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCreditsUsed")
+    credit_capacity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditCapacity")
+    credit_usage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditUsage")
+    role: Optional[List[Role]] = None
+    pricing_plan: Optional[PricingPlan] = Field(default=None, alias="pricingPlan")
+    data_package: Optional[StrictInt] = Field(default=0, alias="dataPackage")
+    pricing_plan_subscription: Optional[datetime] = Field(default=None, alias="pricingPlanSubscription")
+    external_resources_used: Optional[StrictInt] = Field(default=0, alias="externalResourcesUsed")
+    activated: Optional[StrictBool] = False
+    blocked: Optional[StrictBool] = False
+    language: Optional[StrictStr] = None
+    teams: Optional[List[UserTeamDto]] = None
+    organizations: Optional[List[OrganizationAdminDto]] = None
+    origin: Optional[StrictStr] = None
+    enable_enhanced_context_length: Optional[StrictBool] = Field(default=False, alias="enableEnhancedContextLength")
+    enable_llm_file_parsing: Optional[StrictBool] = Field(default=False, alias="enableLLMFileParsing")
+    user_credits: Optional[UserCreditsDto] = Field(default=None, alias="userCredits")
+    user_profile_completed: Optional[StrictBool] = Field(default=False, alias="userProfileCompleted")
+    has_customer_id: Optional[StrictBool] = Field(default=False, alias="hasCustomerId")
+    can_remove_branding: Optional[StrictBool] = Field(default=False, alias="canRemoveBranding")
+    company: Optional[StrictStr] = None
+    position: Optional[StrictStr] = None
+    country: Optional[StrictStr] = None
+    phone: Optional[StrictStr] = None
+    oauth_logged: Optional[StrictBool] = Field(default=False, alias="oauthLogged")
+    org_role: OrgRole = Field(alias="orgRole")
+    __properties: ClassVar[List[str]] = ["id", "username", "name", "email", "created", "lastLogin", "selectedOrg", "canUnselectOrg", "quotaDatasetNumber", "quotaDatasetNumberUsed", "quotaDatasetSpaceMb", "quotaDatasetSpaceMbUsed", "quotaExternalResources", "rateLimitBucket", "questionCreditsStart", "quotaQuestionCredits", "quotaQuestionCreditsUsed", "creditCapacity", "creditUsage", "role", "pricingPlan", "dataPackage", "pricingPlanSubscription", "externalResourcesUsed", "activated", "blocked", "language", "teams", "organizations", "origin", "enableEnhancedContextLength", "enableLLMFileParsing", "userCredits", "userProfileCompleted", "hasCustomerId", "canRemoveBranding", "company", "position", "country", "phone", "oauthLogged", "orgRole"]
+
+    @field_validator('language')
+    def language_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['en', 'fr', 'de']):
+            raise ValueError("must be one of enum values ('en', 'fr', 'de')")
+        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 OrgUserProfileDto 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 role (list)
+        _items = []
+        if self.role:
+            for _item_role in self.role:
+                if _item_role:
+                    _items.append(_item_role.to_dict())
+            _dict['role'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in teams (list)
+        _items = []
+        if self.teams:
+            for _item_teams in self.teams:
+                if _item_teams:
+                    _items.append(_item_teams.to_dict())
+            _dict['teams'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in organizations (list)
+        _items = []
+        if self.organizations:
+            for _item_organizations in self.organizations:
+                if _item_organizations:
+                    _items.append(_item_organizations.to_dict())
+            _dict['organizations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of user_credits
+        if self.user_credits:
+            _dict['userCredits'] = self.user_credits.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OrgUserProfileDto 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"),
+            "username": obj.get("username"),
+            "name": obj.get("name"),
+            "email": obj.get("email"),
+            "created": obj.get("created"),
+            "lastLogin": obj.get("lastLogin"),
+            "selectedOrg": obj.get("selectedOrg"),
+            "canUnselectOrg": obj.get("canUnselectOrg"),
+            "quotaDatasetNumber": obj.get("quotaDatasetNumber"),
+            "quotaDatasetNumberUsed": obj.get("quotaDatasetNumberUsed"),
+            "quotaDatasetSpaceMb": obj.get("quotaDatasetSpaceMb"),
+            "quotaDatasetSpaceMbUsed": obj.get("quotaDatasetSpaceMbUsed"),
+            "quotaExternalResources": obj.get("quotaExternalResources"),
+            "rateLimitBucket": obj.get("rateLimitBucket"),
+            "questionCreditsStart": obj.get("questionCreditsStart"),
+            "quotaQuestionCredits": obj.get("quotaQuestionCredits"),
+            "quotaQuestionCreditsUsed": obj.get("quotaQuestionCreditsUsed"),
+            "creditCapacity": obj.get("creditCapacity"),
+            "creditUsage": obj.get("creditUsage"),
+            "role": [Role.from_dict(_item) for _item in obj["role"]] if obj.get("role") is not None else None,
+            "pricingPlan": obj.get("pricingPlan"),
+            "dataPackage": obj.get("dataPackage") if obj.get("dataPackage") is not None else 0,
+            "pricingPlanSubscription": obj.get("pricingPlanSubscription"),
+            "externalResourcesUsed": obj.get("externalResourcesUsed") if obj.get("externalResourcesUsed") is not None else 0,
+            "activated": obj.get("activated") if obj.get("activated") is not None else False,
+            "blocked": obj.get("blocked") if obj.get("blocked") is not None else False,
+            "language": obj.get("language"),
+            "teams": [UserTeamDto.from_dict(_item) for _item in obj["teams"]] if obj.get("teams") is not None else None,
+            "organizations": [OrganizationAdminDto.from_dict(_item) for _item in obj["organizations"]] if obj.get("organizations") is not None else None,
+            "origin": obj.get("origin"),
+            "enableEnhancedContextLength": obj.get("enableEnhancedContextLength") if obj.get("enableEnhancedContextLength") is not None else False,
+            "enableLLMFileParsing": obj.get("enableLLMFileParsing") if obj.get("enableLLMFileParsing") is not None else False,
+            "userCredits": UserCreditsDto.from_dict(obj["userCredits"]) if obj.get("userCredits") is not None else None,
+            "userProfileCompleted": obj.get("userProfileCompleted") if obj.get("userProfileCompleted") is not None else False,
+            "hasCustomerId": obj.get("hasCustomerId") if obj.get("hasCustomerId") is not None else False,
+            "canRemoveBranding": obj.get("canRemoveBranding") if obj.get("canRemoveBranding") is not None else False,
+            "company": obj.get("company"),
+            "position": obj.get("position"),
+            "country": obj.get("country"),
+            "phone": obj.get("phone"),
+            "oauthLogged": obj.get("oauthLogged") if obj.get("oauthLogged") is not None else False,
+            "orgRole": obj.get("orgRole")
+        })
+        return _obj
+
+

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

qanswer_sdk/models/organization_admin_dto.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OrganizationAdminDto(BaseModel):
+    """
+    OrganizationAdminDto
+    """ # noqa: E501
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    website: Optional[StrictStr] = None
+    id: StrictInt
+    admin: Optional[StrictBool] = False
+    selected: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["name", "description", "website", "id", "admin", "selected"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of OrganizationAdminDto 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 OrganizationAdminDto 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"),
+            "website": obj.get("website"),
+            "id": obj.get("id"),
+            "admin": obj.get("admin") if obj.get("admin") is not None else False,
+            "selected": obj.get("selected") if obj.get("selected") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/organization_creation_dto.py

@@ -0,0 +1,91 @@
+# 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 OrganizationCreationDto(BaseModel):
+    """
+    OrganizationCreationDto
+    """ # noqa: E501
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    website: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "description", "website"]
+
+    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 OrganizationCreationDto 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 OrganizationCreationDto 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"),
+            "website": obj.get("website")
+        })
+        return _obj
+
+

qanswer_sdk/models/organization_dto.py

@@ -0,0 +1,93 @@
+# 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 OrganizationDto(BaseModel):
+    """
+    OrganizationDto
+    """ # noqa: E501
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    website: Optional[StrictStr] = None
+    id: StrictInt
+    __properties: ClassVar[List[str]] = ["name", "description", "website", "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 OrganizationDto 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 OrganizationDto 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"),
+            "website": obj.get("website"),
+            "id": obj.get("id")
+        })
+        return _obj
+
+