/** * Radix Gateway API - Babylon * This API is exposed by the Babylon Radix Gateway to enable clients to efficiently query current and historic state on the RadixDLT ledger, and intelligently handle transaction submission. It is designed for use by wallets and explorers, and for light queries from front-end dApps. For exchange/asset integrations, back-end dApp integrations, or simple use cases, you should consider using the Core API on a Node. A Gateway is only needed for reading historic snapshots of ledger states or a more robust set-up. The Gateway API is implemented by the [Network Gateway](https://github.com/radixdlt/babylon-gateway), which is configured to read from [full node(s)](https://github.com/radixdlt/babylon-node) to extract and index data from the network. This document is an API reference documentation, visit [User Guide](https://docs.radixdlt.com/) to learn more about how to run a Gateway of your own. ## Migration guide Please see [the latest release notes](https://github.com/radixdlt/babylon-gateway/releases). ## Integration and forward compatibility guarantees All responses may have additional fields added at any release, so clients are advised to use JSON parsers which ignore unknown fields on JSON objects. When the Radix protocol is updated, new functionality may be added, and so discriminated unions returned by the API may need to be updated to have new variants added, corresponding to the updated data. Clients may need to update in advance to be able to handle these new variants when a protocol update comes out. On the very rare occasions we need to make breaking changes to the API, these will be warned in advance with deprecation notices on previous versions. These deprecation notices will include a safe migration path. Deprecation notes or breaking changes will be flagged clearly in release notes for new versions of the Gateway. The Gateway DB schema is not subject to any compatibility guarantees, and may be changed at any release. DB changes will be flagged in the release notes so clients doing custom DB integrations can prepare. * * The version of the OpenAPI document: v1.10.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { StateAccountAuthorizedDepositorsPageRequest, StateAccountAuthorizedDepositorsPageResponse, StateAccountLockerPageVaultsRequest, StateAccountLockerPageVaultsResponse, StateAccountLockersTouchedAtRequest, StateAccountLockersTouchedAtResponse, StateAccountResourcePreferencesPageRequest, StateAccountResourcePreferencesPageResponse, StateEntityDetailsRequest, StateEntityDetailsResponse, StateEntityFungibleResourceVaultsPageRequest, StateEntityFungibleResourceVaultsPageResponse, StateEntityFungiblesPageRequest, StateEntityFungiblesPageResponse, StateEntityMetadataPageRequest, StateEntityMetadataPageResponse, StateEntityNonFungibleIdsPageRequest, StateEntityNonFungibleIdsPageResponse, StateEntityNonFungibleResourceVaultsPageRequest, StateEntityNonFungibleResourceVaultsPageResponse, StateEntityNonFungiblesPageRequest, StateEntityNonFungiblesPageResponse, StateEntitySchemaPageRequest, StateEntitySchemaPageResponse, StateKeyValueStoreDataRequest, StateKeyValueStoreDataResponse, StateKeyValueStoreKeysRequest, StateKeyValueStoreKeysResponse, StateNonFungibleDataRequest, StateNonFungibleDataResponse, StateNonFungibleIdsRequest, StateNonFungibleIdsResponse, StateNonFungibleLocationRequest, StateNonFungibleLocationResponse, StatePackageBlueprintPageRequest, StatePackageBlueprintPageResponse, StatePackageCodePageRequest, StatePackageCodePageResponse, StateValidatorsListRequest, StateValidatorsListResponse } from '../models'; export interface AccountAuthorizedDepositorsPageRequest { stateAccountAuthorizedDepositorsPageRequest: StateAccountAuthorizedDepositorsPageRequest; } export interface AccountLockerVaultsPageRequest { stateAccountLockerPageVaultsRequest: StateAccountLockerPageVaultsRequest; } export interface AccountLockersTouchedAtRequest { stateAccountLockersTouchedAtRequest: StateAccountLockersTouchedAtRequest; } export interface AccountResourcePreferencesPageRequest { stateAccountResourcePreferencesPageRequest: StateAccountResourcePreferencesPageRequest; } export interface EntityFungibleResourceVaultPageRequest { stateEntityFungibleResourceVaultsPageRequest: StateEntityFungibleResourceVaultsPageRequest; } export interface EntityFungiblesPageRequest { stateEntityFungiblesPageRequest: StateEntityFungiblesPageRequest; } export interface EntityMetadataPageRequest { stateEntityMetadataPageRequest: StateEntityMetadataPageRequest; } export interface EntityNonFungibleIdsPageRequest { stateEntityNonFungibleIdsPageRequest: StateEntityNonFungibleIdsPageRequest; } export interface EntityNonFungibleResourceVaultPageRequest { stateEntityNonFungibleResourceVaultsPageRequest: StateEntityNonFungibleResourceVaultsPageRequest; } export interface EntityNonFungiblesPageRequest { stateEntityNonFungiblesPageRequest: StateEntityNonFungiblesPageRequest; } export interface EntitySchemaPageRequest { stateEntitySchemaPageRequest: StateEntitySchemaPageRequest; } export interface KeyValueStoreDataRequest { stateKeyValueStoreDataRequest: StateKeyValueStoreDataRequest; } export interface KeyValueStoreKeysRequest { stateKeyValueStoreKeysRequest: StateKeyValueStoreKeysRequest; } export interface NonFungibleDataRequest { stateNonFungibleDataRequest: StateNonFungibleDataRequest; } export interface NonFungibleIdsRequest { stateNonFungibleIdsRequest: StateNonFungibleIdsRequest; } export interface NonFungibleLocationRequest { stateNonFungibleLocationRequest: StateNonFungibleLocationRequest; } export interface PackageBlueprintPageRequest { statePackageBlueprintPageRequest: StatePackageBlueprintPageRequest; } export interface PackageCodePageRequest { statePackageCodePageRequest: StatePackageCodePageRequest; } export interface StateEntityDetailsOperationRequest { stateEntityDetailsRequest: StateEntityDetailsRequest; } export interface StateValidatorsListOperationRequest { stateValidatorsListRequest: StateValidatorsListRequest; } /** * */ export declare class StateApi extends runtime.BaseAPI { /** * Returns paginable collection of authorized depositors for given account. * Get Account authorized depositors */ accountAuthorizedDepositorsPageRaw(requestParameters: AccountAuthorizedDepositorsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns paginable collection of authorized depositors for given account. * Get Account authorized depositors */ accountAuthorizedDepositorsPage(requestParameters: AccountAuthorizedDepositorsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all the resource vaults associated with a given account locker. The returned response is in a paginated format, ordered by the most recent resource vault creation on the ledger. * Get Account Locker Vaults Page */ accountLockerVaultsPageRaw(requestParameters: AccountLockerVaultsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all the resource vaults associated with a given account locker. The returned response is in a paginated format, ordered by the most recent resource vault creation on the ledger. * Get Account Locker Vaults Page */ accountLockerVaultsPage(requestParameters: AccountLockerVaultsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns most recent state version given account locker has been touched. Touch refers to the creation of the account locker itself as well as any modification to its contents, such as resource claim, airdrop or store. * Get Most Recent Touch of Account Lockers */ accountLockersTouchedAtRaw(requestParameters: AccountLockersTouchedAtRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns most recent state version given account locker has been touched. Touch refers to the creation of the account locker itself as well as any modification to its contents, such as resource claim, airdrop or store. * Get Most Recent Touch of Account Lockers */ accountLockersTouchedAt(requestParameters: AccountLockersTouchedAtRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns paginable collection of resource preference rules for given account. * Get Account resource preferences */ accountResourcePreferencesPageRaw(requestParameters: AccountResourcePreferencesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns paginable collection of resource preference rules for given account. * Get Account resource preferences */ accountResourcePreferencesPage(requestParameters: AccountResourcePreferencesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns vaults for fungible resource owned by a given global entity. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Fungible Resource Vaults */ entityFungibleResourceVaultPageRaw(requestParameters: EntityFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns vaults for fungible resource owned by a given global entity. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Fungible Resource Vaults */ entityFungibleResourceVaultPage(requestParameters: EntityFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the total amount of each fungible resource owned by a given global entity. Result can be aggregated globally or per vault. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Fungible Resource Balances */ entityFungiblesPageRaw(requestParameters: EntityFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the total amount of each fungible resource owned by a given global entity. Result can be aggregated globally or per vault. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Fungible Resource Balances */ entityFungiblesPage(requestParameters: EntityFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all the metadata properties associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Entity Metadata Page */ entityMetadataPageRaw(requestParameters: EntityMetadataPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all the metadata properties associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Entity Metadata Page */ entityMetadataPage(requestParameters: EntityMetadataPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all non-fungible IDs of a given non-fungible resource owned by a given entity. The returned response is in a paginated format, ordered by the resource\'s first appearence on the ledger. * Get page of Non-Fungibles in Vault */ entityNonFungibleIdsPageRaw(requestParameters: EntityNonFungibleIdsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all non-fungible IDs of a given non-fungible resource owned by a given entity. The returned response is in a paginated format, ordered by the resource\'s first appearence on the ledger. * Get page of Non-Fungibles in Vault */ entityNonFungibleIdsPage(requestParameters: EntityNonFungibleIdsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns vaults for non fungible resource owned by a given global entity. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Non-Fungible Resource Vaults */ entityNonFungibleResourceVaultPageRaw(requestParameters: EntityNonFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns vaults for non fungible resource owned by a given global entity. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Non-Fungible Resource Vaults */ entityNonFungibleResourceVaultPage(requestParameters: EntityNonFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the total amount of each non-fungible resource owned by a given global entity. Result can be aggregated globally or per vault. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Non-Fungible Resource Balances */ entityNonFungiblesPageRaw(requestParameters: EntityNonFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the total amount of each non-fungible resource owned by a given global entity. Result can be aggregated globally or per vault. The returned response is in a paginated format, ordered by the resource\'s first appearance on the ledger. * Get page of Global Entity Non-Fungible Resource Balances */ entityNonFungiblesPage(requestParameters: EntityNonFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all the schemas associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Entity Schema Page */ entitySchemaPageRaw(requestParameters: EntitySchemaPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all the schemas associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Entity Schema Page */ entitySchemaPage(requestParameters: EntitySchemaPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns data (value) associated with a given key of a given key-value store. [Check detailed documentation for explanation](#section/How-to-query-the-content-of-a-key-value-store-inside-a-component) * Get KeyValueStore Data */ keyValueStoreDataRaw(requestParameters: KeyValueStoreDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns data (value) associated with a given key of a given key-value store. [Check detailed documentation for explanation](#section/How-to-query-the-content-of-a-key-value-store-inside-a-component) * Get KeyValueStore Data */ keyValueStoreData(requestParameters: KeyValueStoreDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Allows to iterate over key value store keys. * Get KeyValueStore Keys */ keyValueStoreKeysRaw(requestParameters: KeyValueStoreKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Allows to iterate over key value store keys. * Get KeyValueStore Keys */ keyValueStoreKeys(requestParameters: KeyValueStoreKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns data associated with a given non-fungible ID of a given non-fungible resource. * Get Non-Fungible Data */ nonFungibleDataRaw(requestParameters: NonFungibleDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns data associated with a given non-fungible ID of a given non-fungible resource. * Get Non-Fungible Data */ nonFungibleData(requestParameters: NonFungibleDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns the non-fungible IDs of a given non-fungible resource. Returned response is in a paginated format, ordered by their first appearance on the ledger. * Get page of Non-Fungible Ids in Resource Collection */ nonFungibleIdsRaw(requestParameters: NonFungibleIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the non-fungible IDs of a given non-fungible resource. Returned response is in a paginated format, ordered by their first appearance on the ledger. * Get page of Non-Fungible Ids in Resource Collection */ nonFungibleIds(requestParameters: NonFungibleIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns location of a given non-fungible ID. * Get Non-Fungible Location */ nonFungibleLocationRaw(requestParameters: NonFungibleLocationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns location of a given non-fungible ID. * Get Non-Fungible Location */ nonFungibleLocation(requestParameters: NonFungibleLocationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all the blueprints associated with a given package entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Package Blueprints Page */ packageBlueprintPageRaw(requestParameters: PackageBlueprintPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all the blueprints associated with a given package entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Package Blueprints Page */ packageBlueprintPage(requestParameters: PackageBlueprintPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns all the codes associated with a given package entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Package Codes Page */ packageCodePageRaw(requestParameters: PackageCodePageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns all the codes associated with a given package entity. The returned response is in a paginated format, ordered by first appearance on the ledger. * Get Package Codes Page */ packageCodePage(requestParameters: PackageCodePageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns detailed information for collection of entities. Aggregate resources globally by default. * Get Entity Details */ stateEntityDetailsRaw(requestParameters: StateEntityDetailsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns detailed information for collection of entities. Aggregate resources globally by default. * Get Entity Details */ stateEntityDetails(requestParameters: StateEntityDetailsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get Validators List */ stateValidatorsListRaw(requestParameters: StateValidatorsListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get Validators List */ stateValidatorsList(requestParameters: StateValidatorsListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }