dadata-suggestions typings for TS

index.d.ts

// For Own Project

interface CommonParams {
  query: string,
  count?: number,
}

interface FIOParams extends CommonParams {
  parts?: 'NAME' | 'SURNAME' | 'PATRONYMIC',
  gender?: 'MALE' | 'FEMALE' | 'UNKNOWN',
}

interface AddressLocationParams {
  region_fias_id?: number,
  area_fias_id?: number,
  city_fias_id?: number,
  settlement_fias_id?: number,
  street_fias_id?: number,
}

interface AddressParams extends CommonParams {
  locations?: AddressLocationParams,
}

interface PartyLocationParams extends AddressLocationParams {
  kladr_id?: number;
}

interface PartyParams extends CommonParams {
  status?: 'ACTIVE' | 'LIQUIDATING' | 'LIQUIDATED';
  type?: 'LEGAL' | 'INDIVIDUAL';
  locations: PartyLocationParams[];
}

interface BankParams extends CommonParams {
  status?: 'ACTIVE' | 'LIQUIDATING' | 'LIQUIDATED';
  type?: 'BANK' | 'NKO' | 'BANK_BRANCH' | 'NKO_BRANCH' | 'RKC' | 'OTHER';
}

declare class DaData {
  constructor(apyKey: string);

  fio(params: FIOParams): PromiseLike<Array<any> | any>;
  address(params: AddressParams): PromiseLike<Array<any> | any>;
  party(params: PartyParams): PromiseLike<Array<any> | any>;
  bank(params: BankParams): PromiseLike<Array<any> | any>;
  email(params: CommonParams): PromiseLike<Array<any> | any>;
}

declare namespace DaData {}

declare module 'dadata-suggestions' {
  export = DaData;
}

package.d.ts

// For Package itself
interface CommonParams {
  query: string,
  count?: number,
}

interface FIOParams extends CommonParams {
  parts?: 'NAME' | 'SURNAME' | 'PATRONYMIC',
  gender?: 'MALE' | 'FEMALE' | 'UNKNOWN',
}

interface AddressLocationParams {
  region_fias_id?: number,
  area_fias_id?: number,
  city_fias_id?: number,
  settlement_fias_id?: number,
  street_fias_id?: number,
}

interface AddressParams extends CommonParams {
  locations?: AddressLocationParams,
}

interface PartyLocationParams extends AddressLocationParams {
  kladr_id?: number;
}

interface PartyParams extends CommonParams {
  status?: 'ACTIVE' | 'LIQUIDATING' | 'LIQUIDATED';
  type?: 'LEGAL' | 'INDIVIDUAL';
  locations: PartyLocationParams[];
}

interface BankParams extends CommonParams {
  status?: 'ACTIVE' | 'LIQUIDATING' | 'LIQUIDATED';
  type?: 'BANK' | 'NKO' | 'BANK_BRANCH' | 'NKO_BRANCH' | 'RKC' | 'OTHER';
}

declare class DaData {
  constructor(apyKey: string);

  fio(params: FIOParams): PromiseLike<Array<any> | any>;
  address(params: AddressParams): PromiseLike<Array<any> | any>;
  party(params: PartyParams): PromiseLike<Array<any> | any>;
  bank(params: BankParams): PromiseLike<Array<any> | any>;
  email(params: CommonParams): PromiseLike<Array<any> | any>;
}

export DaData;