Auto-generated SDK Docs and Readme for Data, Webhooks, and Metrics

sdk/docs/models/components/listicmmessagesresponsemessage.md

@@ -3,10 +3,10 @@
 
 ## Supported Types
 
-### `components.DeliveredIcmMessage`
+### `components.PendingIcmMessage`
 
 ```typescript
-const value: components.DeliveredIcmMessage = {
+const value: components.PendingIcmMessage = {
   messageId: "<id>",
   icmContractAddress: "<value>",
   sourceBlockchainId: "<id>",
@@ -16,9 +16,9 @@ const value: components.DeliveredIcmMessage = {
   messageNonce: "<value>",
   from: "<value>",
   to: "<value>",
-  messageExecuted: true,
+  messageExecuted: false,
   receipts: [],
-  receiptDelivered: true,
+  receiptDelivered: false,
   rewardDetails: {
     address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
     name: "Wrapped AVAX",
@@ -38,21 +38,14 @@ const value: components.DeliveredIcmMessage = {
     timestamp: 6459.73,
     gasSpent: "<value>",
   },
-  destinationTransaction: {
-    txHash: "<value>",
-    timestamp: 8250.11,
-    gasSpent: "<value>",
-    rewardRedeemer: "<value>",
-    delivererAddress: "<value>",
-  },
-  status: "delivered",
+  status: "pending",
 };
 ```
 
-### `components.PendingIcmMessage`
+### `components.DeliveredIcmMessage`
 
 ```typescript
-const value: components.PendingIcmMessage = {
+const value: components.DeliveredIcmMessage = {
   messageId: "<id>",
   icmContractAddress: "<value>",
   sourceBlockchainId: "<id>",
@@ -62,9 +55,9 @@ const value: components.PendingIcmMessage = {
   messageNonce: "<value>",
   from: "<value>",
   to: "<value>",
-  messageExecuted: false,
+  messageExecuted: true,
   receipts: [],
-  receiptDelivered: false,
+  receiptDelivered: true,
   rewardDetails: {
     address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
     name: "Wrapped AVAX",
@@ -84,7 +77,14 @@ const value: components.PendingIcmMessage = {
     timestamp: 6459.73,
     gasSpent: "<value>",
   },
-  status: "pending",
+  destinationTransaction: {
+    txHash: "<value>",
+    timestamp: 8250.11,
+    gasSpent: "<value>",
+    rewardRedeemer: "<value>",
+    delivererAddress: "<value>",
+  },
+  status: "delivered",
 };
 ```
 

sdk/docs/models/components/listteleportermessagesresponsemessage.md

@@ -3,10 +3,10 @@
 
 ## Supported Types
 
-### `components.DeliveredTeleporterMessage`
+### `components.PendingTeleporterMessage`
 
 ```typescript
-const value: components.DeliveredTeleporterMessage = {
+const value: components.PendingTeleporterMessage = {
   messageId: "<id>",
   teleporterContractAddress: "<value>",
   sourceBlockchainId: "<id>",
@@ -38,21 +38,14 @@ const value: components.DeliveredTeleporterMessage = {
     timestamp: 1403.23,
     gasSpent: "<value>",
   },
-  destinationTransaction: {
-    txHash: "<value>",
-    timestamp: 4770.43,
-    gasSpent: "<value>",
-    rewardRedeemer: "<value>",
-    delivererAddress: "<value>",
-  },
-  status: "delivered",
+  status: "pending",
 };
 ```
 
-### `components.PendingTeleporterMessage`
+### `components.DeliveredTeleporterMessage`
 
 ```typescript
-const value: components.PendingTeleporterMessage = {
+const value: components.DeliveredTeleporterMessage = {
   messageId: "<id>",
   teleporterContractAddress: "<value>",
   sourceBlockchainId: "<id>",
@@ -84,7 +77,14 @@ const value: components.PendingTeleporterMessage = {
     timestamp: 1403.23,
     gasSpent: "<value>",
   },
-  status: "pending",
+  destinationTransaction: {
+    txHash: "<value>",
+    timestamp: 4770.43,
+    gasSpent: "<value>",
+    rewardRedeemer: "<value>",
+    delivererAddress: "<value>",
+  },
+  status: "delivered",
 };
 ```
 

sdk/docs/models/components/validator.md

@@ -31,6 +31,20 @@ const value: components.ActiveValidatorDetails = {
 };
 ```
 
+### `components.PendingValidatorDetails`
+
+```typescript
+const value: components.PendingValidatorDetails = {
+  txHash: "<value>",
+  nodeId: "<id>",
+  subnetId: "<id>",
+  amountStaked: "<value>",
+  startTimestamp: 9843.29,
+  endTimestamp: 5112.58,
+  validationStatus: "pending",
+};
+```
+
 ### `components.CompletedValidatorDetails`
 
 ```typescript
@@ -66,17 +80,3 @@ const value: components.RemovedValidatorDetails = {
 };
 ```
 
-### `components.PendingValidatorDetails`
-
-```typescript
-const value: components.PendingValidatorDetails = {
-  txHash: "<value>",
-  nodeId: "<id>",
-  subnetId: "<id>",
-  amountStaked: "<value>",
-  startTimestamp: 9843.29,
-  endTimestamp: 5112.58,
-  validationStatus: "pending",
-};
-```
-

sdk/docs/models/operations/getcontractmetadataresponse.md

@@ -5,37 +5,37 @@ Successful response
 
 ## Supported Types
 
-### `components.Erc20Contract`
+### `components.Erc721Contract`
 
 ```typescript
