/* Options:
Date: 2025-03-15 04:18:31
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: AddDbsSearch.*
//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="/dbs", Verbs="POST")
    @DataContract
    public static class AddDbsSearch extends BaseRequest implements IReturn<AddDbsSearchResponse>
    {
        @DataMember
        public AddDbsSearchRequest request = null;
        
        public AddDbsSearchRequest getRequest() { return request; }
        public AddDbsSearch setRequest(AddDbsSearchRequest value) { this.request = value; return this; }
        private static Object responseType = AddDbsSearchResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @DataContract
    public static class AddDbsSearchResponse
    {
        @DataMember
        public AddDbsSearchData data = null;
        
        public AddDbsSearchData getData() { return data; }
        public AddDbsSearchResponse setData(AddDbsSearchData 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 AddDbsSearchRequest
    {
        /**
        * The full name of the applicant
        */
        @ApiMember(Description="The full name of the applicant", IsRequired=true)
        public String name = null;

        /**
        * The date of birth for the applicant (DD/MM/YYYY format)
        */
        @ApiMember(Description="The date of birth for the applicant (DD/MM/YYYY format)", IsRequired=true)
        public String dateOfBirth = null;

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

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

        /**
        * The country where the job is located
        */
        @ApiMember(Description="The country where the job is located", IsRequired=true)
        public String jobLocation = null;

        /**
        * The disclosure level of the DBS required
        */
        @ApiMember(Description="The disclosure level of the DBS required", IsRequired=true)
        public String disclosureLevel = null;

        /**
        * Your reference, if any
        */
        @ApiMember(Description="Your reference, if any")
        public String reference = null;

        /**
        * If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account
        */
        @ApiMember(Description="If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account")
        public String subUserName = null;

        /**
        * If the search should be linked to other searches, specify the them here
        */
        @ApiMember(Description="If the search should be linked to other searches, specify the them here")
        public ArrayOfLinkedTo linkedTo = null;
        
        public String getName() { return name; }
        public AddDbsSearchRequest setName(String value) { this.name = value; return this; }
        public String getDateOfBirth() { return dateOfBirth; }
        public AddDbsSearchRequest setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
        public String getEmail() { return email; }
        public AddDbsSearchRequest setEmail(String value) { this.email = value; return this; }
        public String getMobileInternational() { return mobileInternational; }
        public AddDbsSearchRequest setMobileInternational(String value) { this.mobileInternational = value; return this; }
        public String getJobLocation() { return jobLocation; }
        public AddDbsSearchRequest setJobLocation(String value) { this.jobLocation = value; return this; }
        public String getDisclosureLevel() { return disclosureLevel; }
        public AddDbsSearchRequest setDisclosureLevel(String value) { this.disclosureLevel = value; return this; }
        public String getReference() { return reference; }
        public AddDbsSearchRequest setReference(String value) { this.reference = value; return this; }
        public String getSubUserName() { return subUserName; }
        public AddDbsSearchRequest setSubUserName(String value) { this.subUserName = value; return this; }
        public ArrayOfLinkedTo getLinkedTo() { return linkedTo; }
        public AddDbsSearchRequest setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; }
    }

    public static class AddDbsSearchData extends BaseResponse implements IBaseSearchResponse
    {
        public ArrayOfLinkedTo linkedTo = null;
        public DbsSearchSummary summary = null;
        
        public ArrayOfLinkedTo getLinkedTo() { return linkedTo; }
        public AddDbsSearchData setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; }
        public DbsSearchSummary getSummary() { return summary; }
        public AddDbsSearchData setSummary(DbsSearchSummary value) { this.summary = value; return this; }
    }

    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 interface IBaseSearchResponse implements IBaseDataResponse
    {
        public ArrayOfLinkedTo linkedTo = null;
    }

    public static class DbsSearchSummary
    {
        public Long id = null;
        public Date dateSearched = null;
        public Date dateUpdated = null;
        public String status = null;
        public String disclosureStatus = null;
        public Boolean isApplicantInfoCompleted = null;
        public Boolean isIdCheckCompleted = null;
        public Boolean isApplicationCompleted = null;
        public Boolean isApplicationSubmitted = null;
        public Boolean isApplicationDisclosed = null;
        public String disclosureLevel = null;
        public ApplicantInformation applicantInformation = null;
        
        public Long getId() { return id; }
        public DbsSearchSummary setId(Long value) { this.id = value; return this; }
        public Date getDateSearched() { return dateSearched; }
        public DbsSearchSummary setDateSearched(Date value) { this.dateSearched = value; return this; }
        public Date getDateUpdated() { return dateUpdated; }
        public DbsSearchSummary setDateUpdated(Date value) { this.dateUpdated = value; return this; }
        public String getStatus() { return status; }
        public DbsSearchSummary setStatus(String value) { this.status = value; return this; }
        public String getDisclosureStatus() { return disclosureStatus; }
        public DbsSearchSummary setDisclosureStatus(String value) { this.disclosureStatus = value; return this; }
        public Boolean getIsApplicantInfoCompleted() { return isApplicantInfoCompleted; }
        public DbsSearchSummary setIsApplicantInfoCompleted(Boolean value) { this.isApplicantInfoCompleted = value; return this; }
        public Boolean getIsIdCheckCompleted() { return isIdCheckCompleted; }
        public DbsSearchSummary setIsIdCheckCompleted(Boolean value) { this.isIdCheckCompleted = value; return this; }
        public Boolean getIsApplicationCompleted() { return isApplicationCompleted; }
        public DbsSearchSummary setIsApplicationCompleted(Boolean value) { this.isApplicationCompleted = value; return this; }
        public Boolean getIsApplicationSubmitted() { return isApplicationSubmitted; }
        public DbsSearchSummary setIsApplicationSubmitted(Boolean value) { this.isApplicationSubmitted = value; return this; }
        public Boolean getIsApplicationDisclosed() { return isApplicationDisclosed; }
        public DbsSearchSummary setIsApplicationDisclosed(Boolean value) { this.isApplicationDisclosed = value; return this; }
        public String getDisclosureLevel() { return disclosureLevel; }
        public DbsSearchSummary setDisclosureLevel(String value) { this.disclosureLevel = value; return this; }
        public ApplicantInformation getApplicantInformation() { return applicantInformation; }
        public DbsSearchSummary setApplicantInformation(ApplicantInformation value) { this.applicantInformation = 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 ApplicantInformation
    {
        public String name = null;
        public String dateOfBirth = null;
        public String email = null;
        public String mobileInternational = null;
        public String jobLocation = null;
        public String reference = null;
        
        public String getName() { return name; }
        public ApplicantInformation setName(String value) { this.name = value; return this; }
        public String getDateOfBirth() { return dateOfBirth; }
        public ApplicantInformation setDateOfBirth(String value) { this.dateOfBirth = value; return this; }
        public String getEmail() { return email; }
        public ApplicantInformation setEmail(String value) { this.email = value; return this; }
        public String getMobileInternational() { return mobileInternational; }
        public ApplicantInformation setMobileInternational(String value) { this.mobileInternational = value; return this; }
        public String getJobLocation() { return jobLocation; }
        public ApplicantInformation setJobLocation(String value) { this.jobLocation = value; return this; }
        public String getReference() { return reference; }
        public ApplicantInformation setReference(String value) { this.reference = value; return this; }
    }

}