@avalabs/glacier-sdk 3.1.0-alpha.25 → 3.1.0-alpha.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -148,6 +148,12 @@ type LogsResponseDTO = {
148
148
  logs: Array<LogsFormat>;
149
149
  };
150
150
 
151
+ declare enum RpcUsageMetricsGroupByEnum {
152
+ RPC_METHOD = "rpcMethod",
153
+ RESPONSE_CODE = "responseCode",
154
+ RL_BYPASS_TOKEN = "rlBypassToken"
155
+ }
156
+
151
157
  type RpcUsageMetricsValueAggregated = {
152
158
  /**
153
159
  * The total number of requests
@@ -173,6 +179,10 @@ type RpcUsageMetricsValueAggregated = {
173
179
  * The number of invalid requests
174
180
  */
175
181
  invalidRequests: number;
182
+ /**
183
+ * The number of API credits wasted on invalid requests
184
+ */
185
+ apiCreditsWasted: number;
176
186
  /**
177
187
  * Column name used for data aggregation
178
188
  */
@@ -220,6 +230,13 @@ type RpcUsageMetricsResponseDTO = {
220
230
  metrics: Array<RpcMetrics>;
221
231
  };
222
232
 
233
+ declare enum SubnetRpcTimeIntervalGranularity {
234
+ HOURLY = "hourly",
235
+ DAILY = "daily",
236
+ WEEKLY = "weekly",
237
+ MONTHLY = "monthly"
238
+ }
239
+
223
240
  declare enum TimeIntervalGranularityExtended {
224
241
  MINUTE = "minute",
225
242
  HOURLY = "hourly",
@@ -323,7 +340,7 @@ declare class DataApiUsageMetricsService {
323
340
  * @returns UsageMetricsResponseDTO Successful response
324
341
  * @throws ApiError
325
342
  */
326
- getApiUsageMetrics({ orgId, startTimestamp, endTimestamp, timeInterval, groupBy, chainId, requestPath, responseCode, requestType, apiKeyId, }: {
343
+ getApiUsageMetrics({ orgId, startTimestamp, endTimestamp, timeInterval, groupBy, chainId, responseCode, requestType, apiKeyId, requestPath, }: {
327
344
  /**
328
345
  * Organization ID to fetch usage metrics for
329
346
  */
@@ -348,10 +365,6 @@ declare class DataApiUsageMetricsService {
348
365
  * Filter data by chain ID.
349
366
  */
350
367
  chainId?: string;
351
- /**
352
- * Filter data by request path.
353
- */
354
- requestPath?: string;
355
368
  /**
356
369
  * Filter data by response status code.
357
370
  */
@@ -364,6 +377,10 @@ declare class DataApiUsageMetricsService {
364
377
  * Filter data by API key ID.
365
378
  */
366
379
  apiKeyId?: string;
380
+ /**
381
+ * Filter data by request path.
382
+ */
383
+ requestPath?: string;
367
384
  }): CancelablePromise<UsageMetricsResponseDTO>;
368
385
  /**
369
386
  * Get logs for requests made by client
@@ -371,7 +388,7 @@ declare class DataApiUsageMetricsService {
371
388
  * @returns LogsResponseDTO Successful response
372
389
  * @throws ApiError
373
390
  */
374
- getApiLogs({ orgId, startTimestamp, endTimestamp, chainId, requestPath, responseCode, requestType, apiKeyId, pageToken, pageSize, }: {
391
+ getApiLogs({ orgId, startTimestamp, endTimestamp, chainId, responseCode, requestType, apiKeyId, requestPath, pageToken, pageSize, }: {
375
392
  /**
376
393
  * Organization ID to fetch usage metrics for
377
394
  */
@@ -388,10 +405,6 @@ declare class DataApiUsageMetricsService {
388
405
  * Filter data by chain ID.
389
406
  */
390
407
  chainId?: string;
391
- /**
392
- * Filter data by request path.
393
- */
394
- requestPath?: string;
395
408
  /**
396
409
  * Filter data by response status code.
397
410
  */
@@ -404,6 +417,10 @@ declare class DataApiUsageMetricsService {
404
417
  * Filter data by API key ID.
405
418
  */
406
419
  apiKeyId?: string;
420
+ /**
421
+ * Filter data by request path.
422
+ */
423
+ requestPath?: string;
407
424
  /**
408
425
  * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
409
426
  */
@@ -415,15 +432,16 @@ declare class DataApiUsageMetricsService {
415
432
  }): CancelablePromise<LogsResponseDTO>;
416
433
  /**
417
434
  * Get usage metrics for the Subnet RPC
418
- * Gets metrics for Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.
435
+ * Gets metrics for public Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.
419
436
  * @returns RpcUsageMetricsResponseDTO Successful response
420
437
  * @throws ApiError
421
438
  */
422
- getRpcUsageMetrics({ timeInterval, startTimestamp, endTimestamp, groupBy, chainId, requestPath, responseCode, rpcMethod, rlBypassApiToken, }: {
439
+ getRpcUsageMetrics({ timeInterval, startTimestamp, endTimestamp, groupBy, chainId, responseCode, rpcMethod, rlBypassApiToken, }: {
423
440
  /**
424
- * Query param for setting time interval of data aggregation.
441
+ * Time interval granularity for data aggregation for subnet
442
+ * rpc metrics
425
443
  */
426
- timeInterval?: string;
444
+ timeInterval?: SubnetRpcTimeIntervalGranularity;
427
445
  /**
428
446
  * 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.
429
447
  */
@@ -435,15 +453,11 @@ declare class DataApiUsageMetricsService {
435
453
  /**
436
454
  * Query param for the criterion used for grouping metrics
437
455
  */
438
- groupBy?: UsageMetricsGroupByEnum;
456
+ groupBy?: RpcUsageMetricsGroupByEnum;
439
457
  /**
440
458
  * Filter data by chain ID.
441
459
  */
442
460
  chainId?: string;
443
- /**
444
- * Filter data by request path.
445
- */
446
- requestPath?: string;
447
461
  /**
448
462
  * Filter data by response status code.
449
463
  */
@@ -3612,7 +3626,7 @@ declare class PrimaryNetworkBlocksService {
3612
3626
  * @returns ListPrimaryNetworkBlocksResponse Successful response
3613
3627
  * @throws ApiError
3614
3628
  */
3615
- listPrimaryNetworkBlocksByNodeId({ blockchainId, network, nodeId, pageToken, pageSize, }: {
3629
+ listPrimaryNetworkBlocksByNodeId({ blockchainId, network, nodeId, startTimestamp, endTimestamp, pageToken, pageSize, }: {
3616
3630
  /**
3617
3631
  * A primary network blockchain id or alias.
3618
3632
  */
@@ -3625,6 +3639,14 @@ declare class PrimaryNetworkBlocksService {
3625
3639
  * A primary network (P or X chain) nodeId.
3626
3640
  */
3627
3641
  nodeId: string;
3642
+ /**
3643
+ * Query param for retrieving items after a specific timestamp.
3644
+ */
3645
+ startTimestamp?: number;
3646
+ /**
3647
+ * Query param for retrieving items before a specific timestamp.
3648
+ */
3649
+ endTimestamp?: number;
3628
3650
  /**
3629
3651
  * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
3630
3652
  */
@@ -3640,7 +3662,7 @@ declare class PrimaryNetworkBlocksService {
3640
3662
  * @returns ListPrimaryNetworkBlocksResponse Successful response
3641
3663
  * @throws ApiError
3642
3664
  */
3643
- listLatestPrimaryNetworkBlocks({ blockchainId, network, pageToken, pageSize, }: {
3665
+ listLatestPrimaryNetworkBlocks({ blockchainId, network, startTimestamp, endTimestamp, pageToken, pageSize, }: {
3644
3666
  /**
3645
3667
  * A primary network blockchain id or alias.
3646
3668
  */
@@ -3649,6 +3671,14 @@ declare class PrimaryNetworkBlocksService {
3649
3671
  * Either mainnet or testnet/fuji.
3650
3672
  */
3651
3673
  network: Network;
3674
+ /**
3675
+ * Query param for retrieving items after a specific timestamp.
3676
+ */
3677
+ startTimestamp?: number;
3678
+ /**
3679
+ * Query param for retrieving items before a specific timestamp.
3680
+ */
3681
+ endTimestamp?: number;
3652
3682
  /**
3653
3683
  * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
3654
3684
  */
@@ -5403,4 +5433,4 @@ type Unauthorized = {
5403
5433
  error: string;
5404
5434
  };
5405
5435
 
5406
- export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, ApiFeature, AssetAmount, AssetWithPriceInfo, BadGateway, BadRequest, BalanceOwner, 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, L1ValidatorDetailsFull, L1ValidatorDetailsTransaction, L1ValidatorManagerDetails, ListAddressChainsResponse, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListInternalTransactionsResponse, ListL1ValidatorsResponse, 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, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RemovedValidatorDetails, RequestType, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcMetrics, 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 };
5436
+ export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, ApiFeature, AssetAmount, AssetWithPriceInfo, BadGateway, BadRequest, BalanceOwner, 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, L1ValidatorDetailsFull, L1ValidatorDetailsTransaction, L1ValidatorManagerDetails, ListAddressChainsResponse, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListInternalTransactionsResponse, ListL1ValidatorsResponse, 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, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RemovedValidatorDetails, RequestType, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcMetrics, RpcUsageMetricsGroupByEnum, RpcUsageMetricsResponseDTO, RpcUsageMetricsValueAggregated, ServiceUnavailable, SharedSecretsResponse, SignatureAggregationResponse, SignatureAggregatorRequest, SignatureAggregatorService, SortByOption, SortOrder, StakingDistribution, Subnet, SubnetOwnershipInfo, SubnetRpcTimeIntervalGranularity, 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 };