Skip to content

Commit

Permalink
Merge pull request #33 from ava-labs/speakeasy-sdk-regen-1727828506
Browse files Browse the repository at this point in the history
chore: 🐝 Update SDK - Generate 0.6.1
  • Loading branch information
SayanKar authored Oct 3, 2024
2 parents 28def1d + b8c86cd commit a82b89e
Show file tree
Hide file tree
Showing 137 changed files with 382 additions and 555 deletions.
12 changes: 6 additions & 6 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: 4eba30cda024caf8d26a77769245c028
docChecksum: 8c4d190a1bb4c0404c840c648989cfcf
docVersion: Beta
speakeasyVersion: 1.404.5
generationVersion: 2.426.2
releaseVersion: 0.6.0
configChecksum: f5c0c3a7211079b363c1b44088b13d00
speakeasyVersion: 1.406.0
generationVersion: 2.429.0
releaseVersion: 0.6.1
configChecksum: e7a878f44183448a7a63a40cda87a099
repoURL: https://github.com/ava-labs/avacloud-sdk-typescript.git
installationURL: https://github.com/ava-labs/avacloud-sdk-typescript
published: true
Expand All @@ -15,7 +15,7 @@ features:
additionalDependencies: 0.1.0
additionalProperties: 0.1.1
constsAndDefaults: 0.1.11
core: 3.18.0
core: 3.18.2
defaultEnabledRetries: 0.1.0
deprecations: 2.81.1
devContainers: 2.90.0
Expand Down
3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
typescript:
version: 0.6.0
version: 0.6.1
additionalDependencies:
dependencies:
json-canonicalize: ^1.0.6
Expand All @@ -29,6 +29,7 @@ typescript:
clientServerStatusCodesAsErrors: true
enumFormat: union
flattenGlobalSecurity: true
flatteningOrder: body-first
imports:
option: openapi
paths:
Expand Down
12 changes: 6 additions & 6 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
speakeasyVersion: 1.404.5
speakeasyVersion: 1.406.0
sources:
AvaCloudSDK-OAS:
sourceNamespace: avacloud-sdk-oas
sourceRevisionDigest: sha256:c63b3800786d77cd253bce2817cf247bf93ee6d9ee636356583af9521e3719d4
sourceBlobDigest: sha256:59c18541b6aa818777cea16543d1140770c4bb9413cca098045ec7cc7566f344
sourceRevisionDigest: sha256:04a696b86fa5043a10de55c6898c9cfe0a57cd27b90950463820a24e8cf1375c
sourceBlobDigest: sha256:4785b6d15e8230d8b66dfaef1b9c7161937b6c9c694060c41fd5dcda2d7f5dc6
tags:
- latest
- main
Expand All @@ -18,10 +18,10 @@ targets:
avacloud-sdk:
source: AvaCloudSDK-OAS
sourceNamespace: avacloud-sdk-oas
sourceRevisionDigest: sha256:c63b3800786d77cd253bce2817cf247bf93ee6d9ee636356583af9521e3719d4
sourceBlobDigest: sha256:59c18541b6aa818777cea16543d1140770c4bb9413cca098045ec7cc7566f344
sourceRevisionDigest: sha256:04a696b86fa5043a10de55c6898c9cfe0a57cd27b90950463820a24e8cf1375c
sourceBlobDigest: sha256:4785b6d15e8230d8b66dfaef1b9c7161937b6c9c694060c41fd5dcda2d7f5dc6
codeSamplesNamespace: avacloud-sdk-ts-code-samples
codeSamplesRevisionDigest: sha256:cfab3496784f7f2ef80741f7d1233fc190d42f1fbb6358a5448bff40a787f542
codeSamplesRevisionDigest: sha256:8715d9c2cf5a391a5abde9af053f4a08bc84a1df1cf85db3b976a10e91ab9f3a
avalanche-sdk:
source: AvalancheSDK-OAS
sourceNamespace: avalanche-sdk-oas
Expand Down
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,9 +496,21 @@ run();
<!-- Start Error Handling [errors] -->
## Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.

| Error Object | Status Code | Content Type |
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:

| Error Type | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| errors.BadRequest | 400 | application/json |
| errors.Unauthorized | 401 | application/json |
Expand All @@ -508,10 +520,7 @@ All SDK methods return a response object or throw an error. If Error objects are
| errors.InternalServerError | 500 | application/json |
| errors.BadGateway | 502 | application/json |
| errors.ServiceUnavailable | 503 | application/json |
| errors.SDKError | 4xx-5xx | */* |

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.

| errors.SDKError | 4XX, 5XX | \*/\* |

