/* Options:
Date: 2024-11-29 15:37:50
Version: 8.12
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://taxfiling.staging.pwc.de

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: RetrieveAccountAsync.*
//ExcludeTypes: 
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents a service request to retrieve an account in an asynchronous operation.
*/
@Route(Path="/async/accounts/retrieve", Verbs="GET")
@Api(Description="Represents a service request to retrieve an account in an asynchronous operation.")
open class RetrieveAccountAsync : RetrieveAccountBase(), IReturn<AccountResponse>
{
    /**
    * The user name of the account.
    */
    @ApiMember(Description="The user name of the account.")
    var userName:String? = null

    /**
    * Should the related products of the account be included in the retrieved account?
    */
    @ApiMember(Description="Should the related products of the account be included in the retrieved account?")
    var includeProducts:Boolean? = null

    /**
    * Should the related orders of the account be included in the retrieved account?
    */
    @ApiMember(Description="Should the related orders of the account be included in the retrieved account?")
    var includeOrders:Boolean? = null

    /**
    * Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. 
    */
    @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ")
    var skipProducts:Int? = null

    /**
    * Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. 
    */
    @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ")
    var takeProducts:Int? = null

    /**
    * Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. 
    */
    @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
    var skipOrders:Int? = null

    /**
    * Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. 
    */
    @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
    var takeOrders:Int? = null

    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
    companion object { private val responseType = AccountResponse::class.java }
    override fun getResponseType(): Any? = RetrieveAccountAsync.responseType
}

/**
* Represents a service response that contains a structured error information and encapsulates a user account.
*/
@Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.")
open class AccountResponse : ServiceResponseBase()
{
    /**
    * The user account encapsulated in the response.
    */
    @ApiMember(Description="The user account encapsulated in the response.")
    var account:Account? = null

    /**
    * The index position of the reponse in a collection, if it were returned together with other responses.
    */
    @ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")
    var index:Long? = null

    /**
    * The list of products associated with the encapsulated user account.
    */
    @ApiMember(Description="The list of products associated with the encapsulated user account.")
    var products:ArrayList<Product> = ArrayList<Product>()

    /**
    * The list of orders associated with the encapsulated user account.
    */
    @ApiMember(Description="The list of orders associated with the encapsulated user account.")
    var orders:ArrayList<Order> = ArrayList<Order>()

    /**
    * Data structure that holds error information from a service operation.
    */
    @ApiMember(Description="Data structure that holds error information from a service operation.")
    var responseStatus:ResponseStatus? = null
}

open interface IPaginate
{
    var skip:Int?
    var take:Int?
}

/**
* Specifies a service request to retrieve an account.
*/
@Api(Description="Specifies a service request to retrieve an account.")
open class RetrieveAccountBase : PaginationBase(), IGet
{
    /**
    * The user name of the account.
    */
    @ApiMember(Description="The user name of the account.")
    var userName:String? = null

    /**
    * Should the related products of the account be included in the retrieved account?
    */
    @ApiMember(Description="Should the related products of the account be included in the retrieved account?")
    var includeProducts:Boolean? = null

    /**
    * Should the related orders of the account be included in the retrieved account?
    */
    @ApiMember(Description="Should the related orders of the account be included in the retrieved account?")
    var includeOrders:Boolean? = null

    /**
    * Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. 
    */
    @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ")
    var skipProducts:Int? = null

    /**
    * Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. 
    */
    @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ")
    var takeProducts:Int? = null

    /**
    * Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. 
    */
    @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
    var skipOrders:Int? = null

    /**
    * Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. 
    */
    @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
    var takeOrders:Int? = null

    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
* Represents a user account.
*/
@Api(Description="Represents a user account.")
open class Account : IHasUserName
{
    /**
    * The unique identifier of the user account.
    */
    @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    var id:Int? = null

    /**
    * The position of this instance in a collection of 'Account' instances
    */
    @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
    var index:Int? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
    var refId:Int? = null

