/* Options:
Date: 2025-03-15 06:14:28
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: GetCompanyLookup.*
//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;
}

export class GetCompanyLookupRequest
{
    /** @description If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it */
    // @ApiMember(Description="If the search is being accessed by a sub user, specify their username here to validate they have permissions to view it")
    public subUserName: string;

    public id: number;

    public constructor(init?: Partial<GetCompanyLookupRequest>) { (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 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 SearchCriteria
{
    public name: string;
    public address: string;
    public country: string;
    public dateOfBirth: string;
    public nationality: string;
    public reference: string;

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

export class ArrayOfLists extends Array<string>
{

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

export class CompanyDirectorOrShareholder
{
    public id: number;
    public searchType: string;
    public dateSearched: string;
    public dateUpdated: string;
    public numOfResults: number;
    public clientInResults: boolean;
    public clientNotInResults: boolean;
    public affectedByUpdate: boolean;
    public searchCriteria: SearchCriteria;
    public isDirector: boolean;
    public isShareholder: boolean;

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

export class SearchSource
{
    public listId: string;
    public listName: string;
    public listShortName: string;
    public isAffectedByListUpdate?: boolean;

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

export class SearchListItem
{
    public id: number;
    public searchType: string;
    public dateSearched: string;
    public dateUpdated: string;
    public dateArchived?: string;
    public isArchived: boolean;
    public numOfResults: number;
    public clientInResults: boolean;
    public clientNotInResults: boolean;
    public affectedByUpdate: boolean;
    public searchCriteria: SearchCriteria;
    public searchSources: SearchSource[];

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

export class CompanyLookupEnhancedLatestAccounts
{
    public currency: string;
    public turnover?: number;
    public shareholdersEquity?: number;
    public creditRating?: number;
    public creditLimit?: number;
    public creditRatingDescription: string;
    public accountRefDay?: number;
    public accountRefMonth?: number;
    public accountNextDueDate?: string;
    public accountLastMadeUpDate?: string;
    public accountCategory: string;
    public returnLastMadeUpDate?: string;

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

export class CompanyLookupEnhancedSummary
{
    public name: string;
    public country: string;
    public registrationNumber: string;
    public dateOfIncorporation: string;
    public typeOfIncorporation: string;
    public companyStatus: string;
    public address: string;
    public telephone: string;
    public sicCode: string;
    public sicDescription: string;
    public principleActivity: string;
    public latestAccounts: CompanyLookupEnhancedLatestAccounts;

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

export class CompanyLookupEnhancedAddress
{
    public fullAddress: string;
    public address1: string;
    public address2: string;
    public address3: string;
    public address4: string;
    public postCode: string;
    public telephone: string;

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

export class CompanyLookupEnhancedWebsite
{
    public website: string;

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

export class CompanyLookupEnhancedAdditionalContact
{
    public telephone: string;
    public faxNumber: string;
    public emailAddress: string;
    public webAddress: string;
    public twitter: string;
    public facebook: string;
    public googlePlus: string;
    public linkedIn: string;
    public contactName: string;
    public businessClassification: string;

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

export class CompanyLookupEnhancedContactInfo
{
    public registeredAddress: CompanyLookupEnhancedAddress;
    public tradingAddresses: CompanyLookupEnhancedAddress[];
    public websites: CompanyLookupEnhancedWebsite[];
    public additionalContactInfo: CompanyLookupEnhancedAdditionalContact;

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

export class CompanyLookupEnhancedSicCode
{
    public sicCode2003?: number;
    public sicCode2003Description: string;
    public sicCode2007?: number;
    public sicCode2007Description: string;
    public status: string;

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

export class CompanyLookupEnhancedPreviousName
{
    public dateChanged?: string;
    public name: string;

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

export class CompanyLookupEnhancedShareholder
{
    public title: string;
    public forename: string;
    public surname: string;
    public address1: string;
    public address2: string;
    public address3: string;
    public address4: string;
    public address5: string;
    public postCode: string;
    public shareType: string;
    public number?: number;
    public value?: number;
    public currency: string;
    public shareholderType: string;
    public shareClass: string;

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

export class CompanyLookupEnhancedShareStructure
{
    public issuedShareCapital?: number;
    public shareholders: CompanyLookupEnhancedShareholder[];

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

export class CompanyLookupEnhancedDirector
{
    public name: string;
    public address: string;
    public gender: string;
    public appointmentDate?: string;
    public resignationDate?: string;
    public dateOfBirth?: string;
    public position: string;
    public idNumber?: number;
    public currentDirectorships?: number;
    public previousDirectorships?: number;
    public totalDirectorships?: number;

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

export class CompanyLookupEnhancedDirectors
{
    public currentDirectors: CompanyLookupEnhancedDirector[];
    public previousDirectors: CompanyLookupEnhancedDirector[];

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

export class CompanyLookupEnhancedCompany
{
    public country: string;
    public companyName: string;
    public companyNumber: string;

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

export class CompanyLookupEnhancedStructure
{
    public parentCompanies: CompanyLookupEnhancedCompany[];
    public subsidiaryCompanies: CompanyLookupEnhancedCompany[];

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

export class CompanyLookupEnhancedCCJ
{
    public date?: string;
    public court: string;
    public amount?: number;
    public caseNumber: string;
    public status: string;
    public datePaid: string;
    public incomingRecordDetails: string;

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

export class CompanyLookupEnhancedCCJs
{
    public possibleCCJs: CompanyLookupEnhancedCCJ[];
    public exactCCJs: CompanyLookupEnhancedCCJ[];

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

export class CompanyLookupEnhancedEvent
{
    public date?: string;
    public description: string;

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

export class CompanyLookupEnhancedCommentary
{
    public text: string;
    public positiveOrNegative: string;
    public priority?: number;

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

export class CompanyLookupEnhancedCreditLimit
{
    public date?: string;
    public dateOrder?: number;
    public amount?: number;

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

export class CompanyLookupEnhancedCreditRating
{
    public date?: string;
    public dateOrder?: number;
    public amount?: number;
    public shortDescription: string;
    public description: string;

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

export class CompanyLookupEnhancedCreditAccount
{
    public creditLimitHistory: CompanyLookupEnhancedCreditLimit[];
    public creditRatingHistory: CompanyLookupEnhancedCreditRating[];

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

export class CompanyLookupFinancialProfit
{
    public turnover?: number;
    public export?: number;
    public costOfSales?: number;
    public grossProfit?: number;
    public wagesAndSalaries?: number;
    public directorEmolument?: number;
    public operatingProfit?: number;
    public depreciation?: number;
    public auditFees?: number;
    public interestPayments?: number;
    public pretaxProfit?: number;
    public taxation?: number;
    public profitAfterTax?: number;
    public dividendsPayable?: number;
    public retainedProfit?: number;

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

export class CompanyLookupFinancialBalance
{
    public tangibleAccounts?: number;
    public intangibleAssets?: number;
    public totalFixedAssets?: number;
    public stock?: number;
    public tradeDebtors?: number;
    public cash?: number;
    public otherDebtors?: number;
    public miscCurrentAssets?: number;
    public totalCurrentAssets?: number;
    public tradeCreditors?: number;
    public bankLoansAndOverdrafts?: number;
    public otherShortTermFinance?: number;
    public miscCurrentLiabilities?: number;
    public totalCurrentLiabilities?: number;
    public bankLoansAndOverdraftsAndLTL?: number;
    public otherLongTermFinance?: number;
    public totalLongTermFinance?: number;

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

export class CompanyLookupFinancialCapital
{
    public calledUpSharedCapital?: number;
    public profitAndLossAccountReserve?: number;
    public revaluationReserve?: number;
    public sundryReserves?: number;
    public shareholderFunds?: number;

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

export class CompanyLookupFinancialOther
{
    public netWorth?: number;
    public netAssets?: number;
    public workingCapital?: number;
    public totalAssets?: number;
    public totalLiabilities?: number;

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

export class CompanyLookupFinancialCash
{
    public netCashFlowFromOperations?: number;
    public netCashFlowBeforeFinancing?: number;
    public netCashFlowFromFinancing?: number;
    public increaseInCash?: number;

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

export class CompanyLookupFinancialMisc
{
    public contingentLiability: string;
    public capitalEmployed?: number;
    public numberOfEmployees?: number;
    public auditors: string;
    public auditorComments: string;
    public bankers: string;
    public bankBranchCode: string;

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

export class CompanyLookupFinancialRatios
{
    public preTaxProfitMargin?: number;
    public currentRatio?: number;
    public salesNetworkingCapital?: number;
    public gearing?: number;
    public equity?: number;
    public creditorDays?: number;
    public debtorDays?: number;
    public liquidityAcidTest?: number;
    public returnOnCapitalEmployed?: number;
    public returnOnNetAssetsEmployed?: number;
    public returnOnTotalAssetsEmployed?: number;
    public currentDebtRatio?: number;
    public totalDebtRatio?: number;
    public stockTurnoverRatio?: number;

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

export class CompanyLookupEnhancedFinancialStatement
{
    public yearEndDateOrder?: number;
    public yearEndDate?: string;
    public summaryNumberOfWeeks?: number;
    public summaryCurrency: string;
    public summaryConsolidatedAccount: string;
    public profitAndLoss: CompanyLookupFinancialProfit;
    public balanceSheet: CompanyLookupFinancialBalance;
    public capitalAndReserves: CompanyLookupFinancialCapital;
    public other: CompanyLookupFinancialOther;
    public cash: CompanyLookupFinancialCash;
    public misc: CompanyLookupFinancialMisc;
    public ratios: CompanyLookupFinancialRatios;

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

export class CompanyLookupEnhanced
{
    public summary: CompanyLookupEnhancedSummary;
    public contactInformation: CompanyLookupEnhancedContactInfo;
    public sicCodes: CompanyLookupEnhancedSicCode[];
    public previousNames: CompanyLookupEnhancedPreviousName[];
    public shareStructure: CompanyLookupEnhancedShareStructure;
    public directors: CompanyLookupEnhancedDirectors;
    public groupStructure: CompanyLookupEnhancedStructure;
    public countyCourtJudgements: CompanyLookupEnhancedCCJs;
    public eventHistory: CompanyLookupEnhancedEvent[];
    public commentaries: CompanyLookupEnhancedCommentary[];
    public creditAccounts: CompanyLookupEnhancedCreditAccount;
    public financialStatements: CompanyLookupEnhancedFinancialStatement[];

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

export class CompanyLookupSearchRecord
{
    public id: number;
    public searchCriteria: SearchCriteria;
    public selectedLists: ArrayOfLists;
    public date: string;
    public hasCompanyId: boolean;
    public hasCompanyDetails: boolean;
    public hasStartedSearches: boolean;
    public hasCompletedSearches: boolean;
    public companyDirectorsAndShareholders: CompanyDirectorOrShareholder[];
    public companySearchRecord: SearchListItem;
    public hasEnhancedInformation: boolean;
    public enhancedInformation: CompanyLookupEnhanced;

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

export class GetCompanyLookupData extends BaseResponse implements IBaseSearchResponse
{
    public linkedTo: ArrayOfLinkedTo;
    public searchRecord: CompanyLookupSearchRecord;

    public constructor(init?: Partial<GetCompanyLookupData>) { 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 GetCompanyLookupResponse
{
    // @DataMember
    public data: GetCompanyLookupData;

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

// @Route("/companylookups/get", "POST")
// @DataContract
export class GetCompanyLookup extends BaseRequest implements IReturn<GetCompanyLookupResponse>
{
    // @DataMember
    public request: GetCompanyLookupRequest;

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