Skip to content

Commit f0b05e6

Browse files
committed
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.504.1
1 parent 2138d23 commit f0b05e6

File tree

354 files changed

+15028
-1116
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

354 files changed

+15028
-1116
lines changed

Diff for: .gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/mcp-server
2+
/bin
13
/.eslintcache
24
/.speakeasy/reports
35
/react-query

Diff for: .npmignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
!/REACT_QUERY.md
55
!/**/*.ts
66
!/**/*.js
7+
!/**/*.mjs
78
!/**/*.json
89
!/**/*.map
910

Diff for: .speakeasy/gen.lock

+225-7
Large diffs are not rendered by default.

Diff for: .speakeasy/gen.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ generation:
1010
useClassNamesForArrayFields: true
1111
fixes:
1212
nameResolutionDec2023: true
13+
nameResolutionFeb2025: false
1314
parameterOrderingFeb2024: true
1415
requestResponseComponentNamesFeb2024: true
1516
securityFeb2025: false
1617
auth:
1718
oAuth2ClientCredentialsEnabled: false
1819
oAuth2PasswordEnabled: false
1920
typescript:
20-
version: 0.9.0
21+
version: 0.10.0
2122
additionalDependencies:
2223
dependencies:
2324
json-canonicalize: ^1.0.6
@@ -31,6 +32,7 @@ typescript:
3132
clientServerStatusCodesAsErrors: true
3233
defaultErrorName: SDKError
3334
enableCustomCodeRegions: false
35+
enableMCPServer: true
3436
enableReactQuery: false
3537
enumFormat: union
3638
flattenGlobalSecurity: true

Diff for: .speakeasy/workflow.lock

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
speakeasyVersion: 1.490.0
1+
speakeasyVersion: 1.504.1
22
sources:
33
AvaCloudSDK-OAS:
44
sourceNamespace: avacloud-sdk-oas
5-
sourceRevisionDigest: sha256:42f5f844a96446d526d41aeb2ffa168ae70fb7572e0343a098ce09760d138d72
6-
sourceBlobDigest: sha256:abec65bf25480622137358df6fe57f470da538b9cc9e5daaaa3ee54f3791bc4a
5+
sourceRevisionDigest: sha256:60cc14d7fd929eda93a337d3fe231d6acd94ecedae164a457ddc67f9383e19fa
6+
sourceBlobDigest: sha256:e533f391242de47b191699856f0b9ce0ea959ba2474ff8f3b7e5a3039a25bf00
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1738628520
9+
- speakeasy-sdk-regen-1740516635
1010
- Beta
1111
AvalancheSDK-OAS:
1212
sourceNamespace: avalanche-sdk-oas
@@ -19,10 +19,10 @@ targets:
1919
avacloud-sdk:
2020
source: AvaCloudSDK-OAS
2121
sourceNamespace: avacloud-sdk-oas
22-
sourceRevisionDigest: sha256:42f5f844a96446d526d41aeb2ffa168ae70fb7572e0343a098ce09760d138d72
23-
sourceBlobDigest: sha256:abec65bf25480622137358df6fe57f470da538b9cc9e5daaaa3ee54f3791bc4a
22+
sourceRevisionDigest: sha256:60cc14d7fd929eda93a337d3fe231d6acd94ecedae164a457ddc67f9383e19fa
23+
sourceBlobDigest: sha256:e533f391242de47b191699856f0b9ce0ea959ba2474ff8f3b7e5a3039a25bf00
2424
codeSamplesNamespace: avacloud-sdk-ts-code-samples
25-
codeSamplesRevisionDigest: sha256:dbf53ebb47e76d369ea9261f4af784a5b3faf33cae6e05de5b3ff9b3541a97cc
25+
codeSamplesRevisionDigest: sha256:6d9023fcd0e0d3c5b787417012260fb94dd9f23b7cb0e406564787f03e1c8d33
2626
avalanche-sdk:
2727
source: AvalancheSDK-OAS
2828
sourceNamespace: avalanche-sdk-oas

Diff for: FUNCTIONS.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { SDKValidationError } from "@avalabs/avacloud-sdk/models/errors/sdkvalid
2626
// Use `AvaCloudSDKCore` for best tree-shaking performance.
2727
// You can create one instance of it to use across an application.
2828
const avaCloudSDK = new AvaCloudSDKCore({
29+
serverURL: "https://api.example.com",
2930
chainId: "43114",
3031
network: "mainnet",
3132
});