-const value: components.Erc20Contract = {
+const value: components.Erc721Contract = {
   name: "Wrapped AVAX",
   address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
-  ercType: "ERC-20",
+  ercType: "ERC-721",
   symbol: "WAVAX",
-  decimals: 18,
 };
 ```
 
-### `components.Erc721Contract`
+### `components.Erc1155Contract`
 
 ```typescript
-const value: components.Erc721Contract = {
+const value: components.Erc1155Contract = {
   name: "Wrapped AVAX",
   address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
-  ercType: "ERC-721",
+  ercType: "ERC-1155",
   symbol: "WAVAX",
 };
 ```
 
-### `components.Erc1155Contract`
+### `components.Erc20Contract`
 
 ```typescript
-const value: components.Erc1155Contract = {
+const value: components.Erc20Contract = {
   name: "Wrapped AVAX",
   address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
-  ercType: "ERC-1155",
+  ercType: "ERC-20",
   symbol: "WAVAX",
+  decimals: 18,
 };
 ```
 

sdk/docs/sdks/addressbalances/README.md

@@ -19,6 +19,7 @@ Balance at a given block can be retrieved with the `blockNumber` parameter.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getNativeBalance" method="get" path="/v1/chains/{chainId}/addresses/{address}/balances:getNative" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -108,6 +109,7 @@ Balance for specific contracts can be retrieved with the `contractAddresses` par
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listErc20Balances" method="get" path="/v1/chains/{chainId}/addresses/{address}/balances:listErc20" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -201,6 +203,7 @@ Balance for a specific contract can be retrieved with the `contractAddress` para
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listErc721Balances" method="get" path="/v1/chains/{chainId}/addresses/{address}/balances:listErc721" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -292,6 +295,7 @@ Balance for a specific contract can be retrieved with the `contractAddress` para
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listErc1155Balances" method="get" path="/v1/chains/{chainId}/addresses/{address}/balances:listErc1155" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -383,6 +387,7 @@ Balance for a specific contract can be retrieved with the `contractAddress` para
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listCollectibleBalances" method="get" path="/v1/chains/{chainId}/addresses/{address}/balances:listCollectibles" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 

sdk/docs/sdks/addresschains/README.md

@@ -13,6 +13,7 @@ Lists the chains where the specified address has  participated in transactions o
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listAddressChains" method="get" path="/v1/address/{address}/chains" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 

sdk/docs/sdks/addresscontracts/README.md

@@ -13,6 +13,7 @@ Lists all contracts deployed by the given address.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listContractDeployments" method="get" path="/v1/chains/{chainId}/contracts/{address}/deployments" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 

sdk/docs/sdks/addresses/README.md

@@ -15,6 +15,7 @@ List adresses by webhook. Only valid for EVM activity webhooks.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getAddressesFromWebhook" method="get" path="/v1/webhooks/{id}/addresses" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -96,6 +97,7 @@ Remove addresses from webhook. Only valid for EVM activity webhooks.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="removeAddressesFromWebhook" method="delete" path="/v1/webhooks/{id}/addresses" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -183,6 +185,7 @@ Add addresses to webhook. Only valid for EVM activity webhooks.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="addAddressesToWebhook" method="patch" path="/v1/webhooks/{id}/addresses" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 

sdk/docs/sdks/addresstransactions/README.md

@@ -20,6 +20,7 @@ Filterable by block ranges.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTransactions" method="get" path="/v1/chains/{chainId}/addresses/{address}/transactions" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -111,6 +112,7 @@ Lists native transactions for an address. Filterable by block range.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listNativeTransactions" method="get" path="/v1/chains/{chainId}/addresses/{address}/transactions:listNative" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -200,6 +202,7 @@ Lists ERC-20 transfers for an address. Filterable by block range.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listErc20Transactions" method="get" path="/v1/chains/{chainId}/addresses/{address}/transactions:listErc20" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -289,6 +292,7 @@ Lists ERC-721 transfers for an address. Filterable by block range.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listErc721Transactions" method="get" path="/v1/chains/{chainId}/addresses/{address}/transactions:listErc721" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -378,6 +382,7 @@ Lists ERC-1155 transfers for an address. Filterable by block range.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listErc1155Transactions" method="get" path="/v1/chains/{chainId}/addresses/{address}/transactions:listErc1155" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -469,6 +474,7 @@ Note that the internal transactions list only contains `CALL` or `CALLCODE` tran
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listInternalTransactions" method="get" path="/v1/chains/{chainId}/addresses/{address}/transactions:listInternals" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 

sdk/docs/sdks/contracts/README.md

@@ -15,6 +15,7 @@ If the address is a smart contract, returns the transaction in which it was depl
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getDeploymentTransaction" method="get" path="/v1/chains/{chainId}/contracts/{address}/transactions:getDeployment" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -98,6 +99,7 @@ Gets metadata about the contract at the given address.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getContractMetadata" method="get" path="/v1/chains/{chainId}/addresses/{address}" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 
@@ -179,6 +181,7 @@ Lists ERC transfers for an ERC-20, ERC-721, or ERC-1155 contract address.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTransfers" method="get" path="/v1/chains/{chainId}/tokens/{address}/transfers" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";
 

sdk/docs/sdks/data/README.md

@@ -13,6 +13,7 @@ Check the health of the service.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="data-health-check" method="get" path="/v1/health-check" -->
 ```typescript
 import { Avalanche } from "@avalanche-sdk/sdk";