@hubbleprotocol/carpool-typescript-client/dist/apis/accounts-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';
import { AccountSearchRequest } from '../models';
import { AccountsAggregateRequest } from '../models';
/**
 * AccountsApi - axios parameter creator
 * @export
 */
export declare const AccountsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerAggregateAccounts: (body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerAggregateAccounts_1: (body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerGetAccount: (xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerGetAccount_2: (xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerListAccounts: (xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerListAccounts_3: (xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerSearchAccounts: (body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerSearchAccounts_4: (body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AccountsApi - functional programming interface
 * @export
 */
export declare const AccountsApiFp: (configuration?: Configuration) => {
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerAggregateAccounts(body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerAggregateAccounts_1(body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerGetAccount(xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerGetAccount_2(xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerListAccounts(xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerListAccounts_3(xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerSearchAccounts(body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerSearchAccounts_4(body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
};
/**
 * AccountsApi - factory interface
 * @export
 */
export declare const AccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerAggregateAccounts(body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerAggregateAccounts_1(body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerGetAccount(xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerGetAccount_2(xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerListAccounts(xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerListAccounts_3(xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerSearchAccounts(body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    accountsControllerSearchAccounts_4(body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
};
/**
 * AccountsApi - object-oriented interface
 * @export
 * @class AccountsApi
 * @extends {BaseAPI}
 */
export declare class AccountsApi extends BaseAPI {
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerAggregateAccountsDevnet(body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html\" target=\"_blank\">the Elasticsearch docs</a> for a list of aggregations. <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">Queries</a> and slots can be used to narrow aggregation range.
     * @summary Perform aggregations of accounts of a program.
     * @param {AccountsAggregateRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerAggregateAccountsMainnet(body: AccountsAggregateRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerGetAccountDevnet(xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary Fetch a specific account
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {string} accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerGetAccountMainnet(xApiKey: string, programId: string, accountName: string, accountId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerListAccountsDevnet(xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     *
     * @summary List accounts.
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {number} [size] Number of entries to return. Default is 10.
     * @param {number} [from] Pagination starting point.
     * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. For accounts, \&quot;slot\&quot; refers to the last slot it was updated at.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerListAccountsMainnet(xApiKey: string, programId: string, accountName: string, size?: number, from?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerSearchAccountsDevnet(body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    /**
     * See <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html#filter-context\" target=\"_blank\">the Elasticsearch docs</a> for a list of query types.
     * @summary Search accounts of a program using Elasticsearch DSL.
     * @param {AccountSearchRequest} body
     * @param {string} xApiKey
     * @param {string} programId
     * @param {string} accountName
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AccountsApi
     */
    accountsControllerSearchAccountsMainnet(body: AccountSearchRequest, xApiKey: string, programId: string, accountName: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
}