Diff for: README.md

+90-14
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,61 @@ yarn add @avalabs/avacloud-sdk zod
4141
# Note that Yarn does not install peer dependencies automatically. You will need
4242
# to install zod as shown above.
4343
```
44+
45+
46+
47+
### Model Context Protocol (MCP) Server
48+
49+
This SDK is also an installable MCP server where the various SDK methods are
50+
exposed as tools that can be invoked by AI applications.
51+
52+
> Node.js v20 or greater is required to run the MCP server.
53+
54+
<details>
55+
<summary>Claude installation steps</summary>
56+
57+
Add the following server definition to your `claude_desktop_config.json` file:
58+
59+
```json
60+
{
61+
"mcpServers": {
62+
"AvaCloudSDK": {
63+
"command": "npx",
64+
"args": [
65+
"-y", "--package", "@avalabs/avacloud-sdk",
66+
"--",
67+
"mcp", "start",
68+
"--server-url", "...",
69+
"--api-key", "...",
70+
"--chain-id", "...",
71+
"--network", "..."
72+
]
73+
}
74+
}
75+
}
76+
```
77+
78+
</details>
79+
80+
<details>
81+
<summary>Cursor installation steps</summary>
82+
83+
Go to `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
84+
85+
- Name: AvaCloudSDK
86+
- Type: `command`
87+
- Command:
88+
```sh
89+
npx -y --package @avalabs/avacloud-sdk -- mcp start --server-url ... --api-key ... --chain-id ... --network ...
90+
```
91+
92+
</details>
93+
94+
For a full list of server arguments, run:
95+
96+
```sh
97+
npx -y --package @avalabs/avacloud-sdk -- mcp start --help
98+
```
4499
<!-- End SDK Installation [installation] -->
45100

46101
<!-- Start Requirements [requirements] -->
@@ -58,6 +113,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
58113
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
59114

60115
const avaCloudSDK = new AvaCloudSDK({
116+
serverURL: "https://api.example.com",
61117
chainId: "43114",
62118
network: "mainnet",
63119
});
@@ -140,6 +196,12 @@ run();
140196

