/* Options:
Date: 2024-12-21 18:37:40
Version: 8.12
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://taxfiling.pwc.de

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: SearchCustomers.*
//ExcludeTypes: 
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Represents a service request to query customer data.
*/
@Route(Path="/sync/customers/search", Verbs="GET")
@Api(Description="Represents a service request to query customer data.")
open class SearchCustomers : SearchCustomersBase(), IReturn<CustomerQueryResponse>
{
    /**
    * The unique identifier of the customer.
    */
    @ApiMember(Description="The unique identifier of the customer.")
    var customerId:Int? = null

    /**
    * The name of the customer.
    */
    @ApiMember(Description="The name of the customer.")
    var name:String? = null

    /**
    * Search by using the name of the customer that starts with the specified value.
    */
    @ApiMember(Description="Search by using the name of the customer that starts with the specified value.")
    var nameStartsWith:String? = null

    /**
    * Search by using the name of the customer that ends with the specified value.
    */
    @ApiMember(Description="Search by using the name of the customer that ends with the specified value.")
    var nameEndsWith:String? = null

    /**
    * Search by using the name of the customer that contains the specified value.
    */
    @ApiMember(Description="Search by using the name of the customer that contains the specified value.")
    var nameContains:String? = null

    /**
    * The country of residence or headquarters of customer.
    */
    @ApiMember(Description="The country of residence or headquarters of customer.")
    var country:String? = null

    /**
    * Search by using the country of the customer that starts with the specified value.
    */
    @ApiMember(Description="Search by using the country of the customer that starts with the specified value.")
    var countryStartsWith:String? = null

    /**
    * Search by using the country of the customer that ends with the specified value.
    */
    @ApiMember(Description="Search by using the country of the customer that ends with the specified value.")
    var countryEndsWith:String? = null

    /**
    * Search by using the country of the customer that contains the specified value.
    */
    @ApiMember(Description="Search by using the country of the customer that contains the specified value.")
    var countryContains:String? = null

    /**
    * The type of customer.
    */
    @ApiMember(Description="The type of customer.")
    @SerializedName("type") var Type:CustomerType? = null

    /**
    * Should related accounts be included in the retrieved customers?
    */
    @ApiMember(Description="Should related accounts be included in the retrieved customers?")
    var includeAccounts:Boolean? = null

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

    /**
    * Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
    */
    @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
    var takeAccounts: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 = CustomerQueryResponse::class.java }
    override fun getResponseType(): Any? = SearchCustomers.responseType
}

/**
* Represents a query response that contains a structured error information and encapsulates customers.
*/
@Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
open class CustomerQueryResponse : QueryResponse<Customer>()
{
    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<Customer> = ArrayList<Customer>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var responseStatus:ResponseStatus? = null
}

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

/**
* 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>()
}

enum class CustomerType
{
    Internal,
    Network,
    External,
}

/**
* Specifies a service to search for customers.
*/
@Api(Description="Specifies a service to search for customers.")
open class SearchCustomersBase : PaginationBase(), IGet
{
    /**
    * The unique identifier of the customer.
    */
    @ApiMember(Description="The unique identifier of the customer.")
    var customerId:Int? = null

    /**
    * The name of the customer.
    */
    @ApiMember(Description="The name of the customer.")
    var name:String? = null

    /**
    * Search by using the name of the customer that starts with the specified value.
    */
    @ApiMember(Description="Search by using the name of the customer that starts with the specified value.")
    var nameStartsWith:String? = null

    /**
    * Search by using the name of the customer that ends with the specified value.
    */
    @ApiMember(Description="Search by using the name of the customer that ends with the specified value.")
    var nameEndsWith:String? = null

    /**
    * Search by using the name of the customer that contains the specified value.
    */
    @ApiMember(Description="Search by using the name of the customer that contains the specified value.")
    var nameContains:String? = null

    /**
    * The country of residence or headquarters of customer.
    */
    @ApiMember(Description="The country of residence or headquarters of customer.")
    var country:String? = null

    /**
    * Search by using the country of the customer that starts with the specified value.
    */
    @ApiMember(Description="Search by using the country of the customer that starts with the specified value.")
    var countryStartsWith:String? = null

    /**
    * Search by using the country of the customer that ends with the specified value.
    */
    @ApiMember(Description="Search by using the country of the customer that ends with the specified value.")
    var countryEndsWith:String? = null

    /**
    * Search by using the country of the customer that contains the specified value.
    */
    @ApiMember(Description="Search by using the country of the customer that contains the specified value.")
    var countryContains:String? = null

    /**
    * The type of customer.
    */
    @ApiMember(Description="The type of customer.")
    @SerializedName("type") var Type:CustomerType? = null

    /**
    * Should related accounts be included in the retrieved customers?
    */
    @ApiMember(Description="Should related accounts be included in the retrieved customers?")
    var includeAccounts:Boolean? = null

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

    /**
    * Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
    */
    @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
    var takeAccounts: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 customer (business organization or entrepreneur).
*/
@Api(Description="Represents a customer (business organization or entrepreneur).")
open class Customer : IHasName
{
    /**
    * The unique identifier of the customer.
    */
    @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
    var id:Int? = null

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

    /**
    * Full name or organization name of customer.
    */
    @ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
    @Validate(Validator="NotEmpty")
    var name:String? = null

    /**
    * The country of residence or business of customer.
    */
    @ApiMember(Description="The country of residence or business of customer.")
    var country:String? = null

    /**
    * The type of customer.
    */
    @ApiMember(Description="The type of customer.")
    @SerializedName("type") var Type:CustomerType? = null

    /**
    * The list of user accounts associated with this customer.
    */
    @ApiMember(Description="The list of user accounts associated with this customer.")
    @Ignore()
    var accounts:ArrayList<Account> = ArrayList<Account>()
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var offset:Int? = null

    @DataMember(Order=2)
    var total:Int? = null

    @DataMember(Order=3)
    var results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    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?
}