@frankieone/one-sdk 0.1.0-poc.15

package/dist/types/models/Applicant.d.ts

@@ -0,0 +1,115 @@
+import { Address, IAddressPayload } from "./Address";
+import { Profile, IProfilePayload } from "./Profile";
+import { Core } from "./Core";
+import { Nullable, ICloneable, ExtraData } from "./General";
+declare type AddressType = Address["addressType"];
+declare type ApplicantExtraData = ExtraData & Partial<{
+    home_country_givenname: string;
+    home_country_familyname: string;
+    marital_status: Core["enumMaritalStatus"];
+}>;
+export declare type TOriginalUboDetails = {
+    name: {
+        givenName: Nullable<string>;
+        middleName: Nullable<string>;
+        familyName: Nullable<string>;
+        displayName: Nullable<string>;
+    };
+    dateOfBirth: Nullable<string>;
+    addresses: Address[];
+};
+export interface IApplicantPayload {
+    entityId: Nullable<string>;
+    customerReference: Nullable<string>;
+    name: {
+        givenName: Nullable<string>;
+        middleName: Nullable<string>;
+        familyName: Nullable<string>;
+        displayName: Nullable<string>;
+    };
+    extraData?: ApplicantExtraData;
+    dateOfBirth: Nullable<string>;
+    gender: Nullable<Core["enumGender"]>;
+    phoneNumber: {
+        documentId: Nullable<string>;
+        idNumber: Nullable<string>;
+    };
+    addresses: IAddressPayload[];
+    email: {
+        documentId: Nullable<string>;
+        idNumber: Nullable<string>;
+    };
+    profile: IProfilePayload | null;
+    assignee: Nullable<string>;
+    consents: string[];
+    blocklistAttributes: Nullable<"ATTR" | "FULL">;
+    originalUboDetails?: Nullable<TOriginalUboDetails>;
+}
+interface IApplicantConstructor {
+    entityId: Nullable<string>;
+    customerReference?: Nullable<string>;
+    name?: {
+        givenName?: Nullable<string>;
+        middleName?: Nullable<string>;
+        familyName?: Nullable<string>;
+        displayName?: Nullable<string>;
+    };
+    extraData?: ApplicantExtraData;
+    dateOfBirth?: Nullable<string>;
+    gender?: Nullable<Core["enumGender"]>;
+    phoneNumber?: {
+        documentId?: Nullable<string>;
+        idNumber?: Nullable<string>;
+    };
+    addresses?: Address[];
+    email?: {
+        documentId?: Nullable<string>;
+        idNumber?: Nullable<string>;
+    };
+    profile?: Nullable<Profile>;
+    assignee?: Nullable<string>;
+    consents?: string[];
+    blocklistAttributes?: Nullable<"ATTR" | "FULL">;
+    originalUboDetails?: Nullable<TOriginalUboDetails>;
+}
+export declare type FullNameFields = {
+    givenName: Nullable<string>;
+    middleName: Nullable<string>;
+    familyName: Nullable<string>;
+    displayName: Nullable<string>;
+};
+export declare type SpecialDocument = {
+    documentId: Nullable<string>;
+    idNumber: Nullable<string>;
+};
+export declare class Applicant implements ICloneable<Applicant> {
+    entityId: Nullable<string>;
+    customerReference: Nullable<string>;
+    name: FullNameFields;
+    dateOfBirth: Nullable<string>;
+    gender: Nullable<Core["enumGender"]>;
+    extraData: ApplicantExtraData;
+    phoneNumber: SpecialDocument;
+    addresses: Address[];
+    email: SpecialDocument;
+    profile: Nullable<Profile>;
+    assignee: Nullable<string>;
+    consents: string[];
+    blocklistAttributes: Nullable<"ATTR" | "FULL">;
+    originalUboDetails: Nullable<TOriginalUboDetails>;
+    constructor();
+    constructor(a: IApplicantConstructor);
+    get currentPreviousAddress(): {
+        current: Address;
+        previous: Address;
+    };
+    set fullName(value: string);
+    get displayName(): string;
+    get nativeName(): string;
+    getAddress(addressType: AddressType): Address | null;
+    clone(): Applicant;
+    toJSON(): IApplicantPayload;
+    static fromJSON(payload: IApplicantPayload): Applicant;
+    static default(): Applicant;
+}
+export {};

package/dist/types/models/CheckSummary.d.ts

