/* Options:
Date: 2025-03-15 04:53:50
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: AddClient.*
//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(Name="ClientState", Namespace="http://schemas.servicestack.net/types")
export enum ClientState
{
    Undefined = 'Undefined',
    PendingCompletion = 'PendingCompletion',
    PendingOcr = 'PendingOcr',
    PendingVerification = 'PendingVerification',
    Verified = 'Verified',
}

export class Face
{
    public age?: number;
    public gender: string;
    public emotion: string;
    public smile?: number;
    public hairColour: string;
    public facialHair: string;
    public makeup: string;
    public glasses: string;
    public accessories: string;

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

export class VideoTimestamp
{
    public tagName: string;
    public milli?: number;
    public imageUrl: string;

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

export class Video
{
    public id: number;
    public videoUrl: string;
    public imageUrl: string;
    public videoTimestamps: VideoTimestamp[];

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

export class Location
{
    public latitude: number;
    public longitude: number;

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

export class Image
{
    public id: number;
    public name: string;
    public ocrId?: number;
    public url: string;

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

export class ArrayOfImages extends Array<Image>
{

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

export class PassportChipData
{
    public isIssuerVerified: boolean;
    public issuerCommonName: string;
    public issuerOrganisationName: string;
    public issuerCountry: string;
    public mrzLine1: string;
    public mrzLine2: string;
    public isMrzLine1Verified: boolean;
    public isMrzLine2Verified: boolean;
    public dataGroupsVerified: number[];
    public dataGroupsFailed: number[];
    public isFaceMatch: boolean;
    public faceMatchConfidence?: number;

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

export class Passport
{
    public clientFileId: number;
    public firstName: string;
    public middleName: string;
    public lastName: string;
    public dateOfBirth: string;
    public gender: string;
    public mrzLineOne: string;
    public mrzLineTwo1: string;
    public mrzLineTwo2: string;
    public mrzLineTwo3: string;
    public mrzLineTwo4: string;
    public mrzLineTwo5: string;
    public mrzLineTwo6: string;
    public mrzLineTwo7: string;
    public mrzLineTwo8: string;
    public images: ArrayOfImages;
    public isVerified: boolean;
    public isFaceMatch?: boolean;
    public faceMatchConfidence?: number;
    public hasPcvSearch: boolean;
    public hasDfaSearch: boolean;
    public isPassportChipVerified?: boolean;
    public passportChipData: PassportChipData;
    public isEligibleForPcv: boolean;
    public isEligibleForDfa: boolean;

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

export class ArrayOfPassports extends Array<Passport>
{

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

export class DrivingLicence
{
    public clientFileId: number;
    public firstName: string;
    public middleName: string;
    public lastName: string;
    public dateOfBirth: string;
    public address: string;
    public drivingLicenceNumber: string;
    public images: ArrayOfImages;
    public isVerified: boolean;
    public isFaceMatch?: boolean;
    public faceMatchConfidence?: number;
    public hasDfaSearch: boolean;

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

export class ArrayOfDrivingLicences extends Array<DrivingLicence>
{

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

export class OtherDocument
{
    public clientFileId: number;
    public type: string;
    public typeOther: string;
    public description: string;
    public originalImageUrl: string;
    public croppedImageUrl: string;
    public isVerified: boolean;

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

export class ArrayOfOtherDocuments extends Array<OtherDocument>
{

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

export class Client
{
    public id: number;
    public dateCreated: string;
    public name: string;
    public email: string;
    public reference: string;
    public state: ClientState;
    public mobileInternational: string;
    public postCode: string;
    public isValidateMe: boolean;
    public face: Face;
    public video: Video;
    public location: Location;
    public numOfDocuments: number;
    public passports: ArrayOfPassports;
    public drivingLicences: ArrayOfDrivingLicences;
    public otherDocuments: ArrayOfOtherDocuments;
    public proofOfDocumentCategories: ArrayOfProofOfDocumentCategories;

    public constructor(init?: Partial<Client>) { (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 AddClientData extends BaseResponse implements IBaseSearchResponse
{
    public linkedTo: ArrayOfLinkedTo;
    public client: Client;

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

export interface IBaseDataResponse
{
    responseStatus: ResponseStatus;
}

export interface IHasResponseStatus
{
    responseStatus: ResponseStatus;
}

export interface IBaseSearchResponse extends IBaseDataResponse
{
    linkedTo: ArrayOfLinkedTo;
}

// @DataContract
export class AddClientResponse
{
    // @DataMember
    public data: AddClientData;

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

// @Route("/clients", "POST")
// @DataContract
export class AddClient extends BaseRequest implements IReturn<AddClientResponse>
{
    // @DataMember
    public request: AddClientRequest;

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