@shapeshiftoss/unchained-client 4.0.0 → 5.1.1

package/dist/generated/cosmos/api.d.ts

@@ -0,0 +1,939 @@
+/**
+ * Cosmos Unchained API
+ * Provides access to cosmos chain data
+ *
+ * The version of the OpenAPI document: 5.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Configuration } from './configuration';
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { RequestArgs, BaseAPI } from './base';
+/**
+ * Contains info about account details for an address or xpub
+ * @export
+ * @interface Account
+ */
+export interface Account {
+    /**
+     *
+     * @type {string}
+     * @memberof Account
+     */
+    balance: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account
+     */
+    pubkey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Account
+     */
+    unconfirmedBalance: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Account
+     */
+    accountNumber: number;
+    /**
+     *
+     * @type {Array<Value>}
+     * @memberof Account
+     */
+    assets: Array<Value>;
+    /**
+     *
+     * @type {Array<Delegation>}
+     * @memberof Account
+     */
+    delegations: Array<Delegation>;
+    /**
+     *
+     * @type {Array<Redelegation>}
+     * @memberof Account
+     */
+    redelegations: Array<Redelegation>;
+    /**
+     *
+     * @type {Array<Value>}
+     * @memberof Account
+     */
+    rewards: Array<Value>;
+    /**
+     *
+     * @type {number}
+     * @memberof Account
+     */
+    sequence: number;
+    /**
+     *
+     * @type {Array<Unbonding>}
+     * @memberof Account
+     */
+    unbondings: Array<Unbonding>;
+}
+/**
+ *
+ * @export
+ * @interface AccountAllOf
+ */
+export interface AccountAllOf {
+    /**
+     *
+     * @type {number}
+     * @memberof AccountAllOf
+     */
+    accountNumber: number;
+    /**
+     *
+     * @type {Array<Value>}
+     * @memberof AccountAllOf
+     */
+    assets: Array<Value>;
+    /**
+     *
+     * @type {Array<Delegation>}
+     * @memberof AccountAllOf
+     */
+    delegations: Array<Delegation>;
+    /**
+     *
+     * @type {Array<Redelegation>}
+     * @memberof AccountAllOf
+     */
+    redelegations: Array<Redelegation>;
+    /**
+     *
+     * @type {Array<Value>}
+     * @memberof AccountAllOf
+     */
+    rewards: Array<Value>;
+    /**
+     *
+     * @type {number}
+     * @memberof AccountAllOf
+     */
+    sequence: number;
+    /**
+     *
+     * @type {Array<Unbonding>}
+     * @memberof AccountAllOf
+     */
+    unbondings: Array<Unbonding>;
+}
+/**
+ * Generic api error for handling failed requests
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    message: string;
+}
+/**
+ * Contains info about a transaction log event key/val attribute
+ * @export
+ * @interface Attribute
+ */
+export interface Attribute {
+    /**
+     *
+     * @type {string}
+     * @memberof Attribute
+     */
+    key: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Attribute
+     */
+    value: string;
+}
+/**
+ * Contains info about a 400 Bad Request response
+ * @export
+ * @interface BadRequestError
+ */
+export interface BadRequestError {
+    /**
+     *
+     * @type {string}
+     * @memberof BadRequestError
+     */
+    error: string;
+}
+/**
+ * Contains info about required base account details for an address or xpub
+ * @export
+ * @interface BaseAccount
+ */
+export interface BaseAccount {
+    /**
+     *
+     * @type {string}
+     * @memberof BaseAccount
+     */
+    balance: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BaseAccount
+     */
+    pubkey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BaseAccount
+     */
+    unconfirmedBalance: string;
+}
+/**
+ * Contains required base info about the running coinstack
+ * @export
+ * @interface BaseInfo
+ */
+export interface BaseInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof BaseInfo
+     */
+    network: string;
+}
+/**
+ * Contains info about required base transaction details
+ * @export
+ * @interface BaseTx
+ */
+export interface BaseTx {
+    /**
+     *
+     * @type {string}
+     * @memberof BaseTx
+     */
+    blockHash?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BaseTx
+     */
+    blockHeight?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BaseTx
+     */
+    timestamp?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BaseTx
+     */
+    txid: string;
+}
+/**
+ *
+ * @export
+ * @interface BaseTxHistory
+ */
+export interface BaseTxHistory {
+    /**
+     *
+     * @type {number}
+     * @memberof BaseTxHistory
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof BaseTxHistory
+     */
+    totalPages: number;
+    /**
+     *
+     * @type {string}
+     * @memberof BaseTxHistory
+     */
+    pubkey: string;
+    /**
+     *
+     * @type {Array<Tx>}
+     * @memberof BaseTxHistory
+     */
+    txs?: Array<Tx>;
+}
+/**
+ *
+ * @export
+ * @interface BaseTxHistoryAllOf
+ */
+export interface BaseTxHistoryAllOf {
+    /**
+     *
+     * @type {string}
+     * @memberof BaseTxHistoryAllOf
+     */
+    pubkey: string;
+    /**
+     *
+     * @type {Array<Tx>}
+     * @memberof BaseTxHistoryAllOf
+     */
+    txs?: Array<Tx>;
+}
+/**
+ * Contains info about a staking delegation
+ * @export
+ * @interface Delegation
+ */
+export interface Delegation {
+    /**
+     *
+     * @type {Value}
+     * @memberof Delegation
+     */
+    balance: Value;
+    /**
+     *
+     * @type {string}
+     * @memberof Delegation
+     */
+    shares: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Delegation
+     */
+    validator: string;
+}
+/**
+ * Contains info about a transaction log event
+ * @export
+ * @interface Event
+ */
+export interface Event {
+    /**
+     *
+     * @type {Array<Attribute>}
+     * @memberof Event
+     */
+    attributes: Array<Attribute>;
+    /**
+     *
+     * @type {string}
+     * @memberof Event
+     */
+    type: string;
+}
+/**
+ * Contains info about the running coinstack
+ * @export
+ * @interface Info
+ */
+export interface Info {
+    /**
+     *
+     * @type {string}
+     * @memberof Info
+     */
+    network: string;
+}
+/**
+ *
+ * @export
+ * @interface InlineObject
+ */
+export interface InlineObject {
+    /**
+     * Raw transaction hex
+     * @type {string}
+     * @memberof InlineObject
+     */
+    hex: string;
+}
+/**
+ * Contains info about a 500 Internal Server Error response
+ * @export
+ * @interface InternalServerError
+ */
+export interface InternalServerError {
+    /**
+     *
+     * @type {string}
+     * @memberof InternalServerError
+     */
+    message?: string;
+}
+/**
+ * Contains info about a transaction message
+ * @export
+ * @interface Message
+ */
+export interface Message {
+    /**
+     *
+     * @type {string}
+     * @memberof Message
+     */
+    from?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Message
+     */
+    to?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Message
+     */
+    type: string;
+    /**
+     *
+     * @type {Value}
+     * @memberof Message
+     */
+    value?: Value;
+}
+/**
+ * Contains info about pagination for large sets of data
+ * @export
+ * @interface Pagination
+ */
+export interface Pagination {
+    /**
+     *
+     * @type {number}
+     * @memberof Pagination
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof Pagination
+     */
+    totalPages: number;
+}
+/**
+ * Contains info about a staking redelegation
+ * @export
+ * @interface Redelegation
+ */
+export interface Redelegation {
+    /**
+     *
+     * @type {string}
+     * @memberof Redelegation
+     */
+    destinationValidator: string;
+    /**
+     *
+     * @type {Array<RedelegationEntry>}
+     * @memberof Redelegation
+     */
+    entries: Array<RedelegationEntry>;
+    /**
+     *
+     * @type {string}
+     * @memberof Redelegation
+     */
+    sourceValidator: string;
+}
+/**
+ * Contains info about a redelegation action
+ * @export
+ * @interface RedelegationEntry
+ */
+export interface RedelegationEntry {
+    /**
+     *
+     * @type {string}
+     * @memberof RedelegationEntry
+     */
+    completionTime: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RedelegationEntry
+     */
+    shares: string;
+}
+/**
+ *
+ * @export
+ * @interface Tx
+ */
+export interface Tx {
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    blockHash?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    blockHeight?: string;
+    /**
+     *
+     * @type {Array<Event>}
+     * @memberof Tx
+     */
+    events?: Array<Event>;
+    /**
+     *
+     * @type {Value}
+     * @memberof Tx
+     */
+    fee?: Value;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    gasUsed?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    gasWanted?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Tx
+     */
+    index?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    memo?: string;
+    /**
+     *
+     * @type {Array<Message>}
+     * @memberof Tx
+     */
+    messages?: Array<Message>;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    timestamp?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    txid: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Tx
+     */
+    value?: string;
+}
+/**
+ * Contains info about transaction history for an address or xpub
+ * @export
+ * @interface TxHistory
+ */
+export interface TxHistory {
+    /**
+     *
+     * @type {Array<Tx>}
+     * @memberof TxHistory
+     */
+    txs: Array<Tx>;
+    /**
+     *
+     * @type {number}
+     * @memberof TxHistory
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TxHistory
+     */
+    totalPages: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TxHistory
+     */
+    pubkey: string;
+}
+/**
+ *
+ * @export
+ * @interface TxHistoryAllOf
+ */
+export interface TxHistoryAllOf {
+    /**
+     *
+     * @type {Array<Tx>}
+     * @memberof TxHistoryAllOf
+     */
+    txs: Array<Tx>;
+}
+/**
+ * Contains info about a staking unbonding
+ * @export
+ * @interface Unbonding
+ */
+export interface Unbonding {
+    /**
+     *
+     * @type {Array<UnbondingEntry>}
+     * @memberof Unbonding
+     */
+    entries: Array<UnbondingEntry>;
+    /**
+     *
+     * @type {string}
+     * @memberof Unbonding
+     */
+    validator: string;
+}
+/**
+ * Contains info about an unbonding action
+ * @export
+ * @interface UnbondingEntry
+ */
+export interface UnbondingEntry {
+    /**
+     *
+     * @type {Value}
+     * @memberof UnbondingEntry
+     */
+    balance: Value;
+    /**
+     *
+     * @type {string}
+     * @memberof UnbondingEntry
+     */
+    completionTime: string;
+}
+/**
+ * Contains info about a 422 Validation Error response
+ * @export
+ * @interface ValidationError
+ */
+export interface ValidationError {
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof ValidationError
+     */
+    details: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof ValidationError
+     */
+    message: string;
+}
+/**
+ * Contains info about an asset value
+ * @export
+ * @interface Value
+ */
+export interface Value {
+    /**
+     *
+     * @type {string}
+     * @memberof Value
+     */
+    amount: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Value
+     */
+    denom: string;
+}
+/**
+ * V1Api - axios parameter creator
+ * @export
+ */
+export declare const V1ApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     *
+     * @summary Get account details.
+     * @param {string} pubkey Account address or xpub
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount: (pubkey: string, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get information about the running coinstack.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfo: (options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get paginated transaction history.
+     * @param {string} pubkey Account address or xpub
+     * @param {number} [page] Page number (default 1)
+     * @param {number} [pageSize] Page size (default 25)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory: (pubkey: string, page?: number | undefined, pageSize?: number | undefined, options?: any) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Sends raw transaction to be broadcast to the node.
+     * @param {InlineObject} [body]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx: (body?: InlineObject | undefined, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * V1Api - functional programming interface
+ * @export
+ */
+export declare const V1ApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     *
+     * @summary Get account details.
+     * @param {string} pubkey Account address or xpub
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount(pubkey: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Account>>;
+    /**
+     *
+     * @summary Get information about the running coinstack.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfo(options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Info>>;
+    /**
+     *
+     * @summary Get paginated transaction history.
+     * @param {string} pubkey Account address or xpub
+     * @param {number} [page] Page number (default 1)
+     * @param {number} [pageSize] Page size (default 25)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory(pubkey: string, page?: number | undefined, pageSize?: number | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<TxHistory>>;
+    /**
+     *
+     * @summary Sends raw transaction to be broadcast to the node.
+     * @param {InlineObject} [body]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx(body?: InlineObject | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<string>>;
+};
+/**
+ * V1Api - factory interface
+ * @export
+ */
+export declare const V1ApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     *
+     * @summary Get account details.
+     * @param {string} pubkey Account address or xpub
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccount(pubkey: string, options?: any): AxiosPromise<Account>;
+    /**
+     *
+     * @summary Get information about the running coinstack.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInfo(options?: any): AxiosPromise<Info>;
+    /**
+     *
+     * @summary Get paginated transaction history.
+     * @param {string} pubkey Account address or xpub
+     * @param {number} [page] Page number (default 1)
+     * @param {number} [pageSize] Page size (default 25)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTxHistory(pubkey: string, page?: number | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<TxHistory>;
+    /**
+     *
+     * @summary Sends raw transaction to be broadcast to the node.
+     * @param {InlineObject} [body]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendTx(body?: InlineObject | undefined, options?: any): AxiosPromise<string>;
+};
+/**
+ * Request parameters for getAccount operation in V1Api.
+ * @export
+ * @interface V1ApiGetAccountRequest
+ */
+export interface V1ApiGetAccountRequest {
+    /**
+     * Account address or xpub
+     * @type {string}
+     * @memberof V1ApiGetAccount
+     */
+    readonly pubkey: string;
+}
+/**
+ * Request parameters for getTxHistory operation in V1Api.
+ * @export
+ * @interface V1ApiGetTxHistoryRequest
+ */
+export interface V1ApiGetTxHistoryRequest {
+    /**
+     * Account address or xpub
+     * @type {string}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly pubkey: string;
+    /**
+     * Page number (default 1)
+     * @type {number}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly page?: number;
+    /**
+     * Page size (default 25)
+     * @type {number}
+     * @memberof V1ApiGetTxHistory
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for sendTx operation in V1Api.
+ * @export
+ * @interface V1ApiSendTxRequest
+ */
+export interface V1ApiSendTxRequest {
+    /**
+     *
+     * @type {InlineObject}
+     * @memberof V1ApiSendTx
+     */
+    readonly body?: InlineObject;
+}
+/**
+ * V1Api - object-oriented interface
+ * @export
+ * @class V1Api
+ * @extends {BaseAPI}
+ */
+export declare class V1Api extends BaseAPI {
+    /**
+     *
+     * @summary Get account details.
+     * @param {V1ApiGetAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getAccount(requestParameters: V1ApiGetAccountRequest, options?: any): Promise<import("axios").AxiosResponse<Account>>;
+    /**
+     *
+     * @summary Get information about the running coinstack.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getInfo(options?: any): Promise<import("axios").AxiosResponse<Info>>;
+    /**
+     *
+     * @summary Get paginated transaction history.
+     * @param {V1ApiGetTxHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    getTxHistory(requestParameters: V1ApiGetTxHistoryRequest, options?: any): Promise<import("axios").AxiosResponse<TxHistory>>;
+    /**
+     *
+     * @summary Sends raw transaction to be broadcast to the node.
+     * @param {V1ApiSendTxRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof V1Api
+     */
+    sendTx(requestParameters?: V1ApiSendTxRequest, options?: any): Promise<import("axios").AxiosResponse<string>>;
+}
+/**
+ * WebsocketApi - axios parameter creator
+ * @export
+ */
+export declare const WebsocketApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
+    /**
+     * Subscribe Example:  Unsubscribe Example:
+     * @summary Subscribe to pending and confirmed transactions.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    websocket: (options?: any) => Promise<RequestArgs>;
+};
+/**
+ * WebsocketApi - functional programming interface
+ * @export
+ */
+export declare const WebsocketApiFp: (configuration?: Configuration | undefined) => {
+    /**
+     * Subscribe Example:  Unsubscribe Example:
+     * @summary Subscribe to pending and confirmed transactions.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    websocket(options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
+};
+/**
+ * WebsocketApi - factory interface
+ * @export
+ */
+export declare const WebsocketApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
+    /**
+     * Subscribe Example:  Unsubscribe Example:
+     * @summary Subscribe to pending and confirmed transactions.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    websocket(options?: any): AxiosPromise<void>;
+};
+/**
+ * WebsocketApi - object-oriented interface
+ * @export
+ * @class WebsocketApi
+ * @extends {BaseAPI}
+ */
+export declare class WebsocketApi extends BaseAPI {
+    /**
+     * Subscribe Example:  Unsubscribe Example:
+     * @summary Subscribe to pending and confirmed transactions.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WebsocketApi
+     */
+    websocket(options?: any): Promise<import("axios").AxiosResponse<void>>;
+}
+//# sourceMappingURL=api.d.ts.map