""" Options:
Date: 2025-04-04 13:29:40
Version: 8.52
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://taxfiling.pwc.de

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: RetrieveAllAccountsAsync.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class IPaginate:
    skip: Optional[int] = None
    take: Optional[int] = None


# @Api(Description="The number of query results to skip.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaginationBase(IPaginate):
    """
    The number of query results to skip.
    """

    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """


# @Api(Description="Specifies a service to retrieve all accounts.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveAllAccountsBase(PaginationBase, IReturn[AccountQueryResponse], IGet):
    """
    Specifies a service to retrieve all accounts.
    """

    # @ApiMember(Description="Should the related products of the accounts be included in the retrieved results?")
    include_products: Optional[bool] = None
    """
    Should the related products of the accounts be included in the retrieved results?
    """


    # @ApiMember(Description="Should the related orders of the accounts be included in the retrieved results?")
    include_orders: Optional[bool] = None
    """
    Should the related orders of the accounts be included in the retrieved results?
    """


    # @ApiMember(Description="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")
    skip_products: Optional[int] = None
    """
    Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. 
    """


    # @ApiMember(Description="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")
    take_products: Optional[int] = None
    """
    Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. 
    """


    # @ApiMember(Description="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")
    skip_orders: Optional[int] = None
    """
    Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. 
    """


    # @ApiMember(Description="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")
    take_orders: Optional[int] = None
    """
    Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. 
    """
    @staticmethod
    def response_type(): return AccountQueryResponse


