@tangany/waas/dist/interfaces/common.d.ts

node.js SDK for Tangany Wallet as a Service API

import { NodeStatus } from "../types/common";
export interface IWaasError {
    statusCode: number;
    activityId: string;
    message: string;
}
export interface IPaginationResponse {
    links: {
        next: string | null;
        previous: string | null;
    };
}
export interface IHateoasLinks {
    links: IHateoasLink<string>[];
}
/**
 * A single HATEOAS link containing information to perform related resource operations
 */
export interface IHateoasLink<TRelation> {
    href: string;
    type: string;
    rel: TRelation;
}
/**
 * Represents the response of an asynchronous endpoint that returns a link to its status.
 */
export interface IAsyncEndpointResponse {
    statusUri: string;
    id: string;
}
/**
 * Represents the current state of an asynchronous request
 */
export interface IAsyncRequestStatus<T extends Record<string, any>> {
    process: string;
    status: {
        stage: string;
        [k: string]: string;
    };
    created: Date;
    updated: Date;
    purgedBy?: Date;
    output: null | undefined | T;
}
/**
 * Represents a transaction recipient configuration.
 * One of the properties `to` or `wallet` must be set.
 * If both are set, the specified address needs to belong to the wallet.
 */
export interface IRecipient {
    /** Recipient address */
    to?: string;
    /** Name of a wallet in the current key vault */
    wallet?: string;
    /** Float currency amount formatted as a string */
    amount: string;
}
export interface INodeStatus<T> {
    status: NodeStatus;
    info: T;
}
/**
 * API response object sent to the client as a search result.
 * It contains the number of results, an result array and pagination links.
 */
export interface ISearchResponse<T = any> extends IPaginationResponse {
    hits: {
        total: number;
    };
    list: T[];
}
/**
 * SDK-side options to control how the results of search requests (such as wallets, transactions or monitors) are processed.
 * This includes, for example, how API-side pagination should be handled in TypeScript iterables.
 * These options are not passed to the API and therefore should not be confused with search parameters such as {@link IWalletSearchParams}.
 */
export interface ISearchOptions {
    autoPagination?: boolean;
}
export interface ISearchRequestConfig {
    url: string;
    params?: object;
}