141197
* [dataHealthCheck](docs/sdks/avacloudsdkhealthcheck/README.md#datahealthcheck) - Get the health of the service
142198

199+
#### [data.icm](docs/sdks/icm/README.md)
200+
201+
* [getIcmMessage](docs/sdks/icm/README.md#geticmmessage) - Get an ICM message
202+
* [listIcmMessages](docs/sdks/icm/README.md#listicmmessages) - List ICM messages
203+
* [listIcmMessagesByAddress](docs/sdks/icm/README.md#listicmmessagesbyaddress) - List ICM messages by address
204+
143205
#### [data.nfts](docs/sdks/nfts/README.md)
144206

145207
* [reindexNft](docs/sdks/nfts/README.md#reindexnft) - Reindex NFT metadata
@@ -200,11 +262,17 @@ run();
200262

201263
* [aggregateSignatures](docs/sdks/signatureaggregator/README.md#aggregatesignatures) - Aggregate Signatures
202264

203-
#### [data.teleporter](docs/sdks/teleporter/README.md)
265+
#### [~~data.teleporter~~](docs/sdks/teleporter/README.md)
266+
267+
* [~~getTeleporterMessage~~](docs/sdks/teleporter/README.md#getteleportermessage) - **[Deprecated]** Gets a teleporter message by message ID.
204268

205-
* [getTeleporterMessage](docs/sdks/teleporter/README.md#getteleportermessage) - Get a teleporter message
206-
* [listTeleporterMessages](docs/sdks/teleporter/README.md#listteleportermessages) - List teleporter messages
207-
* [listTeleporterMessagesByAddress](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress) - List teleporter messages by address
269+
⚠️ **This operation will be removed in a future release. Please use /v1/icm/messages/:messageId endpoint instead** . :warning: **Deprecated**
270+
* [~~listTeleporterMessages~~](docs/sdks/teleporter/README.md#listteleportermessages) - **[Deprecated]** Lists teleporter messages. Ordered by timestamp in descending order.
271+
272+
⚠️ **This operation will be removed in a future release. Please use /v1/icm/messages endpoint instead** . :warning: **Deprecated**
273+
* [~~listTeleporterMessagesByAddress~~](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress) - **[Deprecated]** Lists teleporter messages by address. Ordered by timestamp in descending order.
274+
275+
⚠️ **This operation will be removed in a future release. Please use /v1/icm/addresses/:address/messages endpoint instead** . :warning: **Deprecated**
208276

209277
#### [data.usageMetrics](docs/sdks/usagemetrics/README.md)
210278

@@ -302,6 +370,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
302370
- [`dataEvmTransactionsListTransactions`](docs/sdks/transactions/README.md#listtransactions) - List transactions
303371
- [`dataEvmTransactionsListTransfers`](docs/sdks/transactions/README.md#listtransfers) - List ERC transfers
304372
- [`dataHealthCheckDataHealthCheck`](docs/sdks/avacloudsdkhealthcheck/README.md#datahealthcheck) - Get the health of the service
373+
- [`dataIcmGetIcmMessage`](docs/sdks/icm/README.md#geticmmessage) - Get an ICM message
374+
- [`dataIcmListIcmMessages`](docs/sdks/icm/README.md#listicmmessages) - List ICM messages
375+
- [`dataIcmListIcmMessagesByAddress`](docs/sdks/icm/README.md#listicmmessagesbyaddress) - List ICM messages by address
305376
- [`dataNftsGetTokenDetails`](docs/sdks/nfts/README.md#gettokendetails) - Get token details
306377
- [`dataNftsListTokens`](docs/sdks/nfts/README.md#listtokens) - List tokens
307378
- [`dataNftsReindexNft`](docs/sdks/nfts/README.md#reindexnft) - Reindex NFT metadata
@@ -332,9 +403,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
332403
- [`dataPrimaryNetworkVerticesGetVertexByHeight`](docs/sdks/vertices/README.md#getvertexbyheight) - List vertices by height
333404
- [`dataPrimaryNetworkVerticesListLatestXChainVertices`](docs/sdks/vertices/README.md#listlatestxchainvertices) - List vertices
334405
- [`dataSignatureAggregatorAggregateSignatures`](docs/sdks/signatureaggregator/README.md#aggregatesignatures) - Aggregate Signatures
335-
- [`dataTeleporterGetTeleporterMessage`](docs/sdks/teleporter/README.md#getteleportermessage) - Get a teleporter message
336-
- [`dataTeleporterListTeleporterMessages`](docs/sdks/teleporter/README.md#listteleportermessages) - List teleporter messages
337-
- [`dataTeleporterListTeleporterMessagesByAddress`](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress) - List teleporter messages by address
338406
- [`dataUsageMetricsGetApiLogs`](docs/sdks/usagemetrics/README.md#getapilogs) - Get logs for requests made by client
339407
- [`dataUsageMetricsGetApiUsageMetrics`](docs/sdks/usagemetrics/README.md#getapiusagemetrics) - Get usage metrics for the Data API
340408
- [`dataUsageMetricsGetRpcUsageMetrics`](docs/sdks/usagemetrics/README.md#getrpcusagemetrics) - Get usage metrics for the Subnet RPC
@@ -369,6 +437,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
369437
- ~~[`dataEvmChainsListAllLatestTransactions`](docs/sdks/avacloudsdkchains/README.md#listalllatesttransactions)~~ - **[Deprecated]** Lists the latest transactions for all supported EVM chains. Filterable by status.
370438

371439
⚠️ **This operation will be removed in a future release. Please use /v1/transactions endpoint instead** . :warning: **Deprecated**
440+
- ~~[`dataTeleporterGetTeleporterMessage`](docs/sdks/teleporter/README.md#getteleportermessage)~~ - **[Deprecated]** Gets a teleporter message by message ID.
441+
442+
⚠️ **This operation will be removed in a future release. Please use /v1/icm/messages/:messageId endpoint instead** . :warning: **Deprecated**
443+
- ~~[`dataTeleporterListTeleporterMessages`](docs/sdks/teleporter/README.md#listteleportermessages)~~ - **[Deprecated]** Lists teleporter messages. Ordered by timestamp in descending order.
444+
445+
⚠️ **This operation will be removed in a future release. Please use /v1/icm/messages endpoint instead** . :warning: **Deprecated**
446+
- ~~[`dataTeleporterListTeleporterMessagesByAddress`](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress)~~ - **[Deprecated]** Lists teleporter messages by address. Ordered by timestamp in descending order.
447+
448+
⚠️ **This operation will be removed in a future release. Please use /v1/icm/addresses/:address/messages endpoint instead** . :warning: **Deprecated**
372449

373450
</details>
374451
<!-- End Standalone functions [standalone-funcs] -->
@@ -396,6 +473,7 @@ The following global parameters are available.
396473
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
397474

398475
const avaCloudSDK = new AvaCloudSDK({
476+
serverURL: "https://api.example.com",
399477
chainId: "43114",
400478
network: "mainnet",
401479
});
@@ -432,6 +510,7 @@ Here's an example of one such pagination call:
432510
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
433511

434512
const avaCloudSDK = new AvaCloudSDK({
513+
serverURL: "https://api.example.com",
435514
chainId: "43114",
436515
network: "mainnet",
437516
});
@@ -462,6 +541,7 @@ To change the default retry strategy for a single API call, simply provide a ret
462541
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
463542

464543
const avaCloudSDK = new AvaCloudSDK({
544+
serverURL: "https://api.example.com",
465545
chainId: "43114",
466546
network: "mainnet",
467547
});
@@ -493,6 +573,7 @@ If you'd like to override the default retry strategy for all operations that sup
493573
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
494574

495575
const avaCloudSDK = new AvaCloudSDK({
576+
serverURL: "https://api.example.com",
496577
retryConfig: {
497578
strategy: "backoff",
498579
backoff: {
@@ -553,6 +634,7 @@ import {
553634
} from "@avalabs/avacloud-sdk/models/errors";
554635

555636
const avaCloudSDK = new AvaCloudSDK({
637+
serverURL: "https://api.example.com",
556638
chainId: "43114",
557639
network: "mainnet",
558640
});
@@ -639,12 +721,6 @@ In some rare cases, the SDK can fail to get a response from the server or even m
639721
| UnexpectedClientError | Unrecognised or unexpected error |
640722
<!-- End Error Handling [errors] -->
641723

642-
<!-- Start Server Selection [server] -->
643-
## Server Selection
644-
645-
646-
<!-- End Server Selection [server] -->
647-
648724
<!-- Start Custom HTTP Client [http-client] -->
649725
## Custom HTTP Client
650726

@@ -710,6 +786,7 @@ To authenticate with the API the `apiKey` parameter must be set when initializin
710786
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
711787

712788
const avaCloudSDK = new AvaCloudSDK({
789+
serverURL: "https://api.example.com",
713790
apiKey: "<YOUR_API_KEY_HERE>",
714791
chainId: "43114",
715792
network: "mainnet",
@@ -762,7 +839,6 @@ Data API: The Data API provides web3 application developers with multi-chain dat
762839
* [Pagination](#pagination)
763840
* [Retries](#retries)
764841
* [Error Handling](#error-handling)
765-
* [Server Selection](#server-selection)
766842
* [Custom HTTP Client](#custom-http-client)
767843
* [Authentication](#authentication)
768844
* [Debugging](#debugging)

Diff for: RELEASES.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -249,4 +249,14 @@ Based on:
249249
### Generated
250250
- [typescript v0.9.0] .
251251
### Releases
252-
- [NPM v0.9.0] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.9.0 - .
252+
- [NPM v0.9.0] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.9.0 - .
253+
254+
## 2025-02-26 00:22:37
255+
### Changes
256+
Based on:
257+
- OpenAPI Doc
258+
- Speakeasy CLI 1.504.1 (2.529.2) https://github.com/speakeasy-api/speakeasy
259+
### Generated
260+
- [typescript v0.10.0] .
261+
### Releases
262+
- [NPM v0.10.0] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.10.0 - .

Diff for: USAGE.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
44

55
const avaCloudSDK = new AvaCloudSDK({
6+
serverURL: "https://api.example.com",
67
chainId: "43114",
78
network: "mainnet",
89
});

0 commit comments

Comments
 (0)