@complycube/api/dist/resources/Clients.d.ts

ComplyCube's Node.js library for the AML/KYC API

import { AxiosInstance } from "axios";
import { Resource } from "../Resource";
type PersonDetails = {
    firstName?: string | null;
    middleName?: string | null;
    lastName?: string | null;
    dob?: string | null;
    gender?: string | null;
    nationality?: string | null;
    birthCountry?: string | null;
    ssn?: string | null;
    socialInsuranceNumber?: string | null;
    nationalIdentityNumber?: string | null;
    taxIdentificationNumber?: string | null;
};
type CompanyDetails = {
    name?: string | null;
    website?: string | null;
    registrationNumber?: string | null;
    incorporationCountry?: string | null;
    incorporationType?: string | null;
};
export type ClientRequest = {
    type?: string;
    email?: string | null;
    mobile?: string | null;
    telephone?: string | null;
    joinedDate?: string | null;
    personDetails?: PersonDetails | null;
    companyDetails?: CompanyDetails | null;
    metadata?: object | null;
    externalId?: string | null;
    lastActionBy?: string | null;
};
export type Client = {
    id: string;
    type?: string;
    email?: string | null;
    mobile?: string | null;
    telephone?: string | null;
    joinedDate?: string | null;
    personDetails?: PersonDetails | null;
    companyDetails?: CompanyDetails | null;
    metadata?: object | null;
    externalId?: string | null;
    lastActionBy?: string | null;
    createdAt: string;
    updatedAt: string;
};
export declare class Clients extends Resource<ClientRequest> {
    constructor(axiosInstance: AxiosInstance);
    create(clientRequest: ClientRequest): Promise<Client>;
    get(id: string): Promise<Client>;
    update(id: string, clientRequest: ClientRequest): Promise<Client>;
    delete(id: string): Promise<void>;
    list({ page, pageSize }?: {
        page?: number;
        pageSize?: number;
    }): Promise<Client[]>;
}
export {};