/* Options:
Date: 2025-03-15 05:15:39
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: GetDbsSearches.*
//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
{

    @Route(Path="/dbs", Verbs="GET")
    @DataContract
    public static class GetDbsSearches extends PagedRequest implements IReturn<GetDbsSearchesResponse>
    {
        /**
        * Filter the results to those that have a Name including the specified value
        */
        @DataMember
        @ApiMember(Description="Filter the results to those that have a Name including the specified value", ParameterType="query")
        public String name = null;

        /**
        * Filter the results to those that were created after (or on) this date
        */
        @DataMember
        @ApiMember(Description="Filter the results to those that were created after (or on) this date", ParameterType="query")
        public Date dateFrom = null;

        /**
        * Filter the results to those that were created before this date
        */
        @DataMember
        @ApiMember(Description="Filter the results to those that were created before this date", ParameterType="query")
        public Date dateTo = null;

        /**
        * Filter the results to those where the applicant has provided their information (true), or not (false), or either (null)
        */
        @DataMember
        @ApiMember(Description="Filter the results to those where the applicant has provided their information (true), or not (false), or either (null)", ParameterType="query")
        public Boolean isApplicantInfoCompleted = null;

        /**
        * Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null)
        */
        @DataMember
        @ApiMember(Description="Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null)", ParameterType="query")
        public Boolean isIdCheckCompleted = null;

        /**
        * Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null)
        */
        @DataMember
        @ApiMember(Description="Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null)", ParameterType="query")
        public Boolean isApplicationCompleted = null;

        /**
        * Filter the results to those where the application has been submitted (true), or not (false), or either (null)
        */
        @DataMember
        @ApiMember(Description="Filter the results to those where the application has been submitted (true), or not (false), or either (null)", ParameterType="query")
        public Boolean isApplicationSubmitted = null;

        /**
        * Filter the results to those where the application has been disclosed (true), or not (false), or either (null)
        */
        @DataMember
        @ApiMember(Description="Filter the results to those where the application has been disclosed (true), or not (false), or either (null)", ParameterType="query")
        public Boolean isApplicationDisclosed = null;

        /**
        * If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
        */
        @DataMember
        @ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view", ParameterType="query")
        public String subUserName = null;
        
        public String getName() { return name; }
        public GetDbsSearches setName(String value) { this.name = value; return this; }
        public Date getDateFrom() { return dateFrom; }
        public GetDbsSearches setDateFrom(Date value) { this.dateFrom = value; return this; }
        public Date getDateTo() { return dateTo; }
        public GetDbsSearches setDateTo(Date value) { this.dateTo = value; return this; }
        public Boolean getIsApplicantInfoCompleted() { return isApplicantInfoCompleted; }
        public GetDbsSearches setIsApplicantInfoCompleted(Boolean value) { this.isApplicantInfoCompleted = value; return this; }
        public Boolean getIsIdCheckCompleted() { return isIdCheckCompleted; }
        public GetDbsSearches setIsIdCheckCompleted(Boolean value) { this.isIdCheckCompleted = value; return this; }
        public Boolean getIsApplicationCompleted() { return isApplicationCompleted; }
        public GetDbsSearches setIsApplicationCompleted(Boolean value) { this.isApplicationCompleted = value; return this; }
        public Boolean getIsApplicationSubmitted() { return isApplicationSubmitted; }
        public GetDbsSearches setIsApplicationSubmitted(Boolean value) { this.isApplicationSubmitted = value; return this; }
        public Boolean getIsApplicationDisclosed() { return isApplicationDisclosed; }
        public GetDbsSearches setIsApplicationDisclosed(Boolean value) { this.isApplicationDisclosed = value; return this; }
        public String getSubUserName() { return subUserName; }
        public GetDbsSearches setSubUserName(String value) { this.subUserName = value; return this; }
        private static Object responseType = GetDbsSearchesResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @DataContract
    public static class GetDbsSearchesResponse
    {
        @DataMember
        public GetDbsSearchesData data = null;
        
        public GetDbsSearchesData getData() { return data; }
        public GetDbsSearchesResponse setData(GetDbsSearchesData 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;
    }

    @DataContract
    public static class PagedRequest extends BaseRequest
    {
        /**
        * The maximum number of records to be returned in one page
        */
        @DataMember(Name="page[limit]")
        @SerializedName("page[limit]")
        @ApiMember(Description="The maximum number of records to be returned in one page", ParameterType="query")
        public Integer pageLimit = null;

        /**
        * The starting point in the list of records from where the data should be fetched. Zero based index.
        */
        @DataMember(Name="page[offset]")
        @SerializedName("page[offset]")
        @ApiMember(Description="The starting point in the list of records from where the data should be fetched. Zero based index.", ParameterType="query")
        public Integer pageOffset = null;

        /**
        * The term to determine the order in which the data is returned
        */
        @DataMember
        @ApiMember(Description="The term to determine the order in which the data is returned", ParameterType="query")
        public String sort = null;
        
        public Integer getPageLimit() { return pageLimit; }
        public PagedRequest setPageLimit(Integer value) { this.pageLimit = value; return this; }
        public Integer getPageOffset() { return pageOffset; }
        public PagedRequest setPageOffset(Integer value) { this.pageOffset = value; return this; }
        public String getSort() { return sort; }
        public PagedRequest setSort(String value) { this.sort = value; return this; }
    }

    public static class GetDbsSearchesData extends PagedResponse<GetDbsSearches>
    {
        public ArrayOfDbsSearchShort searches = null;
        
        public ArrayOfDbsSearchShort getSearches() { return searches; }
        public GetDbsSearchesData setSearches(ArrayOfDbsSearchShort value) { this.searches = value; return this; }
    }

    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 Meta<T>
    {
        /**
        * Pagination links
        */
        @ApiMember(Description="Pagination links")
        public MetaLinks links = null;

        /**
        * The total number of records for the query
        */
        @ApiMember(Description="The total number of records for the query")
        public Integer totalCount = null;

        /**
        * The maximum number of records to be returned in one page
        */
        @ApiMember(Description="The maximum number of records to be returned in one page")
        public Integer pageLimit = null;

        /**
        * The starting point in the list of records from where the data should be fetched. Zero based index.
        */
        @ApiMember(Description="The starting point in the list of records from where the data should be fetched. Zero based index.")
        public Integer pageOffset = null;
        
        public MetaLinks getLinks() { return links; }
        public Meta<T> setLinks(MetaLinks value) { this.links = value; return this; }
        public Integer getTotalCount() { return totalCount; }
        public Meta<T> setTotalCount(Integer value) { this.totalCount = value; return this; }
        public Integer getPageLimit() { return pageLimit; }
        public Meta<T> setPageLimit(Integer value) { this.pageLimit = value; return this; }
        public Integer getPageOffset() { return pageOffset; }
        public Meta<T> setPageOffset(Integer value) { this.pageOffset = value; return this; }
    }

    public static class PagedResponse<T> extends BaseResponse
    {
        /**
        * The response Metadata
        */
        @ApiMember(Description="The response Metadata")
        public Meta<T> meta = null;
        
        public Meta<T> getMeta() { return meta; }
        public PagedResponse<T> setMeta(Meta<T> value) { this.meta = value; return this; }
    }

    public static class ArrayOfDbsSearchShort extends ArrayList<DbsSearchShort>
    {
        
    }

    public static class ArrayOfResponseError extends ArrayList<ResponseError>
    {
        
    }

    public static class MetaLinks extends Links
    {
        /**
        * The link to the first page of records
        */
        @ApiMember(Description="The link to the first page of records")
        public String first = null;

        /**
        * The link to the last page of records
        */
        @ApiMember(Description="The link to the last page of records")
        public String last = null;

        /**
        * The link to the next page of records, if applicable
        */
        @ApiMember(Description="The link to the next page of records, if applicable")
        public String next = null;

        /**
        * The link to the last page of records, if applicable
        */
        @ApiMember(Description="The link to the last page of records, if applicable")
        public String prev = null;
        
        public String getFirst() { return first; }
        public MetaLinks setFirst(String value) { this.first = value; return this; }
        public String getLast() { return last; }
        public MetaLinks setLast(String value) { this.last = value; return this; }
        public String getNext() { return next; }
        public MetaLinks setNext(String value) { this.next = value; return this; }
        public String getPrev() { return prev; }
        public MetaLinks setPrev(String value) { this.prev = value; return this; }
    }

    public static class DbsSearchShort
    {
        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 String name = null;
        public String reference = null;
        
        public Long getId() { return id; }
        public DbsSearchShort setId(Long value) { this.id = value; return this; }
        public Date getDateSearched() { return dateSearched; }
        public DbsSearchShort setDateSearched(Date value) { this.dateSearched = value; return this; }
        public Date getDateUpdated() { return dateUpdated; }
        public DbsSearchShort setDateUpdated(Date value) { this.dateUpdated = value; return this; }
        public String getStatus() { return status; }
        public DbsSearchShort setStatus(String value) { this.status = value; return this; }
        public String getDisclosureStatus() { return disclosureStatus; }
        public DbsSearchShort setDisclosureStatus(String value) { this.disclosureStatus = value; return this; }
        public Boolean getIsApplicantInfoCompleted() { return isApplicantInfoCompleted; }
        public DbsSearchShort setIsApplicantInfoCompleted(Boolean value) { this.isApplicantInfoCompleted = value; return this; }
        public Boolean getIsIdCheckCompleted() { return isIdCheckCompleted; }
        public DbsSearchShort setIsIdCheckCompleted(Boolean value) { this.isIdCheckCompleted = value; return this; }
        public Boolean getIsApplicationCompleted() { return isApplicationCompleted; }
        public DbsSearchShort setIsApplicationCompleted(Boolean value) { this.isApplicationCompleted = value; return this; }
        public Boolean getIsApplicationSubmitted() { return isApplicationSubmitted; }
        public DbsSearchShort setIsApplicationSubmitted(Boolean value) { this.isApplicationSubmitted = value; return this; }
        public Boolean getIsApplicationDisclosed() { return isApplicationDisclosed; }
        public DbsSearchShort setIsApplicationDisclosed(Boolean value) { this.isApplicationDisclosed = value; return this; }
        public String getDisclosureLevel() { return disclosureLevel; }
        public DbsSearchShort setDisclosureLevel(String value) { this.disclosureLevel = value; return this; }
        public String getName() { return name; }
        public DbsSearchShort setName(String value) { this.name = value; return this; }
        public String getReference() { return reference; }
        public DbsSearchShort setReference(String value) { this.reference = value; return this; }
    }

    public static class Links
    {
        @ApiMember()
        public String self = null;
        
        public String getSelf() { return self; }
        public Links setSelf(String value) { this.self = value; return this; }
    }

}