    /**
    * 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 string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
    var refIdStr:String? = null

    /**
    * The unique user name of the user account.
    */
    @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    var userName:String? = null

    /**
    * The electronic mail address of the user account.
    */
    @ApiMember(Description="The electronic mail address of the user account.")
    var email:String? = null

    /**
    * The friendly name of the user account.
    */
    @ApiMember(Description="The friendly name of the user account.")
    var displayName:String? = null

    /**
    * The first name of the owner (natural person) of the user account.
    */
    @ApiMember(Description="The first name of the owner (natural person) of the user account.")
    var firstName:String? = null

    /**
    * The last name of the owner (natural person) of the user account.
    */
    @ApiMember(Description="The last name of the owner (natural person) of the user account.")
    var lastName:String? = null

    /**
    * The unique identifier of the customer associated with this account.
    */
    @ApiMember(Description="The unique identifier of the customer associated with this account.")
    var fullName:String? = null

    /**
    * The gender of the owner (natural person) of the user account.
    */
    @ApiMember(Description="The gender of the owner (natural person) of the user account.")
    var gender:String? = null

    /**
    * The language of the owner of teh user account.
    */
    @ApiMember(Description="The language of the owner of teh user account.")
    var language:String? = null

    /**
    * The company, where the user is an employee.
    */
    @ApiMember(Description="The company, where the user is an employee.")
    var company:String? = null

    /**
    * The profile URL of the user account.
    */
    @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    var profileUrl:String? = null

    /**
    * The roles assigned to the user account.
    */
    @ApiMember(Description="The roles assigned to the user account.")
    var roles:ArrayList<String> = ArrayList<String>()

    /**
    * The permissions assigned to the user account.
    */
    @ApiMember(Description="The permissions assigned to the user account.")
    var permissions:ArrayList<String> = ArrayList<String>()

    /**
    * The primary e-mail address of the user.
    */
    @ApiMember(Description="The primary e-mail address of the user.")
    var primaryEmail:String? = null

    /**
    * Random data to enhance the security of the user password.
    */
    @ApiMember(Description="Random data to enhance the security of the user password.")
    var salt:String? = null

    /**
    * The hash value of the user password that the PBKDF2 algorithm produces.
    */
    @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
    var passwordHash:String? = null

    /**
    * The hash value of the user password that the DigestHa1 algorithm produces.
    */
    @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
    var digestHa1Hash:String? = null

    /**
    * The number of times the user account tried to sign in but failed.
    */
    @ApiMember(Description="The number of times the user account tried to sign in but failed.")
    var invalidLoginAttempts:Int? = null

    /**
    * The last time the user account attempted a sign in.
    */
    @ApiMember(Description="The last time the user account attempted a sign in.")
    var lastLoginAttempt:Date? = null

    /**
    * The date and time when the user acount was denied access.
    */
    @ApiMember(Description="The date and time when the user acount was denied access.")
    var lockedDate:Date? = null

    /**
    * The date and time when the user account was created.
    */
    @ApiMember(Description="The date and time when the user account was created.")
    var createdDate:Date? = null

    /**
    * The date and time when the user account was last modified.
    */
    @ApiMember(Description="The date and time when the user account was last modified.")
    var modifiedDate:Date? = null

    /**
    * The telephone number of the owner of the user account.
    */
    @ApiMember(Description="The telephone number of the owner of the user account.")
    var phoneNumber:String? = null

    /**
    * The birth date of the owner of the user account
    */
    @ApiMember(Description="The birth date of the owner of the user account")
    var birthDate:Date? = null

    /**
    * The string representation of the birth date of the user account.
    */
    @ApiMember(Description="The string representation of the birth date of the user account.")
    var birthDateRaw:String? = null

    /**
    * The mail address of the user account.
    */
    @ApiMember(Description="The mail address of the user account.")
    var address:String? = null

    /**
    * Additional information for the specified 'Address' of the user.
    */
    @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    var address2:String? = null