```typescript
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
Expand Down Expand Up @@ -598,6 +607,8 @@ async function run() {
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.
<!-- 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 @@ -79,4 +79,14 @@ Based on:
### Generated
- [typescript v0.6.0] .
### Releases
- [NPM v0.6.0] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.6.0 - .
- [NPM v0.6.0] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.6.0 - .

## 2024-10-03 00:21:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.6.1] .
### Releases
- [NPM v0.6.1] https://www.npmjs.com/package/@avalabs/avacloud-sdk/v/0.6.1 - .
2 changes: 1 addition & 1 deletion docs/models/components/blockchainid.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ let value: BlockchainId = "p-chain";
## Values

```typescript
"11111111111111111111111111111111LpoYY" | "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM" | "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm" | "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5" | "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp" | "p-chain" | "x-chain" | "c-chain"
"11111111111111111111111111111111LpoYY" | "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM" | "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm" | "2piQ2AVHCjnduiWXsSY15DtbVuwHE2cwMHYnEXHsLL73BBkdbV" | "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5" | "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp" | "vV3cui1DsEPC3nLCGH9rorwo8s6BYxM2Hz4QFE5gEYjwTqAu" | "p-chain" | "x-chain" | "c-chain"
```
2 changes: 1 addition & 1 deletion docs/models/components/blockchainids.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ let value: BlockchainIds = "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5";
## Values

```typescript
"11111111111111111111111111111111LpoYY" | "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM" | "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm" | "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5" | "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp"
"11111111111111111111111111111111LpoYY" | "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM" | "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm" | "2piQ2AVHCjnduiWXsSY15DtbVuwHE2cwMHYnEXHsLL73BBkdbV" | "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5" | "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp" | "vV3cui1DsEPC3nLCGH9rorwo8s6BYxM2Hz4QFE5gEYjwTqAu"
```
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ let value: ChainAddressChainIdMapListResponse = {
{
address: "40652 Botsford Neck",
blockchainIds: [
"yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp",
"vV3cui1DsEPC3nLCGH9rorwo8s6BYxM2Hz4QFE5gEYjwTqAu",
],
},
],
Expand Down
6 changes: 2 additions & 4 deletions docs/models/components/createevmtransactionexportrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ let value: CreateEvmTransactionExportRequest = {
type: "TRANSACTION_EXPORT_EVM",
firstDate: "2023-05-01",
lastDate: "2023-05-02",
startDate: "2023-05-01",
endDate: "2023-05-02",
options: {
addresses: [
"<value>",
Expand All @@ -29,6 +27,6 @@ let value: CreateEvmTransactionExportRequest = {
| `type` | [components.EVMOperationType](../../models/components/evmoperationtype.md) | :heavy_check_mark: | N/A | |
| `firstDate` | *string* | :heavy_minus_sign: | N/A | 2023-05-01 |
| `lastDate` | *string* | :heavy_minus_sign: | N/A | 2023-05-02 |
| ~~`startDate`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-01 |
| ~~`endDate`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-02 |
| ~~`startDate`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-01 |
| ~~`endDate`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-02 |
| `options` | [components.EvmNetworkOptions](../../models/components/evmnetworkoptions.md) | :heavy_check_mark: | N/A | |
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ let value: CreatePrimaryNetworkTransactionExportRequest = {
type: "TRANSACTION_EXPORT_PRIMARY_NETWORK_STAKING",
firstDate: "2023-05-01",
lastDate: "2023-05-02",
startDate: "2023-05-01",
endDate: "2023-05-02",
options: {
includeChains: [
"p-chain",
Expand All @@ -26,6 +24,6 @@ let value: CreatePrimaryNetworkTransactionExportRequest = {
| `type` | [components.PrimaryNetworkOperationType](../../models/components/primarynetworkoperationtype.md) | :heavy_check_mark: | N/A | |
| `firstDate` | *string* | :heavy_minus_sign: | N/A | 2023-05-01 |
| `lastDate` | *string* | :heavy_minus_sign: | N/A | 2023-05-02 |
| ~~`startDate`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-01 |
| ~~`endDate`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-02 |
| ~~`startDate`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-01 |
| ~~`endDate`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | 2023-05-02 |
| `options` | [components.PrimaryNetworkOptions](../../models/components/primarynetworkoptions.md) | :heavy_check_mark: | N/A | |
2 changes: 1 addition & 1 deletion docs/models/components/globalparamnetwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ let value: GlobalParamNetwork = "mainnet";
## Values

```typescript
"mainnet" | "fuji" | "testnet"
"mainnet" | "fuji" | "testnet" | "devnet"
```
Loading

0 comments on commit a82b89e

Please sign in to comment.