/* Options:
Date: 2025-03-15 05:42:37
Version: 8.30
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://api.sanctionssearch.com/v2

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: AddClientTemplate.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

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

public class dtos
{

    @Route(Path="/clients/template", Verbs="GET")
    @DataContract
    public static class AddClientTemplate extends BaseRequest implements IReturn<AddClientTemplateResponse>
    {
        
        private static Object responseType = AddClientTemplateResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @DataContract
    public static class AddClientTemplateResponse
    {
        @DataMember
        public AddClientTemplateData data = null;
        
        public AddClientTemplateData getData() { return data; }
        public AddClientTemplateResponse setData(AddClientTemplateData value) { this.data = value; return this; }
    }

    @DataContract
    public static class Authentication
    {
        /**
        * The API User ID provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserId = null;

        /**
        * The API User Key provided by us when you signed up to use our API
        */
        @DataMember
        @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
        public String apiUserKey = null;
        
        public String getApiUserId() { return apiUserId; }
        public Authentication setApiUserId(String value) { this.apiUserId = value; return this; }
        public String getApiUserKey() { return apiUserKey; }
        public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; }
    }

    @DataContract
    public static class BaseRequest implements IBaseRequest
    {
        /**
        * The authentication credentials
        */
        @DataMember
        @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        public Authentication authentication = null;
        
        public Authentication getAuthentication() { return authentication; }
        public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; }
    }

    public static interface IBaseRequest
    {
        public Authentication authentication = null;
    }

    public static class AddClientRequest
    {
        /**
        * The full name of the client
        */
        @ApiMember(Description="The full name of the client", IsRequired=true)
        public String name = null;

        /**
        * The email address of the client
        */
        @ApiMember(Description="The email address of the client", IsRequired=true)
        public String email = null;

        /**
        * The client's mobile phone number in international format (e.g. '+447123456789')
        */
        @ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)
        public String mobileInternational = null;

        /**
        * The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine
        */
        @ApiMember(Description="The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine", IsRequired=true)
        public String postCode = null;

        /**
        * Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name
        */
        @ApiMember(Description="Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name", IsRequired=true)
        public CreateMobileClientType proofOfPreset = null;

        /**
        * The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'
        */
        @ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'")
        public ArrayOfProofOfDocumentCategories proofOfDocumentCategories = null;

        /**
        * If the client should be linked to other searches, specify the them here
        */
        @ApiMember(Description="If the client should be linked to other searches, specify the them here")
        public ArrayOfLinkedTo linkedTo = null;
        
        public String getName() { return name; }
        public AddClientRequest setName(String value) { this.name = value; return this; }
        public String getEmail() { return email; }
        public AddClientRequest setEmail(String value) { this.email = value; return this; }
        public String getMobileInternational() { return mobileInternational; }
        public AddClientRequest setMobileInternational(String value) { this.mobileInternational = value; return this; }
        public String getPostCode() { return postCode; }
        public AddClientRequest setPostCode(String value) { this.postCode = value; return this; }
        public CreateMobileClientType getProofOfPreset() { return proofOfPreset; }
        public AddClientRequest setProofOfPreset(CreateMobileClientType value) { this.proofOfPreset = value; return this; }
        public ArrayOfProofOfDocumentCategories getProofOfDocumentCategories() { return proofOfDocumentCategories; }
        public AddClientRequest setProofOfDocumentCategories(ArrayOfProofOfDocumentCategories value) { this.proofOfDocumentCategories = value; return this; }
        public ArrayOfLinkedTo getLinkedTo() { return linkedTo; }
        public AddClientRequest setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; }
    }

    public static class AddClientTemplateData extends BaseResponse
    {
        public AddClientRequest request = null;
        
        public AddClientRequest getRequest() { return request; }
        public AddClientTemplateData setRequest(AddClientRequest value) { this.request = value; return this; }
    }

    public static class ArrayOfProofOfDocumentCategories extends ArrayList<ProofOfDocumentCategory>
    {
        
    }

    @DataContract(Name="CreateMobileClientType", Namespace="http://schemas.servicestack.net/types")
    public static enum CreateMobileClientType
    {
        Undefined,
        ValidateMe,
        PassportChipVerification;
    }

    public static class ArrayOfLinkedTo extends ArrayList<LinkedTo>
    {
        
    }

    public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus
    {
        /**
        * The status of the response
        */
        @ApiMember(Description="The status of the response")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static interface IBaseDataResponse
    {
        public ResponseStatus responseStatus = null;
    }

    public static interface IHasResponseStatus
    {
        public ResponseStatus responseStatus = null;
    }

    public static class ProofOfDocumentCategory
    {
        /**
        * The ID of the ProofOfDocumentCategory
        */
        @ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)
        public Integer id = null;

        /**
        * The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
        */
        @ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)
        public String proofOf = null;

        /**
        * The documents that can be used to provide proof for the specified category.
        */
        @ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)
        public ArrayOfProofOfDocuments proofOfDocuments = null;
        
        public Integer getId() { return id; }
        public ProofOfDocumentCategory setId(Integer value) { this.id = value; return this; }
        public String getProofOf() { return proofOf; }
        public ProofOfDocumentCategory setProofOf(String value) { this.proofOf = value; return this; }
        public ArrayOfProofOfDocuments getProofOfDocuments() { return proofOfDocuments; }
        public ProofOfDocumentCategory setProofOfDocuments(ArrayOfProofOfDocuments value) { this.proofOfDocuments = value; return this; }
    }

    public static class LinkedTo
    {
        public Integer clientId = null;
        public Long id = null;
        public String type = null;
        public String subtype = null;
        public String status = null;
        public String description = null;
        public Boolean isArchived = null;
        public String name = null;
        public Date date = null;
        
        public Integer getClientId() { return clientId; }
        public LinkedTo setClientId(Integer value) { this.clientId = value; return this; }
        public Long getId() { return id; }
        public LinkedTo setId(Long value) { this.id = value; return this; }
        public String getType() { return type; }
        public LinkedTo setType(String value) { this.type = value; return this; }
        public String getSubtype() { return subtype; }
        public LinkedTo setSubtype(String value) { this.subtype = value; return this; }
        public String getStatus() { return status; }
        public LinkedTo setStatus(String value) { this.status = value; return this; }
        public String getDescription() { return description; }
        public LinkedTo setDescription(String value) { this.description = value; return this; }
        public Boolean getIsArchived() { return isArchived; }
        public LinkedTo setIsArchived(Boolean value) { this.isArchived = value; return this; }
        public String getName() { return name; }
        public LinkedTo setName(String value) { this.name = value; return this; }
        public Date getDate() { return date; }
        public LinkedTo setDate(Date value) { this.date = value; return this; }
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

    public static class ArrayOfProofOfDocuments extends ArrayList<ProofOfDocument>
    {
        
    }

    public static class ProofOfDocument
    {
        /**
        * The ID of the ProofOfDocument
        */
        @ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)
        public Integer id = null;

        /**
        * The name of the ProofOfDocument
        */
        @ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)
        public String name = null;
        
        public Integer getId() { return id; }
        public ProofOfDocument setId(Integer value) { this.id = value; return this; }
        public String getName() { return name; }
        public ProofOfDocument setName(String value) { this.name = value; return this; }
    }

}