    /**
    * The city of the owner of the user account.
    */
    @ApiMember(Description="The city of the owner of the user account.")
    var city:String? = null

    /**
    * The state of the owner of the user account.
    */
    @ApiMember(Description="The state of the owner of the user account.")
    var state:String? = null

    /**
    * The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
    */
    @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
    var country:String? = null

    /**
    * The locale of the user account.
    */
    @ApiMember(Description="The locale of the user account.")
    var culture:String? = null

    /**
    * The mail address of the user account.
    */
    @ApiMember(Description="The mail address of the user account.")
    var mailAddress:String? = null

    /**
    * The nickname of the user of the user account.
    */
    @ApiMember(Description="The nickname of the user of the user account.")
    var nickname:String? = null

    /**
    * The postal code of the user account.
    */
    @ApiMember(Description="The postal code of the user account.")
    var postalCode:String? = null

    /**
    * The time zone of the user of the user account.
    */
    @ApiMember(Description="The time zone of the user of the user account.")
    var timeZone:String? = null

    /**
    * Additional information to attach to the user account.
    */
    @ApiMember(Description="Additional information to attach to the user account.")
    var meta:HashMap<String,String> = HashMap<String,String>()
}

/**
* Represents a product.
*/
@Api(Description="Represents a product.")
open class Product : IHasName
{
    /**
    * The unique identifier of the product.
    */
    @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    var id:Int? = null

    /**
    * The position of this instance in a collection of 'Product' instances
    */
    @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
    var index:Int? = null