@@ -0,0 +1,164 @@
+import { TValidation, IIssueAction, IIssue, TApplicantStatus, TKycMethod, Nullable } from "./General";
+import { DuplicateResults } from "./Duplicate";
+declare type issue = {
+    code: string | null;
+    description: string | null;
+};
+declare type TMatchsetCount = {
+    required: number | null;
+    actual: number | null;
+};
+export declare type TRulesetMatchFields = {
+    name: TMatchsetCount;
+    dob: TMatchsetCount;
+    address: TMatchsetCount;
+    govId: TMatchsetCount;
+};
+interface IConstructorCheckResult {
+    type: string | null;
+    result: TApplicantStatus;
+    issues: issue[];
+}
+interface IConstructorRulesetsCount {
+    name: string | null;
+    order: number | null;
+    result: string | null;
+    rulesetMatchFields: TRulesetMatchFields;
+}
+declare type CheckSource = string[] | null;
+export declare class CheckResult {
+    type: string | null;
+    result: TApplicantStatus;
+    issues: issue[];
+    constructor(payload: IConstructorCheckResult);
+}
+export interface ICheckSummaryPayload {
+    checkTypes: string[];
+    checkDate: string;
+    personalChecks: {
+        name: TValidation;
+        dateOfBirth: TValidation;
+        phoneNumber: TValidation;
+        email: TValidation;
+        chineseName: Nullable<string>;
+        addresses: {
+            [k: string]: TValidation;
+        };
+    };
+    status: TApplicantStatus;
+    blocklistPotentialMatches: DuplicateResults[];
+    duplicatePotentialMatches: DuplicateResults[];
+    duplicateBlocklistMatches: DuplicateResults[];
+    risk: {
+        level: number | null;
+        class: string | null;
+    };
+    alertList: (IIssue | IIssueAction)[];
+    checkCounts: {
+        name: CheckSource;
+        address: {
+            [k: string]: CheckSource;
+        };
+        document: {
+            [k: string]: CheckSource;
+        };
+        dob: CheckSource;
+    };
+    kycMethod: TKycMethod;
+    issues: {
+        [issue: string]: any;
+    };
+    checkResults?: CheckResult[];
+    rulesetsMatches: RulesetsMatch[];
+}
+export interface ICheckSummaryConstructor {
+    checkTypes: string[];
+    checkDate: string;
+    personalChecks: {
+        name: TValidation;
+        dateOfBirth: TValidation;
+        phoneNumber: TValidation;
+        email: TValidation;
+        chineseName: Nullable<string>;
+        addresses: {
+            [k: string]: TValidation;
+        };
+    };
+    status: string;
+    blocklistPotentialMatches: DuplicateResults[];
+    duplicatePotentialMatches: DuplicateResults[];
+    duplicateBlocklistMatches: DuplicateResults[];
+    risk: {
+        level: number | null;
+        class: string | null;
+    };
+    alertList: (IIssue | IIssueAction)[];
+    checkCounts: {
+        name: CheckSource;
+        address: {
+            [k: string]: CheckSource;
+        };
+        document: {
+            [k: string]: CheckSource;
+        };
+        dob: CheckSource;
+    };
+    kycMethod: TKycMethod;
+    issues: {
+        [issue: string]: any;
+    };
+    checkResults?: CheckResult[];
+    rulesetsMatches?: RulesetsMatch[];
+}
+export declare class RulesetsMatch {
+    name: string | null;
+    order: number | null;
+    result: string | null;
+    rulesetMatchFields: TRulesetMatchFields;
+    constructor(payload: IConstructorRulesetsCount);
+}
+export declare class CheckSummary implements ICheckSummaryPayload {
+    checkDate: string;
+    checkTypes: string[];
+    personalChecks: {
+        name: TValidation;
+        dateOfBirth: TValidation;
+        phoneNumber: TValidation;
+        email: TValidation;
+        chineseName: Nullable<string>;
+        addresses: {
+            [k: string]: TValidation;
+        };
+    };
+    status: TApplicantStatus;
+    risk: {
+        level: number | null;
+        class: string | null;
+    };
+    alertList: (IIssue | IIssueAction)[];
+    blocklistPotentialMatches: DuplicateResults[];
+    duplicatePotentialMatches: DuplicateResults[];
+    duplicateBlocklistMatches: DuplicateResults[];
+    checkCounts: {
+        name: CheckSource;
+        address: {
+            [k: string]: CheckSource;
+        };
+        document: {
+            [k: string]: CheckSource;
+        };
+        dob: CheckSource;
+    };
+    kycMethod: TKycMethod;
+    issues: {
+        [issue: string]: any;
+    };
+    checkResults: CheckResult[];
+    rulesetsMatches: RulesetsMatch[];
+    constructor(c: ICheckSummaryConstructor);
+    toJSON(): ICheckSummaryPayload;
+    clone(): CheckSummary;
+    static fromJSON(payload: ICheckSummaryPayload): CheckSummary;
+    static default(): CheckSummary;
+}
+export {};

package/dist/types/models/ConfigurationReader.d.ts

@@ -0,0 +1,7 @@
+import { ConfigurationReader as IConfigurationReader, Path, StrObject } from "../interfaces";
+export declare class ConfigurationReader<Config extends StrObject> implements IConfigurationReader<Config> {
+    private parsedConfiguration;
+    constructor(original: Config);
+    read<Value = unknown>(path: Path<Config>): Value | undefined;
+    read<Value = unknown>(path: Path<Config>, fallback: Exclude<Value, undefined>): Exclude<Value, undefined>;
+}