@avalabs/glacier-sdk 3.1.0-canary.dbb51d6.0 → 3.1.0-canary.fade9d5.0

package/dist/index.d.ts

@@ -148,6 +148,78 @@ type LogsResponseDTO = {
     logs: Array<LogsFormat>;
 };
 
+type RpcUsageMetricsValueAggregated = {
+    /**
+     * The total number of requests
+     */
+    totalRequests: number;
+    /**
+     * The number of API credits used
+     */
+    apiCreditsUsed: number;
+    /**
+     * The number of requests per second
+     */
+    requestsPerSecond: number;
+    /**
+     * The success rate percentage
+     */
+    successRatePercent: number;
+    /**
+     * The median response time in milliseconds
+     */
+    medianResponseTimeMsecs: number;
+    /**
+     * The number of invalid requests
+     */
+    invalidRequests: number;
+    /**
+     * Column name used for data aggregation
+     */
+    groupedBy: RpcUsageMetricsValueAggregated.groupedBy;
+    /**
+     * The value of the column used for data aggregation
+     */
+    groupValue?: (string | number);
+};
+declare namespace RpcUsageMetricsValueAggregated {
+    /**
+     * Column name used for data aggregation
+     */
+    enum groupedBy {
+        RPC_METHOD = "rpcMethod",
+        RESPONSE_CODE = "responseCode",
+        RL_BYPASS_TOKEN = "rlBypassToken",
+        NONE = "None"
+    }
+}
+
+type RpcMetrics = {
+    /**
+     * The timestamp of the metrics value
+     */
+    timestamp: number;
+    /**
+     * The metrics values for the timestamp
+     */
+    values: Array<RpcUsageMetricsValueAggregated>;
+};
+
+type RpcUsageMetricsResponseDTO = {
+    /**
+     * Duration in which the metrics value is aggregated
+     */
+    aggregateDuration: string;
+    /**
+     * ChainId for which the metrics are aggregated
+     */
+    chainId: string;
+    /**
+     * Metrics values
+     */
+    metrics: Array<RpcMetrics>;
+};
+
 declare enum TimeIntervalGranularityExtended {
     MINUTE = "minute",
     HOURLY = "hourly",
@@ -251,17 +323,17 @@ declare class DataApiUsageMetricsService {
      * @returns UsageMetricsResponseDTO Successful response
      * @throws ApiError
      */
-    getApiUsageMetrics({ orgId, startTimestamp, endTimestamp, timeInterval, groupBy, requestPath, requestType, responseCode, chainId, apiKeyId, }: {
+    getApiUsageMetrics({ orgId, startTimestamp, endTimestamp, timeInterval, groupBy, chainId, requestPath, responseCode, requestType, apiKeyId, }: {
         /**
          * Organization ID to fetch usage metrics for
          */
         orgId?: string;
         /**
-         * Query param for retrieving items after a specific timestamp.
+         * The start time of the range as a UNIX timestamp. The requested start time  will be rounded down to 0:00 UTC of the day.
          */
         startTimestamp?: number;
         /**
-         * Query param for retrieving items before a specific timestamp.
+         * The end time of the range as a UNIX timestamp. The requested end time will be rounded down to 0:00 UTC of the day. `endTimestamp` must be no  earlier than 0:00 UTC of the day after `startTimestamp`.
          */
         endTimestamp?: number;
         /**
@@ -273,21 +345,21 @@ declare class DataApiUsageMetricsService {
          */
         groupBy?: UsageMetricsGroupByEnum;
         /**
-         * Filter data by request path.
+         * Filter data by chain ID.
          */
-        requestPath?: string;
+        chainId?: string;
         /**
-         * Filter data by request type.
+         * Filter data by request path.
          */
-        requestType?: 'data' | 'rpc';
+        requestPath?: string;
         /**
          * Filter data by response status code.
          */
         responseCode?: string;
         /**
-         * Filter data by chain ID.
+         * Filter data by request type.
          */
-        chainId?: string;
+        requestType?: 'data' | 'rpc';
         /**
          * Filter data by API key ID.
          */
@@ -299,35 +371,35 @@ declare class DataApiUsageMetricsService {
      * @returns LogsResponseDTO Successful response
      * @throws ApiError
      */
-    getApiLogs({ orgId, startTimestamp, endTimestamp, requestPath, requestType, responseCode, chainId, apiKeyId, pageToken, pageSize, }: {
+    getApiLogs({ orgId, startTimestamp, endTimestamp, chainId, requestPath, responseCode, requestType, apiKeyId, pageToken, pageSize, }: {
         /**
          * Organization ID to fetch usage metrics for
          */
         orgId?: string;
         /**
-         * Query param for retrieving items after a specific timestamp.
+         * The start time of the range as a UNIX timestamp. The requested start time  will be rounded down to 0:00 UTC of the day.
          */
         startTimestamp?: number;
         /**
-         * Query param for retrieving items before a specific timestamp.
+         * The end time of the range as a UNIX timestamp. The requested end time will be rounded down to 0:00 UTC of the day. `endTimestamp` must be no  earlier than 0:00 UTC of the day after `startTimestamp`.
          */
         endTimestamp?: number;
         /**
-         * Filter data by request path.
+         * Filter data by chain ID.
          */
-        requestPath?: string;
+        chainId?: string;
         /**
-         * Filter data by request type.
+         * Filter data by request path.
          */
-        requestType?: 'data' | 'rpc';
+        requestPath?: string;
         /**
          * Filter data by response status code.
          */
         responseCode?: string;
         /**
-         * Filter data by chain ID.
+         * Filter data by request type.
          */
-        chainId?: string;
+        requestType?: 'data' | 'rpc';
         /**
          * Filter data by API key ID.
          */
@@ -341,6 +413,50 @@ declare class DataApiUsageMetricsService {
          */
         pageSize?: number;
     }): CancelablePromise<LogsResponseDTO>;
+    /**
+     * Get usage metrics for the Subnet RPC
+     * Gets metrics for Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.
+     * @returns RpcUsageMetricsResponseDTO Successful response
+     * @throws ApiError
+     */
+    getRpcUsageMetrics({ timeInterval, startTimestamp, endTimestamp, groupBy, chainId, requestPath, responseCode, rpcMethod, rlBypassApiToken, }: {
+        /**
+         * Query param for setting time interval of data aggregation.
+         */
+        timeInterval?: string;
+        /**
+         * The start time of the range as a UNIX timestamp. The requested start time  will be rounded down to 0:00 UTC of the day.
+         */
+        startTimestamp?: number;
+        /**
+         * The end time of the range as a UNIX timestamp. The requested end time will be rounded down to 0:00 UTC of the day. `endTimestamp` must be no  earlier than 0:00 UTC of the day after `startTimestamp`.
+         */
+        endTimestamp?: number;
+        /**
+         * Query param for the criterion used for grouping metrics
+         */
+        groupBy?: UsageMetricsGroupByEnum;
+        /**
+         * Filter data by chain ID.
+         */
+        chainId?: string;
+        /**
+         * Filter data by request path.
+         */
+        requestPath?: string;
+        /**
+         * Filter data by response status code.
+         */
+        responseCode?: string;
+        /**
+         * Filter data by RPC method.
+         */
+        rpcMethod?: string;
+        /**
+         * Filter data by Rl Bypass API Token.
+         */
+        rlBypassApiToken?: string;
+    }): CancelablePromise<RpcUsageMetricsResponseDTO>;
 }
 
 declare class DefaultService {
@@ -5180,4 +5296,4 @@ type Unauthorized = {
     error: string;
 };
 
-export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, ApiFeature, AssetAmount, AssetWithPriceInfo, BadGateway, BadRequest, BaseHttpRequest, Blockchain, BlockchainId, BlockchainIds, BlockchainInfo, BlsCredentials, CChainAtomicBalances, CChainExportTransaction, CChainImportTransaction, CChainSharedAssetBalance, CancelError, CancelablePromise, ChainAddressChainIdMap, ChainAddressChainIdMapListResponse, ChainInfo, ChainStatus, CompletedDelegatorDetails, CompletedValidatorDetails, ContractDeploymentDetails, ContractSubmissionBody, ContractSubmissionErc1155, ContractSubmissionErc20, ContractSubmissionErc721, ContractSubmissionUnknown, CreateEvmTransactionExportRequest, CreatePrimaryNetworkTransactionExportRequest, CreateWebhookRequest, CurrencyCode, DataApiUsageMetricsService, DataListChainsResponse, DefaultService, DelegationStatusType, DelegatorsDetails, DeliveredSourceNotIndexedTeleporterMessage, DeliveredTeleporterMessage, EVMInput, EVMOperationType, EVMOutput, Erc1155Contract, Erc1155Token, Erc1155TokenBalance, Erc1155TokenMetadata, Erc1155Transfer, Erc1155TransferDetails, Erc20Contract, Erc20Token, Erc20TokenBalance, Erc20Transfer, Erc20TransferDetails, Erc721Contract, Erc721Token, Erc721TokenBalance, Erc721TokenMetadata, Erc721Transfer, Erc721TransferDetails, EventType, EvmBalancesService, EvmBlock, EvmBlocksService, EvmChainsService, EvmContractsService, EvmNetworkOptions, EvmTransactionsService, Forbidden, FullNativeTransactionDetails, GetChainResponse, GetEvmBlockResponse, GetNativeBalanceResponse, GetNetworkDetailsResponse, GetPrimaryNetworkBlockResponse, GetTransactionResponse, Glacier, HealthCheckService, HistoricalReward, ImageAsset, InternalServerError, InternalTransaction, InternalTransactionDetails, InternalTransactionOpCall, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListInternalTransactionsResponse, ListNativeTransactionsResponse, ListNftTokens, ListPChainBalancesResponse, ListPChainTransactionsResponse, ListPChainUtxosResponse, ListPendingRewardsResponse, ListPrimaryNetworkBlocksResponse, ListSubnetsResponse, ListTeleporterMessagesResponse, ListTransactionDetailsResponse, ListTransfersResponse, ListUtxosResponse, ListValidatorDetailsResponse, ListWebhookAddressesResponse, ListWebhooksResponse, ListXChainBalancesResponse, ListXChainTransactionsResponse, ListXChainVerticesResponse, LogsFormat, LogsFormatMetadata, LogsResponseDTO, Method, Metric, Money, NativeTokenBalance, NativeTransaction, Network, NetworkToken, NetworkTokenDetails, NextPageToken, NfTsService, NftTokenMetadataStatus, NotFound, OpenAPI, OpenAPIConfig, OperationStatus, OperationStatusCode, OperationStatusResponse, OperationType, OperationsService, PChainBalance, PChainId, PChainSharedAsset, PChainTransaction, PChainTransactionType, PChainUtxo, PendingDelegatorDetails, PendingReward, PendingTeleporterMessage, PendingValidatorDetails, PricingProviders, PrimaryNetwork, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RemovedValidatorDetails, RequestType, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcErrorDto, RpcErrorResponseDto, RpcRequestBodyDto, RpcService, RpcSuccessResponseDto, ServiceUnavailable, SharedSecretsResponse, SignatureAggregationResponse, SignatureAggregatorRequest, SignatureAggregatorService, SortByOption, SortOrder, StakingDistribution, Subnet, SubnetOwnershipInfo, TeleporterDestinationTransaction, TeleporterMessageInfo, TeleporterReceipt, TeleporterRewardDetails, TeleporterService, TeleporterSourceTransaction, TimeIntervalGranularityExtended, TooManyRequests, TransactionDetails, TransactionDirectionType, TransactionExportMetadata, TransactionMethodType, TransactionStatus, TransactionVertexDetail, Unauthorized, UnknownContract, UpdateContractResponse, UpdateWebhookRequest, UsageMetricsGroupByEnum, UsageMetricsResponseDTO, UsageMetricsValueDTO, UtilityAddresses, Utxo, UtxoCredential, UtxoType, ValidationStatusType, ValidatorHealthDetails, ValidatorsDetails, VmName, WebhookResponse, WebhookStatus, WebhookStatusType, WebhooksService, XChainAssetDetails, XChainBalances, XChainId, XChainLinearTransaction, XChainNonLinearTransaction, XChainSharedAssetBalance, XChainTransactionType, XChainVertex };
+export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, ApiFeature, AssetAmount, AssetWithPriceInfo, BadGateway, BadRequest, BaseHttpRequest, Blockchain, BlockchainId, BlockchainIds, BlockchainInfo, BlsCredentials, CChainAtomicBalances, CChainExportTransaction, CChainImportTransaction, CChainSharedAssetBalance, CancelError, CancelablePromise, ChainAddressChainIdMap, ChainAddressChainIdMapListResponse, ChainInfo, ChainStatus, CompletedDelegatorDetails, CompletedValidatorDetails, ContractDeploymentDetails, ContractSubmissionBody, ContractSubmissionErc1155, ContractSubmissionErc20, ContractSubmissionErc721, ContractSubmissionUnknown, CreateEvmTransactionExportRequest, CreatePrimaryNetworkTransactionExportRequest, CreateWebhookRequest, CurrencyCode, DataApiUsageMetricsService, DataListChainsResponse, DefaultService, DelegationStatusType, DelegatorsDetails, DeliveredSourceNotIndexedTeleporterMessage, DeliveredTeleporterMessage, EVMInput, EVMOperationType, EVMOutput, Erc1155Contract, Erc1155Token, Erc1155TokenBalance, Erc1155TokenMetadata, Erc1155Transfer, Erc1155TransferDetails, Erc20Contract, Erc20Token, Erc20TokenBalance, Erc20Transfer, Erc20TransferDetails, Erc721Contract, Erc721Token, Erc721TokenBalance, Erc721TokenMetadata, Erc721Transfer, Erc721TransferDetails, EventType, EvmBalancesService, EvmBlock, EvmBlocksService, EvmChainsService, EvmContractsService, EvmNetworkOptions, EvmTransactionsService, Forbidden, FullNativeTransactionDetails, GetChainResponse, GetEvmBlockResponse, GetNativeBalanceResponse, GetNetworkDetailsResponse, GetPrimaryNetworkBlockResponse, GetTransactionResponse, Glacier, HealthCheckService, HistoricalReward, ImageAsset, InternalServerError, InternalTransaction, InternalTransactionDetails, InternalTransactionOpCall, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListInternalTransactionsResponse, ListNativeTransactionsResponse, ListNftTokens, ListPChainBalancesResponse, ListPChainTransactionsResponse, ListPChainUtxosResponse, ListPendingRewardsResponse, ListPrimaryNetworkBlocksResponse, ListSubnetsResponse, ListTeleporterMessagesResponse, ListTransactionDetailsResponse, ListTransfersResponse, ListUtxosResponse, ListValidatorDetailsResponse, ListWebhookAddressesResponse, ListWebhooksResponse, ListXChainBalancesResponse, ListXChainTransactionsResponse, ListXChainVerticesResponse, LogsFormat, LogsFormatMetadata, LogsResponseDTO, Method, Metric, Money, NativeTokenBalance, NativeTransaction, Network, NetworkToken, NetworkTokenDetails, NextPageToken, NfTsService, NftTokenMetadataStatus, NotFound, OpenAPI, OpenAPIConfig, OperationStatus, OperationStatusCode, OperationStatusResponse, OperationType, OperationsService, PChainBalance, PChainId, PChainSharedAsset, PChainTransaction, PChainTransactionType, PChainUtxo, PendingDelegatorDetails, PendingReward, PendingTeleporterMessage, PendingValidatorDetails, PricingProviders, PrimaryNetwork, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RemovedValidatorDetails, RequestType, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcErrorDto, RpcErrorResponseDto, RpcMetrics, RpcRequestBodyDto, RpcService, RpcSuccessResponseDto, RpcUsageMetricsResponseDTO, RpcUsageMetricsValueAggregated, ServiceUnavailable, SharedSecretsResponse, SignatureAggregationResponse, SignatureAggregatorRequest, SignatureAggregatorService, SortByOption, SortOrder, StakingDistribution, Subnet, SubnetOwnershipInfo, TeleporterDestinationTransaction, TeleporterMessageInfo, TeleporterReceipt, TeleporterRewardDetails, TeleporterService, TeleporterSourceTransaction, TimeIntervalGranularityExtended, TooManyRequests, TransactionDetails, TransactionDirectionType, TransactionExportMetadata, TransactionMethodType, TransactionStatus, TransactionVertexDetail, Unauthorized, UnknownContract, UpdateContractResponse, UpdateWebhookRequest, UsageMetricsGroupByEnum, UsageMetricsResponseDTO, UsageMetricsValueDTO, UtilityAddresses, Utxo, UtxoCredential, UtxoType, ValidationStatusType, ValidatorHealthDetails, ValidatorsDetails, VmName, WebhookResponse, WebhookStatus, WebhookStatusType, WebhooksService, XChainAssetDetails, XChainBalances, XChainId, XChainLinearTransaction, XChainNonLinearTransaction, XChainSharedAssetBalance, XChainTransactionType, XChainVertex };