    /**
    * The name of the product.
    */
    @ApiMember(Description="The name of the product.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The version of the product.
    */
    @ApiMember(Description="The version of the product.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var version:String? = null

    /**
    * The version of the product.
    */
    @ApiMember(Description="The version of the product.")
    var description:String? = null

    /**
    * Tags associated with the product.
    */
    @ApiMember(Description="Tags associated with the product.")
    var tags:ArrayList<String> = ArrayList<String>()
}

/**
* Represents a commission to consume services.
*/
@Api(Description="Represents a commission to consume services.")
open class Order : IHasName
{
    /**
    * The unique identifier of the order.
    */
    @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    var id:Int? = null

    /**
    * The unique identifier of the product, for which the order is made.
    */
    @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
    var productId:Int? = null

    /**
    * The unique identifier of the user account, who placed the order.
    */
    @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
    var accountId:Int? = null

    /**
    * A name to identify the order.
    */
    @ApiMember(Description="A name to identify the order.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The name of the service, for which the order was made.
    */
    @ApiMember(Description="The name of the service, for which the order was made.")
    var serviceName:String? = null

    /**
    * The time stamp at which the order was initiated.
    */
    @ApiMember(Description="The time stamp at which the order was initiated.")
    var requestTimestamp:Date? = null

    /**
    * The time stamp at which the order was completed.
    */
    @ApiMember(Description="The time stamp at which the order was completed.")
    var responseTimestamp:Date? = null

    /**
    * The URI from which the order was initiated.
    */
    @ApiMember(Description="The URI from which the order was initiated.")
    var requestUri:String? = null

    /**
    * The HTTP method of the order request.
    */
    @ApiMember(Description="The HTTP method of the order request.")
    var requestHttpMethod:String? = null

    /**
    * The duration of the order request.
    */
    @ApiMember(Description="The duration of the order request.")
    var requestDuration:TimeSpan? = null

    /**
    * The HTTP status code of the order request.
    */
    @ApiMember(Description="The HTTP status code of the order request.")
    var responseStatusCode:HttpStatusCode? = null

    /**
    * The IP address of client, who placed the order.
    */
    @ApiMember(Description="The IP address of client, who placed the order.")
    var clientIPAddress:String? = null

    /**
    * The unit of measurement for the order.
    */
    @ApiMember(Description="The unit of measurement for the order.")
    var unitOfMeasurement:String? = null

    /**
    * The type of process, for which the order is charged.
    */
    @ApiMember(Description="The type of process, for which the order is charged.")
    var processType:String? = null

    /**
    * The type of data, for which the order is charged.
    */
    @ApiMember(Description="The type of data, for which the order is charged.")
    var dataType:String? = null

    /**
    * The name of the data, for which the order is charged.
    */
    @ApiMember(Description="The name of the data, for which the order is charged.")
    var dataName:String? = null

    /**
    * The date of creation of the order.
    */
    @ApiMember(Description="The date of creation of the order.")
    var creationDate:Date? = null

    /**
    * The final date to retain the order in the records. After this date, the order is expunged from the records.
    */
    @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
    var expiryDate:Date? = null

    /**
    * Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.
    */
    @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
    var isTest:Boolean? = null
}

/**
* Specifies a base service response class that contains a structured error information.
*/
@Api(Description="Specifies a base service response class that contains a structured error information.")
open class ServiceResponseBase
{
    /**
    * Data structure that holds error information from a service operation.
    */
    @ApiMember(Description="Data structure that holds error information from a service operation.")
    var responseStatus:ResponseStatus? = null
}

/**
* The number of query results to skip.
*/
@Api(Description="The number of query results to skip.")
open class PaginationBase : IPaginate
{
    /**
    * The number of query results to skip.
    */
    @ApiMember(Description="The number of query results to skip.")
    var skip:Int? = null

    /**
    * The number of query results to include.
    */
    @ApiMember(Description="The number of query results to include.")
    var take:Int? = null
}

/**
*  Specifies that a data type should have a 'UserName' property.
*/
open interface IHasUserName
{
    var userName:String?
}

/**
*  Specifies that a data type should have a 'Name' property.
*/
open interface IHasName
{
    /**
    * The 'Name' property.
    */
    var name:String?
}

enum class HttpStatusCode(val value:Int)
{
    Continue(100),
    SwitchingProtocols(101),
    Processing(102),
    EarlyHints(103),
    Ok(200),
    Created(201),
    Accepted(202),
    NonAuthoritativeInformation(203),
    NoContent(204),
    ResetContent(205),
    PartialContent(206),
    MultiStatus(207),
    AlreadyReported(208),
    ImUsed(226),
    MultipleChoices(300),
    Ambiguous(300),
    MovedPermanently(301),
    Moved(301),
    Found(302),
    Redirect(302),
    SeeOther(303),
    RedirectMethod(303),
    NotModified(304),
    UseProxy(305),
    Unused(306),
    TemporaryRedirect(307),
    RedirectKeepVerb(307),
    PermanentRedirect(308),
    BadRequest(400),
    Unauthorized(401),
    PaymentRequired(402),
    Forbidden(403),
    NotFound(404),
    MethodNotAllowed(405),
    NotAcceptable(406),
    ProxyAuthenticationRequired(407),
    RequestTimeout(408),
    Conflict(409),
    Gone(410),
    LengthRequired(411),
    PreconditionFailed(412),
    RequestEntityTooLarge(413),
    RequestUriTooLong(414),
    UnsupportedMediaType(415),
    RequestedRangeNotSatisfiable(416),
    ExpectationFailed(417),
    MisdirectedRequest(421),
    UnprocessableEntity(422),
    UnprocessableContent(422),
    Locked(423),
    FailedDependency(424),
    UpgradeRequired(426),
    PreconditionRequired(428),
    TooManyRequests(429),
    RequestHeaderFieldsTooLarge(431),
    UnavailableForLegalReasons(451),
    InternalServerError(500),
    NotImplemented(501),
    BadGateway(502),
    ServiceUnavailable(503),
    GatewayTimeout(504),
    HttpVersionNotSupported(505),
    VariantAlsoNegotiates(506),
    InsufficientStorage(507),
    LoopDetected(508),
    NotExtended(510),
    NetworkAuthenticationRequired(511),
}