/* Options:
Date: 2024-06-03 09:23:47
Version: 8.12
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://taxfiling.pwc.de

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: BatchRegisterCustomersAsync.*
//ExcludeTypes: 
//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.*;

public class dtos
{

    /**
    * Represents a service request to register one or more customers in a batch operation.
    */
    @Route(Path="/async/customers/batch", Verbs="POST")
    @Api(Description="Represents a service request to register one or more customers in a batch operation.")
    public static class BatchRegisterCustomersAsync extends BatchRegisterCustomersBase implements IReturn<ArrayList<CustomerResponse>>
    {
        /**
        * The customers to register.
        */
        @ApiMember(Description="The customers to register.", IsRequired=true)
        public ArrayList<Customer> customers = null;
        
        public ArrayList<Customer> getCustomers() { return customers; }
        public BatchRegisterCustomersAsync setCustomers(ArrayList<Customer> value) { this.customers = value; return this; }
        private static Object responseType = new TypeToken<ArrayList<CustomerResponse>>(){}.getType();
        public Object getResponseType() { return responseType; }
    }

    /**
    * Represents a user account.
    */
    @Api(Description="Represents a user account.")
    public static class Account implements IHasUserName
    {
        /**
        * The unique identifier of the user account.
        */
        @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
        public Integer id = 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)
        public Integer index = 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)
        public Integer refId = 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'.")
        public String refIdStr = null;

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

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

        /**
        * The friendly name of the user account.
        */
        @ApiMember(Description="The friendly name of the user account.")
        public String displayName = 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.")
        public String firstName = 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.")
        public String lastName = null;

        /**
        * The unique identifier of the customer associated with this account.
        */
        @ApiMember(Description="The unique identifier of the customer associated with this account.")
        public String fullName = 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.")
        public String gender = null;

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

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

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

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

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

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

        /**
        * Random data to enhance the security of the user password.
        */
        @ApiMember(Description="Random data to enhance the security of the user password.")
        public String salt = 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.")
        public String passwordHash = 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.")
        public String digestHa1Hash = 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.")
        public Integer invalidLoginAttempts = null;

        /**
        * The last time the user account attempted a sign in.
        */
        @ApiMember(Description="The last time the user account attempted a sign in.")
        public Date lastLoginAttempt = 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.")
        public Date lockedDate = null;

        /**
        * The date and time when the user account was created.
        */
        @ApiMember(Description="The date and time when the user account was created.")
        public Date createdDate = 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.")
        public Date modifiedDate = null;

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

        /**
        * The birth date of the owner of the user account
        */
        @ApiMember(Description="The birth date of the owner of the user account")
        public Date birthDate = 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.")
        public String birthDateRaw = null;

        /**
        * The mail address of the user account.
        */
        @ApiMember(Description="The mail address of the user account.")
        public String address = null;

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

        /**
        * The city of the owner of the user account.
        */
        @ApiMember(Description="The city of the owner of the user account.")
        public String city = null;

        /**
        * The state of the owner of the user account.
        */
        @ApiMember(Description="The state of the owner of the user account.")
        public String state = 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'.")
        public String country = null;

        /**
        * The locale of the user account.
        */
        @ApiMember(Description="The locale of the user account.")
        public String culture = null;

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

        /**
        * The nickname of the user of the user account.
        */
        @ApiMember(Description="The nickname of the user of the user account.")
        public String nickname = null;

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

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

        /**
        * Additional information to attach to the user account.
        */
        @ApiMember(Description="Additional information to attach to the user account.")
        public HashMap<String,String> meta = null;
        
        public Integer getId() { return id; }
        public Account setId(Integer value) { this.id = value; return this; }
        public Integer getIndex() { return index; }
        public Account setIndex(Integer value) { this.index = value; return this; }
        public Integer getRefId() { return refId; }
        public Account setRefId(Integer value) { this.refId = value; return this; }
        public String getRefIdStr() { return refIdStr; }
        public Account setRefIdStr(String value) { this.refIdStr = value; return this; }
        public String getUserName() { return userName; }
        public Account setUserName(String value) { this.userName = value; return this; }
        public String getEmail() { return email; }
        public Account setEmail(String value) { this.email = value; return this; }
        public String getDisplayName() { return displayName; }
        public Account setDisplayName(String value) { this.displayName = value; return this; }
        public String getFirstName() { return firstName; }
        public Account setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public Account setLastName(String value) { this.lastName = value; return this; }
        public String getFullName() { return fullName; }
        public Account setFullName(String value) { this.fullName = value; return this; }
        public String getGender() { return gender; }
        public Account setGender(String value) { this.gender = value; return this; }
        public String getLanguage() { return language; }
        public Account setLanguage(String value) { this.language = value; return this; }
        public String getCompany() { return company; }
        public Account setCompany(String value) { this.company = value; return this; }
        public String getProfileUrl() { return profileUrl; }
        public Account setProfileUrl(String value) { this.profileUrl = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public Account setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public ArrayList<String> getPermissions() { return permissions; }
        public Account setPermissions(ArrayList<String> value) { this.permissions = value; return this; }
        public String getPrimaryEmail() { return primaryEmail; }
        public Account setPrimaryEmail(String value) { this.primaryEmail = value; return this; }
        public String getSalt() { return salt; }
        public Account setSalt(String value) { this.salt = value; return this; }
        public String getPasswordHash() { return passwordHash; }
        public Account setPasswordHash(String value) { this.passwordHash = value; return this; }
        public String getDigestHa1Hash() { return digestHa1Hash; }
        public Account setDigestHa1Hash(String value) { this.digestHa1Hash = value; return this; }
        public Integer getInvalidLoginAttempts() { return invalidLoginAttempts; }
        public Account setInvalidLoginAttempts(Integer value) { this.invalidLoginAttempts = value; return this; }
        public Date getLastLoginAttempt() { return lastLoginAttempt; }
        public Account setLastLoginAttempt(Date value) { this.lastLoginAttempt = value; return this; }
        public Date getLockedDate() { return lockedDate; }
        public Account setLockedDate(Date value) { this.lockedDate = value; return this; }
        public Date getCreatedDate() { return createdDate; }
        public Account setCreatedDate(Date value) { this.createdDate = value; return this; }
        public Date getModifiedDate() { return modifiedDate; }
        public Account setModifiedDate(Date value) { this.modifiedDate = value; return this; }
        public String getPhoneNumber() { return phoneNumber; }
        public Account setPhoneNumber(String value) { this.phoneNumber = value; return this; }
        public Date getBirthDate() { return birthDate; }
        public Account setBirthDate(Date value) { this.birthDate = value; return this; }
        public String getBirthDateRaw() { return birthDateRaw; }
        public Account setBirthDateRaw(String value) { this.birthDateRaw = value; return this; }
        public String getAddress() { return address; }
        public Account setAddress(String value) { this.address = value; return this; }
        public String getAddress2() { return address2; }
        public Account setAddress2(String value) { this.address2 = value; return this; }
        public String getCity() { return city; }
        public Account setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public Account setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public Account setCountry(String value) { this.country = value; return this; }
        public String getCulture() { return culture; }
        public Account setCulture(String value) { this.culture = value; return this; }
        public String getMailAddress() { return mailAddress; }
        public Account setMailAddress(String value) { this.mailAddress = value; return this; }
        public String getNickname() { return nickname; }
        public Account setNickname(String value) { this.nickname = value; return this; }
        public String getPostalCode() { return postalCode; }
        public Account setPostalCode(String value) { this.postalCode = value; return this; }
        public String getTimeZone() { return timeZone; }
        public Account setTimeZone(String value) { this.timeZone = value; return this; }
        public HashMap<String,String> getMeta() { return meta; }
        public Account setMeta(HashMap<String,String> value) { this.meta = value; return this; }
    }

    public static enum CustomerType
    {
        Internal,
        Network,
        External;
    }

    /**
    * Represents a customer (business organization or entrepreneur).
    */
    @Api(Description="Represents a customer (business organization or entrepreneur).")
    public static class Customer implements IHasName
    {
        /**
        * The unique identifier of the customer.
        */
        @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
        public Integer id = 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)
        public Integer index = null;

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

        /**
        * The country of residence or business of customer.
        */
        @ApiMember(Description="The country of residence or business of customer.")
        public String country = null;

        /**
        * The type of customer.
        */
        @ApiMember(Description="The type of customer.")
        public CustomerType type = null;

        /**
        * The list of user accounts associated with this customer.
        */
        @ApiMember(Description="The list of user accounts associated with this customer.")
        @Ignore()
        public ArrayList<Account> accounts = null;
        
        public Integer getId() { return id; }
        public Customer setId(Integer value) { this.id = value; return this; }
        public Integer getIndex() { return index; }
        public Customer setIndex(Integer value) { this.index = value; return this; }
        public String getName() { return name; }
        public Customer setName(String value) { this.name = value; return this; }
        public String getCountry() { return country; }
        public Customer setCountry(String value) { this.country = value; return this; }
        public CustomerType getType() { return type; }
        public Customer setType(CustomerType value) { this.type = value; return this; }
        public ArrayList<Account> getAccounts() { return accounts; }
        public Customer setAccounts(ArrayList<Account> value) { this.accounts = value; return this; }
    }

    /**
    * Specifies a base service request to register one or more customers in a batch operation.
    */
    @Api(Description="Specifies a base service request to register one or more customers in a batch operation.")
    public static class BatchRegisterCustomersBase implements IPost
    {
        /**
        * The customers to register.
        */
        @ApiMember(Description="The customers to register.", IsRequired=true)
        public ArrayList<Customer> customers = null;
        
        public ArrayList<Customer> getCustomers() { return customers; }
        public BatchRegisterCustomersBase setCustomers(ArrayList<Customer> value) { this.customers = value; return this; }
    }

    /**
    * 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.")
    public static class ServiceResponseBase
    {
        /**
        * Data structure that holds error information from a service operation.
        */
        @ApiMember(Description="Data structure that holds error information from a service operation.")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ServiceResponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    /**
    *  Specifies that a data type should have a 'UserName' property.
    */
    public static interface IHasUserName
    {
        public String userName = null;
    }

    /**
    *  Specifies that a data type should have a 'Name' property.
    */
    public static interface IHasName
    {
        /**
        * The 'Name' property.
        */
        public String name = null;
    }

    /**
    * Represents a response from a service operation that encapsulates customer data.
    */
    @Api(Description="Represents a response from a service operation that encapsulates customer data.")
    public static class CustomerResponse extends ServiceResponseBase
    {
        /**
        * The customer data of the response.
        */
        @ApiMember(Description="The customer data of the response.")
        public Customer customer = 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.")
        public Long index = null;

        /**
        * Data structure that holds error information from a service operation.
        */
        @ApiMember(Description="Data structure that holds error information from a service operation.")
        public ResponseStatus responseStatus = null;
        
        public Customer getCustomer() { return customer; }
        public CustomerResponse setCustomer(Customer value) { this.customer = value; return this; }
        public Long getIndex() { return index; }
        public CustomerResponse setIndex(Long value) { this.index = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public CustomerResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}