Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.455.3
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot committed Dec 16, 2024
1 parent 7951470 commit 2075a38
Show file tree
Hide file tree
Showing 22 changed files with 604 additions and 39 deletions.
41 changes: 36 additions & 5 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: 2b9c4bf6-4d87-4382-84d9-5fb3c84c7fad
management:
docChecksum: 21e433953628bb40823c36021dcb9f0a
docChecksum: 4155e3d49d853fdc3e6cf264ac0f997d
docVersion: Beta
speakeasyVersion: 1.453.10
generationVersion: 2.474.15
releaseVersion: 0.8.2
configChecksum: 171e0b0b43eb7e8867fa9d4b2d8a48f8
speakeasyVersion: 1.455.3
generationVersion: 2.479.3
releaseVersion: 0.8.3
configChecksum: 6f84b9a6cd393b8ea212cec077f58d26
repoURL: https://github.com/ava-labs/avacloud-sdk-typescript.git
installationURL: https://github.com/ava-labs/avacloud-sdk-typescript
published: true
Expand Down Expand Up @@ -281,6 +281,8 @@ generatedFiles:
- docs/models/components/rollingwindowmetricsapiresponse.md
- docs/models/components/security.md
- docs/models/components/sharedsecretsresponse.md
- docs/models/components/signatureaggregationresponse.md
- docs/models/components/signatureaggregatorrequest.md
- docs/models/components/sortbyoption.md
- docs/models/components/sortorder.md
- docs/models/components/sourcechainid.md
Expand Down Expand Up @@ -576,6 +578,7 @@ generatedFiles:
- docs/sdks/operations/README.md
- docs/sdks/primarynetwork/README.md
- docs/sdks/rewards/README.md
- docs/sdks/signatureaggregator/README.md
- docs/sdks/teleporter/README.md
- docs/sdks/transactions/README.md
- docs/sdks/usagemetrics/README.md
Expand Down Expand Up @@ -637,6 +640,7 @@ generatedFiles:
- src/funcs/dataPrimaryNetworkVerticesGetVertexByHash.ts
- src/funcs/dataPrimaryNetworkVerticesGetVertexByHeight.ts
- src/funcs/dataPrimaryNetworkVerticesListLatestXChainVertices.ts
- src/funcs/dataSignatureAggregatorAggregateSignatures.ts
- src/funcs/dataTeleporterGetTeleporterMessage.ts
- src/funcs/dataTeleporterListTeleporterMessages.ts
- src/funcs/dataTeleporterListTeleporterMessagesByAddress.ts
Expand Down Expand Up @@ -871,6 +875,8 @@ generatedFiles:
- src/models/components/rollingwindowmetricsapiresponse.ts
- src/models/components/security.ts
- src/models/components/sharedsecretsresponse.ts
- src/models/components/signatureaggregationresponse.ts
- src/models/components/signatureaggregatorrequest.ts
- src/models/components/sortbyoption.ts
- src/models/components/sortorder.ts
- src/models/components/stakingdistribution.ts
Expand Down Expand Up @@ -933,6 +939,7 @@ generatedFiles:
- src/models/errors/toomanyrequests.ts
- src/models/errors/unauthorized.ts
- src/models/operations/addaddressestowebhook.ts
- src/models/operations/aggregatesignatures.ts
- src/models/operations/compositequeryv2.ts
- src/models/operations/createwebhook.ts
- src/models/operations/datahealthcheck.ts
Expand Down Expand Up @@ -1036,6 +1043,7 @@ generatedFiles:
- src/sdk/primarynetwork.ts
- src/sdk/rewards.ts
- src/sdk/sdk.ts
- src/sdk/signatureaggregator.ts
- src/sdk/teleporter.ts
- src/sdk/transactions.ts
- src/sdk/usagemetrics.ts
Expand Down Expand Up @@ -3226,4 +3234,27 @@ examples:
application/json: {"message": "<value>", "statusCode": 502, "error": "Bad Gateway"}
"503":
application/json: {"message": [], "statusCode": 503, "error": "Service Unavailable"}
aggregateSignatures:
speakeasy-default-aggregate-signatures:
requestBody:
application/json: {"message": "000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000003cc0000000000059f3be606497285d0ffbb5ac9ba24aa60346a9b1812479ed66cb329f394a4b1c7000003a200000000000100000014253b2784c75e510dd0ff1da844684a1ac0aa5fcf00000380000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000001150000000000000000000000008578ae7723751446b196bd5124e1bf57b40eb7bc7fc93d85c6d62c5b2ac0b519c87010ea5294012d1e407030d6acd0021cac10d50000000000000000000000009660ed66aef60dfba5467afe865f612edbfb5c710000000000000000000000000000000000000000000000000000000000014c080000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000002800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000500000000000000000000000000000000000000000000000000000000000011a00000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011a20000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011b50000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011e80000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011e90000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000400000000000000000000000001c07f66981b45056e5024eb6d51f9f30aa0d28fd00000000000000000000000000000000000000000000000000038d7ea4c680000000000000000000000000000000000000000000", "justification": "0001abcdabcfff", "signingSubnetId": "7WtoAMPhrmh5KosDUsFL9yTcvw7YSxiKHPpdfs4JsgW47oZT5", "quorumPercentage": 50}
responses:
"201":
application/json: {"signedMessage": "0000000000059f3be606497285d0ffbb5ac9ba24aa60346a9b1812479ed66cb329f394a4b1c7000003a200000000000100000014253b2784c75e510dd0ff1da844684a1ac0aa5fcf00000380000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000001150000000000000000000000008578ae7723751446b196bd5124e1bf57b40eb7bc7fc93d85c6d62c5b2ac0b519c87010ea5294012d1e407030d6acd0021cac10d50000000000000000000000009660ed66aef60dfba5467afe865f612edbfb5c710000000000000000000000000000000000000000000000000000000000014c080000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000002800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000500000000000000000000000000000000000000000000000000000000000011a00000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011a20000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011b50000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011e80000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000011e90000000000000000000000007ec2afb0a06a73666adc24983ebdbf2b6f1d708200000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000400000000000000000000000001c07f66981b45056e5024eb6d51f9f30aa0d28fd00000000000000000000000000000000000000000000000000038d7ea4c68000000000000000000103807355b21dd497ecc9f560dfbdefc64aeec72b226c70d3793273db01d1a0c0bfd74d095d6a9e0b4db2dc652245fd28ac032c0f1f6b7f761b912ad58c93cde2e337bef4a4e8175af69f226520cd1baedd2dd7db79bb5752cb50a465531e46e8af"}
"400":
application/json: {"message": [], "statusCode": 400, "error": "Bad Request"}
"401":
application/json: {"message": ["<value>", "<value>"], "statusCode": 401, "error": "Unauthorized"}
"403":
application/json: {"message": "<value>", "statusCode": 403, "error": "Forbidden"}
"404":
application/json: {"message": ["<value>"], "statusCode": 404, "error": "Not Found"}
"429":
application/json: {"message": ["<value>"], "statusCode": 429, "error": "Too Many Requests"}
"500":
application/json: {"message": "<value>", "statusCode": 500, "error": "Internal Server Error"}
"502":
application/json: {"message": [], "statusCode": 502, "error": "Bad Gateway"}
"503":
application/json: {"message": "<value>", "statusCode": 503, "error": "Service Unavailable"}
generatedTests: {}
2 changes: 1 addition & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ generation:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
typescript:
version: 0.8.2
version: 0.8.3
additionalDependencies:
dependencies:
json-canonicalize: ^1.0.6
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
speakeasyVersion: 1.453.10
speakeasyVersion: 1.455.3
sources:
AvaCloudSDK-OAS:
sourceNamespace: avacloud-sdk-oas
sourceRevisionDigest: sha256:6b4280da639355b47fe2abf85ab13a5d409b0e86927b6f1c86ac8ba4aa654fba
sourceBlobDigest: sha256:0f93031f1bf44df2b07fe28b3d09cc86b9466ec81aa7ec7b4c3a3d82c3f2f20c
sourceRevisionDigest: sha256:427e2339ce2b9eb81a273c7bb83de00c43a308e09c84b0d7903fcf77b9319fd6
sourceBlobDigest: sha256:169dbb1bda661ac86728cf0e25a89bffd9fc653d0841861fe9b4721df7e80d00
tags:
- latest
- speakeasy-sdk-regen-1733444645
- speakeasy-sdk-regen-1734049462
- Beta
AvalancheSDK-OAS:
sourceNamespace: avalanche-sdk-oas
Expand All @@ -19,10 +19,10 @@ targets:
avacloud-sdk:
source: AvaCloudSDK-OAS
sourceNamespace: avacloud-sdk-oas
sourceRevisionDigest: sha256:6b4280da639355b47fe2abf85ab13a5d409b0e86927b6f1c86ac8ba4aa654fba
sourceBlobDigest: sha256:0f93031f1bf44df2b07fe28b3d09cc86b9466ec81aa7ec7b4c3a3d82c3f2f20c
sourceRevisionDigest: sha256:427e2339ce2b9eb81a273c7bb83de00c43a308e09c84b0d7903fcf77b9319fd6
sourceBlobDigest: sha256:169dbb1bda661ac86728cf0e25a89bffd9fc653d0841861fe9b4721df7e80d00
codeSamplesNamespace: avacloud-sdk-ts-code-samples
codeSamplesRevisionDigest: sha256:8f599360e4ba1eedb32310c22bae2dc5e6f5d5e7ae636810b56a7cd2ad5fc780
codeSamplesRevisionDigest: sha256:1fb35b8427e52e57400257751487603371d4102a047ecf2e4c3a7a1216474270
avalanche-sdk:
source: AvalancheSDK-OAS
sourceNamespace: avalanche-sdk-oas
Expand Down
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,10 @@ run();
* [getVertexByHash](docs/sdks/vertices/README.md#getvertexbyhash) - Get vertex
* [getVertexByHeight](docs/sdks/vertices/README.md#getvertexbyheight) - List vertices by height

#### [data.signatureAggregator](docs/sdks/signatureaggregator/README.md)

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

#### [data.teleporter](docs/sdks/teleporter/README.md)

* [getTeleporterMessage](docs/sdks/teleporter/README.md#getteleportermessage) - Get a teleporter message
Expand Down Expand Up @@ -314,6 +318,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`dataPrimaryNetworkVerticesGetVertexByHash`](docs/sdks/vertices/README.md#getvertexbyhash) - Get vertex
- [`dataPrimaryNetworkVerticesGetVertexByHeight`](docs/sdks/vertices/README.md#getvertexbyheight) - List vertices by height
- [`dataPrimaryNetworkVerticesListLatestXChainVertices`](docs/sdks/vertices/README.md#listlatestxchainvertices) - List vertices
- [`dataSignatureAggregatorAggregateSignatures`](docs/sdks/signatureaggregator/README.md#aggregatesignatures) - Aggregate Signatures
- [`dataTeleporterGetTeleporterMessage`](docs/sdks/teleporter/README.md#getteleportermessage) - Get a teleporter message
- [`dataTeleporterListTeleporterMessages`](docs/sdks/teleporter/README.md#listteleportermessages) - List teleporter messages
- [`dataTeleporterListTeleporterMessagesByAddress`](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress) - List teleporter messages by address
Expand Down Expand Up @@ -498,19 +503,7 @@ run();
<!-- Start Error Handling [errors] -->
## Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.

If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:

| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `reindexNft` method may throw the following errors:
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `reindexNft` method may throw the following errors:

| Error Type | Status Code | Content Type |
| -------------------------- | ----------- | ---------------- |
Expand All @@ -524,6 +517,8 @@ In addition, when custom error responses are specified for an operation, the SDK
| errors.ServiceUnavailable | 503 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* |

If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.

```typescript
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
import {
Expand Down Expand Up @@ -552,8 +547,9 @@ async function run() {
});
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
Expand Down Expand Up @@ -600,6 +596,7 @@ async function run() {
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
}
Expand All @@ -610,7 +607,17 @@ run();

```

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:

| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,14 @@ Based on:
### Generated
- [typescript v0.8.2] .
### Releases
- [NPM v0.8.2] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.8.2 - .
- [NPM v0.8.2] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.8.2 - .

## 2024-12-16 00:25:18
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.455.3 (2.479.3) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.8.3] .
### Releases
- [NPM v0.8.3] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.8.3 - .
Loading

0 comments on commit 2075a38

Please sign in to comment.