zumokit
Version:
ZumoKit is a Wallet as a Service SDK
60 lines (59 loc) • 3.02 kB
TypeScript
export declare type LogLevel = 'trace' | 'debug' | 'info' | 'warning' | 'error' | 'critical' | 'off';
export declare type Dictionary<K extends string, T> = Partial<Record<K, T>>;
export declare type CurrencyType = 'CRYPTO' | 'FIAT';
export declare type CustodyType = 'CUSTODY' | 'NON-CUSTODY';
export declare type CurrencyCode = 'ETH' | 'BTC' | 'BSV' | 'USD' | 'GBP' | 'EUR';
export declare type Network = 'MAINNET' | 'TESTNET' | 'RINKEBY' | 'ROPSTEN' | 'GOERLI';
export declare type AccountType = 'STANDARD' | 'COMPATIBILITY' | 'SEGWIT';
export declare type CardType = 'VIRTUAL' | 'PHYSICAL';
export declare type CardStatus = 'CREATED' | 'ACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'FROZEN' | 'EXPIRED' | 'CANCELLED';
export declare type CustodyOrderType = 'DEPOSIT' | 'WITHDRAW';
export declare type CustodyOrderStatus = 'NEW' | 'PENDING' | 'CONFIRMED' | 'FAILED';
export declare type TransactionType = 'CUSTODY' | 'CUSTODY-DEPOSIT' | 'CUSTODY-WITHDRAW' | 'CRYPTO' | 'FIAT' | 'NOMINATED' | 'CARD';
export declare type TransactionDirection = 'SENT' | 'RECEIVED';
export declare type TransactionStatus = 'PENDING' | 'CONFIRMED' | 'FAILED' | 'RESUBMITTED' | 'CANCELLED' | 'PAUSED' | 'REJECTED' | 'AUTHORISED' | 'REVERSED' | 'REFUNDED';
export declare type ExchangeSide = 'BUY' | 'SELL';
export declare type ExchangeStatus = 'PENDING' | 'WITHDRAWING' | 'CONFIRMED' | 'FAILED';
export declare type TimeInterval = 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'max';
/** Interface describes user tokens set, which is a parameter of {@link ZumoKit.signIn}. */
export interface TokenSet {
accessToken: string;
expiresIn: number;
refreshToken: string;
}
/** Interface describes user address, which is a parameter of {@link User.makeFiatCustomer}. */
export interface Address {
houseNumber: string;
addressLine1: string;
addressLine2: string | null;
/** country code in ISO 3166-1 Alpha-2 format, e.g. 'GB' */
country: string;
postCode: string;
postTown: string;
}
/** Interface describes sensitive card details, retrieved via {@link User.revealCardDetails} method. */
export interface CardDetails {
/** Card PAN, e.g 4564 6545 7997 5454 */
pan: string;
/** Card CVV2, e.g. 078 */
cvv2: string;
}
/** Interface describes Knowledge-Based Authentication (KBA) question */
export interface KbaQuestion {
/** KBA question type, e.g. "FIRST_PET_NAME" */
type: string;
/** KBA question, e.g. "What was your first pet's name?" */
question: string;
}
/** Interface describes Strong Customer Authentication (SCA) config, retrieved via {@link User.fetchAuthenticationConfig} method. */
export interface AuthenticationConfig {
/** Knowledge-Based Authentication (KBA) questions */
knowledgeBase: Array<KbaQuestion>;
}
/** Interface describes Knowledge-Based Authentication (KBA) answer */
export interface KbaAnswer {
/** KBA question type, e.g. "FIRST_PET_NAME" */
type: string;
/** KBA answer, e.g. "Shurik" */
answer: string;
}