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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: AddClientTemplate.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

// @DataContract
export class Authentication
{
    /** @description 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 apiUserId: string;

    /** @description 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 apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

export interface IBaseRequest
{
    authentication: Authentication;
}

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

export class ProofOfDocument
{
    /** @description The ID of the ProofOfDocument */
    // @ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)
    public id: number;

    /** @description The name of the ProofOfDocument */
    // @ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)
    public name: string;

    public constructor(init?: Partial<ProofOfDocument>) { (Object as any).assign(this, init); }
}

export class ArrayOfProofOfDocuments extends Array<ProofOfDocument>
{

    public constructor(init?: Partial<ArrayOfProofOfDocuments>) { super(); (Object as any).assign(this, init); }
}

export class ProofOfDocumentCategory
{
    /** @description The ID of the ProofOfDocumentCategory */
    // @ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)
    public id: number;

    /** @description 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 proofOf: string;

    /** @description 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 proofOfDocuments: ArrayOfProofOfDocuments;

    public constructor(init?: Partial<ProofOfDocumentCategory>) { (Object as any).assign(this, init); }
}

export class ArrayOfProofOfDocumentCategories extends Array<ProofOfDocumentCategory>
{

    public constructor(init?: Partial<ArrayOfProofOfDocumentCategories>) { super(); (Object as any).assign(this, init); }
}

export class LinkedTo
{
    public clientId?: number;
    public id?: number;
    public type?: string;
    public subtype?: string;
    public status?: string;
    public description?: string;
    public isArchived?: boolean;
    public name?: string;
    public date?: string;

    public constructor(init?: Partial<LinkedTo>) { (Object as any).assign(this, init); }
}

export class ArrayOfLinkedTo extends Array<LinkedTo>
{

    public constructor(init?: Partial<ArrayOfLinkedTo>) { super(); (Object as any).assign(this, init); }
}

export class AddClientRequest
{
    /** @description The full name of the client */
    // @ApiMember(Description="The full name of the client", IsRequired=true)
    public name: string;

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

    /** @description 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 mobileInternational: string;

    /** @description 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 postCode: string;

    /** @description 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 proofOfPreset: CreateMobileClientType;

    /** @description 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 proofOfDocumentCategories: ArrayOfProofOfDocumentCategories;

    /** @description 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 linkedTo: ArrayOfLinkedTo;

    public constructor(init?: Partial<AddClientRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class AddClientTemplateData extends BaseResponse
{
    public request: AddClientRequest;

    public constructor(init?: Partial<AddClientTemplateData>) { super(init); (Object as any).assign(this, init); }
}

export interface IBaseDataResponse
{
    responseStatus: ResponseStatus;
}

export interface IHasResponseStatus
{
    responseStatus: ResponseStatus;
}

// @DataContract
export class AddClientTemplateResponse
{
    // @DataMember
    public data: AddClientTemplateData;

    public constructor(init?: Partial<AddClientTemplateResponse>) { (Object as any).assign(this, init); }
}

// @Route("/clients/template", "GET")
// @DataContract
export class AddClientTemplate extends BaseRequest implements IReturn<AddClientTemplateResponse>
{

    public constructor(init?: Partial<AddClientTemplate>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'AddClientTemplate'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new AddClientTemplateResponse(); }
}