Skip to content

Commit

Permalink
chore: Update API schema to 1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dhedey committed Jan 29, 2024
1 parent d914c03 commit 39b8a20
Show file tree
Hide file tree
Showing 632 changed files with 1,065 additions and 813 deletions.
3 changes: 3 additions & 0 deletions sdk/typescript/lib/generated/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ models/NotSyncedUpErrorAllOf.ts
models/ObjectModuleId.ts
models/OptionalNonFungibleIdsCollection.ts
models/OptionalNonFungibleIdsCollectionAllOf.ts
models/PackageCodeCollectionItem.ts
models/PackageVmType.ts
models/ProgrammaticScryptoSborValue.ts
models/ProgrammaticScryptoSborValueArray.ts
Expand Down Expand Up @@ -233,6 +234,8 @@ models/StateEntityDetailsResponsePackageDetailsAllOf.ts
models/StateEntityDetailsResponsePackageDetailsBlueprintCollection.ts
models/StateEntityDetailsResponsePackageDetailsBlueprintCollectionAllOf.ts
models/StateEntityDetailsResponsePackageDetailsBlueprintItem.ts
models/StateEntityDetailsResponsePackageDetailsCodeCollection.ts
models/StateEntityDetailsResponsePackageDetailsCodeCollectionAllOf.ts
models/StateEntityDetailsResponsePackageDetailsSchemaCollection.ts
models/StateEntityDetailsResponsePackageDetailsSchemaCollectionAllOf.ts
models/StateEntityDetailsResponsePackageDetailsSchemaItem.ts
Expand Down
26 changes: 13 additions & 13 deletions sdk/typescript/lib/generated/apis/StateApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* 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.2.2
* The version of the OpenAPI document: v1.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -149,7 +149,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 vault page of Entity Fungible resource aggregated per vault
* Get page of Global Entity Fungible Resource Vaults
*/
async entityFungibleResourceVaultPageRaw(requestParameters: EntityFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateEntityFungibleResourceVaultsPageResponse>> {
if (requestParameters.stateEntityFungibleResourceVaultsPageRequest === null || requestParameters.stateEntityFungibleResourceVaultsPageRequest === undefined) {
Expand All @@ -175,7 +175,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 vault page of Entity Fungible resource aggregated per vault
* Get page of Global Entity Fungible Resource Vaults
*/
async entityFungibleResourceVaultPage(requestParameters: EntityFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateEntityFungibleResourceVaultsPageResponse> {
const response = await this.entityFungibleResourceVaultPageRaw(requestParameters, initOverrides);
Expand All @@ -184,7 +184,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Entity Fungible Resource Totals Page aggregated globally
* Get page of Global Entity Fungible Resource Balances
*/
async entityFungiblesPageRaw(requestParameters: EntityFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateEntityFungiblesPageResponse>> {
if (requestParameters.stateEntityFungiblesPageRequest === null || requestParameters.stateEntityFungiblesPageRequest === undefined) {
Expand All @@ -210,7 +210,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Entity Fungible Resource Totals Page aggregated globally
* Get page of Global Entity Fungible Resource Balances
*/
async entityFungiblesPage(requestParameters: EntityFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateEntityFungiblesPageResponse> {
const response = await this.entityFungiblesPageRaw(requestParameters, initOverrides);
Expand Down Expand Up @@ -254,7 +254,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Entity Non-Fungible IDs
* Get page of Non-Fungibles in Vault
*/
async entityNonFungibleIdsPageRaw(requestParameters: EntityNonFungibleIdsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateEntityNonFungibleIdsPageResponse>> {
if (requestParameters.stateEntityNonFungibleIdsPageRequest === null || requestParameters.stateEntityNonFungibleIdsPageRequest === undefined) {
Expand All @@ -280,7 +280,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Entity Non-Fungible IDs
* Get page of Non-Fungibles in Vault
*/
async entityNonFungibleIdsPage(requestParameters: EntityNonFungibleIdsPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateEntityNonFungibleIdsPageResponse> {
const response = await this.entityNonFungibleIdsPageRaw(requestParameters, initOverrides);
Expand All @@ -289,7 +289,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 vault page of Entity Non Fungible aggregated per vault
* Get page of Global Entity Non-Fungible Resource Vaults
*/
async entityNonFungibleResourceVaultPageRaw(requestParameters: EntityNonFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateEntityNonFungibleResourceVaultsPageResponse>> {
if (requestParameters.stateEntityNonFungibleResourceVaultsPageRequest === null || requestParameters.stateEntityNonFungibleResourceVaultsPageRequest === undefined) {
Expand All @@ -315,7 +315,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 vault page of Entity Non Fungible aggregated per vault
* Get page of Global Entity Non-Fungible Resource Vaults
*/
async entityNonFungibleResourceVaultPage(requestParameters: EntityNonFungibleResourceVaultPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateEntityNonFungibleResourceVaultsPageResponse> {
const response = await this.entityNonFungibleResourceVaultPageRaw(requestParameters, initOverrides);
Expand All @@ -324,7 +324,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Entity Non-Fungible Resource Totals Page aggregated globally
* Get page of Global Entity Non-Fungible Resource Balances
*/
async entityNonFungiblesPageRaw(requestParameters: EntityNonFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateEntityNonFungiblesPageResponse>> {
if (requestParameters.stateEntityNonFungiblesPageRequest === null || requestParameters.stateEntityNonFungiblesPageRequest === undefined) {
Expand All @@ -350,7 +350,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Entity Non-Fungible Resource Totals Page aggregated globally
* Get page of Global Entity Non-Fungible Resource Balances
*/
async entityNonFungiblesPage(requestParameters: EntityNonFungiblesPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateEntityNonFungiblesPageResponse> {
const response = await this.entityNonFungiblesPageRaw(requestParameters, initOverrides);
Expand Down Expand Up @@ -429,7 +429,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Non-Fungible Collection
* Get page of Non-Fungible Ids in Resource Collection
*/
async nonFungibleIdsRaw(requestParameters: NonFungibleIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StateNonFungibleIdsResponse>> {
if (requestParameters.stateNonFungibleIdsRequest === null || requestParameters.stateNonFungibleIdsRequest === undefined) {
Expand All @@ -455,7 +455,7 @@ export class StateApi extends runtime.BaseAPI {

/**
* 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 Non-Fungible Collection
* Get page of Non-Fungible Ids in Resource Collection
*/
async nonFungibleIds(requestParameters: NonFungibleIdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StateNonFungibleIdsResponse> {
const response = await this.nonFungibleIdsRaw(requestParameters, initOverrides);
Expand Down
2 changes: 1 addition & 1 deletion sdk/typescript/lib/generated/apis/StatisticsApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* 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.2.2
* The version of the OpenAPI document: v1.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion sdk/typescript/lib/generated/apis/StatusApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* 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.2.2
* The version of the OpenAPI document: v1.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion sdk/typescript/lib/generated/apis/StreamApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* 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.2.2
* The version of the OpenAPI document: v1.3.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
Loading

0 comments on commit 39b8a20

Please sign in to comment.