# @Api(Description="Represents a user account.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Account(IHasUserName):
    """
    Represents a user account.
    """

    # @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    id: int = 0
    """
    The unique identifier of the user account.
    """


    # @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
    index: int = 0
    """
    The position of this instance in a collection of 'Account' instances
    """


    # @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
    ref_id: Optional[int] = None
    """
    The unique identifier of the customer associated with this account.
    """


    # @ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
    ref_id_str: Optional[str] = None
    """
    The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
    """


    # @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    user_name: Optional[str] = None
    """
    The unique user name of the user account.
    """


    # @ApiMember(Description="The electronic mail address of the user account.")
    email: Optional[str] = None
    """
    The electronic mail address of the user account.
    """


    # @ApiMember(Description="The friendly name of the user account.")
    display_name: Optional[str] = None
    """
    The friendly name of the user account.
    """


    # @ApiMember(Description="The first name of the owner (natural person) of the user account.")
    first_name: Optional[str] = None
    """
    The first name of the owner (natural person) of the user account.
    """


    # @ApiMember(Description="The last name of the owner (natural person) of the user account.")
    last_name: Optional[str] = None
    """
    The last name of the owner (natural person) of the user account.
    """


    # @ApiMember(Description="The unique identifier of the customer associated with this account.")
    full_name: Optional[str] = None
    """
    The unique identifier of the customer associated with this account.
    """


    # @ApiMember(Description="The gender of the owner (natural person) of the user account.")
    gender: Optional[str] = None
    """
    The gender of the owner (natural person) of the user account.
    """


    # @ApiMember(Description="The language of the owner of teh user account.")
    language: Optional[str] = None
    """
    The language of the owner of teh user account.
    """


    # @ApiMember(Description="The company, where the user is an employee.")
    company: Optional[str] = None
    """
    The company, where the user is an employee.
    """


    # @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    profile_url: Optional[str] = None
    """
    The profile URL of the user account.
    """


    # @ApiMember(Description="The roles assigned to the user account.")
    roles: List[str] = field(default_factory=list)
    """
    The roles assigned to the user account.
    """


    # @ApiMember(Description="The permissions assigned to the user account.")
    permissions: List[str] = field(default_factory=list)
    """
    The permissions assigned to the user account.
    """


    # @ApiMember(Description="The primary e-mail address of the user.")
    primary_email: Optional[str] = None
    """
    The primary e-mail address of the user.
    """


    # @ApiMember(Description="Random data to enhance the security of the user password.")
    salt: Optional[str] = None
    """
    Random data to enhance the security of the user password.
    """


    # @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
    password_hash: Optional[str] = None
    """
    The hash value of the user password that the PBKDF2 algorithm produces.
    """


    # @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
    digest_ha1_hash: Optional[str] = None
    """
    The hash value of the user password that the DigestHa1 algorithm produces.
    """


    # @ApiMember(Description="The number of times the user account tried to sign in but failed.")
    invalid_login_attempts: int = 0
    """
    The number of times the user account tried to sign in but failed.
    """


    # @ApiMember(Description="The last time the user account attempted a sign in.")
    last_login_attempt: Optional[datetime.datetime] = None
    """
    The last time the user account attempted a sign in.
    """


    # @ApiMember(Description="The date and time when the user acount was denied access.")
    locked_date: Optional[datetime.datetime] = None
    """
    The date and time when the user acount was denied access.
    """


    # @ApiMember(Description="The date and time when the user account was created.")
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date and time when the user account was created.
    """


    # @ApiMember(Description="The date and time when the user account was last modified.")
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date and time when the user account was last modified.
    """


    # @ApiMember(Description="The telephone number of the owner of the user account.")
    phone_number: Optional[str] = None
    """
    The telephone number of the owner of the user account.
    """


    # @ApiMember(Description="The birth date of the owner of the user account")
    birth_date: Optional[datetime.datetime] = None
    """
    The birth date of the owner of the user account
    """


    # @ApiMember(Description="The string representation of the birth date of the user account.")
    birth_date_raw: Optional[str] = None
    """
    The string representation of the birth date of the user account.
    """


    # @ApiMember(Description="The mail address of the user account.")
    address: Optional[str] = None
    """
    The mail address of the user account.
    """


    # @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    address2: Optional[str] = None
    """
    Additional information for the specified 'Address' of the user.
    """


    # @ApiMember(Description="The city of the owner of the user account.")
    city: Optional[str] = None
    """
    The city of the owner of the user account.
    """


    # @ApiMember(Description="The state of the owner of the user account.")
    state: Optional[str] = None
    """
    The state of the owner of the user account.
    """


    # @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
    country: Optional[str] = None
    """
    The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
    """


    # @ApiMember(Description="The locale of the user account.")
    culture: Optional[str] = None
    """
    The locale of the user account.
    """


    # @ApiMember(Description="The mail address of the user account.")
    mail_address: Optional[str] = None
    """
    The mail address of the user account.
    """


    # @ApiMember(Description="The nickname of the user of the user account.")
    nickname: Optional[str] = None
    """
    The nickname of the user of the user account.
    """


    # @ApiMember(Description="The postal code of the user account.")
    postal_code: Optional[str] = None
    """
    The postal code of the user account.
    """


    # @ApiMember(Description="The time zone of the user of the user account.")
    time_zone: Optional[str] = None
    """
    The time zone of the user of the user account.
    """


    # @ApiMember(Description="Additional information to attach to the user account.")
    meta: Optional[Dict[str, str]] = None
    """
    Additional information to attach to the user account.
    """


class IHasUserName:
    """
     Specifies that a data type should have a 'UserName' property.
    """

    user_name: Optional[str] = None


# @Api(Description="Represents a query response that contains a structured error information and encapsulates user accounts.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountQueryResponse(QueryResponse[Account]):
    """
    Represents a query response that contains a structured error information and encapsulates user accounts.
    """

    # @ApiMember(Description="The dictionary of products associated to found user accounts.")
    products_map: Dict[int, List[Product]] = field(default_factory=dict)
    """
    The dictionary of products associated to found user accounts.
    """


    # @ApiMember(Description="The dictionary of orders associated with each found user account.")
    orders_map: Dict[int, List[Order]] = field(default_factory=dict)
    """
    The dictionary of orders associated with each found user account.
    """


# @Route("/async/accounts", "GET")
# @Api(Description="Represents a service request to retrieve all accounts in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveAllAccountsAsync(RetrieveAllAccountsBase, IReturn[AccountQueryResponse]):
    """
    Represents a service request to retrieve all accounts in an asynchronous operation.
    """

    pass