@hubbleprotocol/carpool-typescript-client/dist/apis/accounts-archive-api.d.ts

OpenAPI TypeScript client for Carpool

/**
 * Carpool Query
 * The Carpool Query API
 *
 * OpenAPI spec version: 1.0
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
/**
 * AccountsArchiveApi - axios parameter creator
 * @export
 */
export declare const AccountsArchiveApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get the version of an account present at a specific slot.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {string} [exact] Indicate that the provided slot is exactly when the account was updated. Skips an expensive search for *significantly* improved performance (10-20X), but will 404 if not an exact match.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountAtSlot: (xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, exact?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get the exact state of an account at a specific slot and write version.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {number} writeVersion
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountAtSlotAndVersion: (xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, writeVersion: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Note: This can potentially return a LOT of data. Use the /slots query to narrow down your search first.
     * @summary Get all versions of an account.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountHistory: (xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get a list of all slots where an account was updated.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountSlotUpdates: (xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get a list of all slots where an account was updated, along with unique write versions
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountSlotUpdatesWithVersion: (xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AccountsArchiveApi - functional programming interface
 * @export
 */
export declare const AccountsArchiveApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get the version of an account present at a specific slot.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {string} [exact] Indicate that the provided slot is exactly when the account was updated. Skips an expensive search for *significantly* improved performance (10-20X), but will 404 if not an exact match.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountAtSlot(xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, exact?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Get the exact state of an account at a specific slot and write version.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {number} writeVersion
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountAtSlotAndVersion(xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, writeVersion: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     * Note: This can potentially return a LOT of data. Use the /slots query to narrow down your search first.
     * @summary Get all versions of an account.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountHistory(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Get a list of all slots where an account was updated.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountSlotUpdates(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Get a list of all slots where an account was updated, along with unique write versions
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountSlotUpdatesWithVersion(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
};
/**
 * AccountsArchiveApi - factory interface
 * @export
 */
export declare const AccountsArchiveApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get the version of an account present at a specific slot.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {string} [exact] Indicate that the provided slot is exactly when the account was updated. Skips an expensive search for *significantly* improved performance (10-20X), but will 404 if not an exact match.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountAtSlot(xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, exact?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get the exact state of an account at a specific slot and write version.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {number} writeVersion
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountAtSlotAndVersion(xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, writeVersion: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * Note: This can potentially return a LOT of data. Use the /slots query to narrow down your search first.
     * @summary Get all versions of an account.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountHistory(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get a list of all slots where an account was updated.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountSlotUpdates(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get a list of all slots where an account was updated, along with unique write versions
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    archiveControllerGetAccountSlotUpdatesWithVersion(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
};
/**
 * AccountsArchiveApi - object-oriented interface
 * @export
 * @class AccountsArchiveApi
 * @extends {BaseAPI}
 */
export declare class AccountsArchiveApi extends BaseAPI {
    /**
     *
     * @summary Get the version of an account present at a specific slot.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {string} [exact] Indicate that the provided slot is exactly when the account was updated. Skips an expensive search for *significantly* improved performance (10-20X), but will 404 if not an exact match.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsArchiveApi
     */
    archiveControllerGetAccountAtSlot(xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, exact?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get the exact state of an account at a specific slot and write version.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} slot
     * @param {number} writeVersion
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsArchiveApi
     */
    archiveControllerGetAccountAtSlotAndVersion(xApiKey: string, programId: string, accountName: string, accountId: string, slot: number, writeVersion: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * Note: This can potentially return a LOT of data. Use the /slots query to narrow down your search first.
     * @summary Get all versions of an account.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsArchiveApi
     */
    archiveControllerGetAccountHistory(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get a list of all slots where an account was updated.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsArchiveApi
     */
    archiveControllerGetAccountSlotUpdates(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Get a list of all slots where an account was updated, along with unique write versions
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {number} [start] A starting slot for the search (inclusive)
     * @param {number} [end] An ending slot for the search (exclusive)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsArchiveApi
     */
    archiveControllerGetAccountSlotUpdatesWithVersion(xApiKey: string, programId: string, accountName: string, accountId: string, start?: number, end?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
}