@maestro-org/typescript-sdk/src/api/accounts/type.ts

TypeScript SDK for the Maestro Dapp Platform

/**
 * Query parameters for accountAddresses.
 * @export
 * @interface AccountAddressesQueryParams
 *
 */
export interface AccountAddressesQueryParams {
    /**
     * The max number of results per page.
     * @type {number | null}
     * @memberof AccountAddressesQueryParams
     */
    count?: number | null;
    /**
     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
     * @type {string | null}
     * @memberof AccountAddressesQueryParams
     */
    cursor?: string | null;
    /**
     * Include addresses that have been seen on-chain but have no balance.
     * @type {boolean | null}
     * @memberof AccountAddressesQueryParams
     */
    include_empty?: boolean | null;
}

/**
 * Query parameters for accountAssets.
 * @export
 * @interface AccountAssetsQueryParams
 *
 */
export interface AccountAssetsQueryParams {
    /**
     * Filter results to only show assets of the specified policy
     * @type {string | null}
     * @memberof AccountAssetsQueryParams
     */
    policy?: string | null;
    /**
     * The max number of results per page.
     * @type {number | null}
     * @memberof AccountAssetsQueryParams
     */
    count?: number | null;
    /**
     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
     * @type {string | null}
     * @memberof AccountAssetsQueryParams
     */
    cursor?: string | null;
}

/**
 * Query parameters for accountHistory.
 * @export
 * @interface AccountHistoryQueryParams
 *
 */
export interface AccountHistoryQueryParams {
    /**
     * Fetch result for only a specific epoch
     * @type {string | null}
     * @memberof AccountHistoryQueryParams
     */
    epochNo?: number | null;
    /**
     * The max number of results per page.
     * @type {number | null}
     * @memberof AccountHistoryQueryParams
     */
    count?: number | null;
    /**
     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
     * @type {string | null}
     * @memberof AccountHistoryQueryParams
     */
    cursor?: string | null;
}

/**
 * Query parameters for accountRewards.
 * @export
 * @interface AccountRewardsQueryParams
 *
 */
export interface AccountRewardsQueryParams {
    /**
     * The max number of results per page.
     * @type {number | null}
     * @memberof AccountRewardsQueryParams
     */
    count?: number | null;
    /**
     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
     * @type {string | null}
     * @memberof AccountRewardsQueryParams
     */
    cursor?: string | null;
}

/**
 * Query parameters for accountUpdates.
 * @export
 * @interface AccountUpdatesQueryParams
 *
 */
export interface AccountUpdatesQueryParams {
    /**
     * The max number of results per page.
     * @type {number | null}
     * @memberof AccountUpdatesQueryParams
     */
    count?: number | null;
    /**
     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
     * @type {string | null}
     * @memberof AccountUpdatesQueryParams
     */
    cursor?: string | null;
}

/**
 * Query parameters for accountDelegationHistory.
 * @export
 * @interface AccountDelegationHistoryQueryParams
 *
 */
export interface AccountDelegationHistoryQueryParams {
    /**
     * The max number of results per page.
     * @type {number | null}
     * @memberof AccountDelegationHistoryQueryParams
     */
    count?: number | null;

    /**
     * Pagination cursor string, use the cursor included in a page of results to fetch the next page.
     * @type {string | null}
     * @memberof AccountDelegationHistoryQueryParams
     */
    cursor?: string | null;
}