@avalabs/glacier-sdk 3.1.0-alpha.40 → 3.1.0-alpha.42

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.
Files changed (35) hide show
  1. package/dist/index.d.ts +240 -28
  2. package/dist/index.js +1 -1
  3. package/esm/generated/Glacier.d.ts +2 -0
  4. package/esm/generated/Glacier.js +1 -1
  5. package/esm/generated/models/AccessRequest.d.ts +12 -0
  6. package/esm/generated/models/Erc20TokenBalance.d.ts +3 -3
  7. package/esm/generated/models/HealthCheckResultDto.d.ts +17 -0
  8. package/esm/generated/models/HealthCheckResultDto.js +1 -0
  9. package/esm/generated/models/HealthIndicatorResultDto.d.ts +17 -0
  10. package/esm/generated/models/HealthIndicatorResultDto.js +1 -0
  11. package/esm/generated/models/NotificationsResponse.d.ts +5 -0
  12. package/esm/generated/models/OperationStatusResponse.d.ts +1 -1
  13. package/esm/generated/models/PrimaryNetworkRpcMetricsGroupByEnum.d.ts +1 -0
  14. package/esm/generated/models/PrimaryNetworkRpcMetricsGroupByEnum.js +1 -1
  15. package/esm/generated/models/PrimaryNetworkRpcTimeIntervalGranularity.d.ts +8 -0
  16. package/esm/generated/models/PrimaryNetworkRpcTimeIntervalGranularity.js +1 -0
  17. package/esm/generated/models/PrimaryNetworkRpcUsageMetricsResponseDTO.d.ts +27 -0
  18. package/esm/generated/models/PrimaryNetworkRpcUsageMetricsResponseDTO.js +1 -0
  19. package/esm/generated/models/RpcUsageMetricsValueAggregated.d.ts +4 -0
  20. package/esm/generated/models/RpcUsageMetricsValueAggregated.js +1 -1
  21. package/esm/generated/models/SubscribeRequest.d.ts +16 -0
  22. package/esm/generated/models/SubscriptionsRequest.d.ts +8 -0
  23. package/esm/generated/models/SubscriptionsResponse.d.ts +14 -0
  24. package/esm/generated/models/UnsubscribeRequest.d.ts +12 -0
  25. package/esm/generated/services/DataApiUsageMetricsService.d.ts +55 -6
  26. package/esm/generated/services/DataApiUsageMetricsService.js +1 -1
  27. package/esm/generated/services/HealthCheckService.d.ts +4 -7
  28. package/esm/generated/services/HealthCheckService.js +1 -1
  29. package/esm/generated/services/NotificationsService.d.ts +51 -0
  30. package/esm/generated/services/NotificationsService.js +1 -0
  31. package/esm/generated/services/WebhooksService.d.ts +3 -3
  32. package/esm/generated/services/WebhooksService.js +1 -1
  33. package/esm/index.d.ts +11 -0
  34. package/esm/index.js +1 -1
  35. package/package.json +2 -2
@@ -10,6 +10,7 @@ import { EvmTransactionsService } from './services/EvmTransactionsService.js';
10
10
  import { HealthCheckService } from './services/HealthCheckService.js';
11
11
  import { InterchainMessagingService } from './services/InterchainMessagingService.js';
12
12
  import { NfTsService } from './services/NfTsService.js';
13
+ import { NotificationsService } from './services/NotificationsService.js';
13
14
  import { OperationsService } from './services/OperationsService.js';
14
15
  import { PrimaryNetworkService } from './services/PrimaryNetworkService.js';
15
16
  import { PrimaryNetworkBalancesService } from './services/PrimaryNetworkBalancesService.js';
@@ -34,6 +35,7 @@ declare class Glacier {
34
35
  readonly healthCheck: HealthCheckService;
35
36
  readonly interchainMessaging: InterchainMessagingService;
36
37
  readonly nfTs: NfTsService;
38
+ readonly notifications: NotificationsService;
37
39
  readonly operations: OperationsService;
38
40
  readonly primaryNetwork: PrimaryNetworkService;
39
41
  readonly primaryNetworkBalances: PrimaryNetworkBalancesService;
@@ -1 +1 @@
1
- import{FetchHttpRequest as e}from"./core/FetchHttpRequest.js";import{DataApiUsageMetricsService as r}from"./services/DataApiUsageMetricsService.js";import{DefaultService as s}from"./services/DefaultService.js";import{EvmBalancesService as t}from"./services/EvmBalancesService.js";import{EvmBlocksService as i}from"./services/EvmBlocksService.js";import{EvmChainsService as o}from"./services/EvmChainsService.js";import{EvmContractsService as a}from"./services/EvmContractsService.js";import{EvmTransactionsService as c}from"./services/EvmTransactionsService.js";import{HealthCheckService as m}from"./services/HealthCheckService.js";import{InterchainMessagingService as n}from"./services/InterchainMessagingService.js";import{NfTsService as h}from"./services/NfTsService.js";import{OperationsService as v}from"./services/OperationsService.js";import{PrimaryNetworkService as p}from"./services/PrimaryNetworkService.js";import{PrimaryNetworkBalancesService as w}from"./services/PrimaryNetworkBalancesService.js";import{PrimaryNetworkBlocksService as S}from"./services/PrimaryNetworkBlocksService.js";import{PrimaryNetworkRewardsService as k}from"./services/PrimaryNetworkRewardsService.js";import{PrimaryNetworkTransactionsService as N}from"./services/PrimaryNetworkTransactionsService.js";import{PrimaryNetworkUtxOsService as u}from"./services/PrimaryNetworkUtxOsService.js";import{PrimaryNetworkVerticesService as E}from"./services/PrimaryNetworkVerticesService.js";import{SignatureAggregatorService as f}from"./services/SignatureAggregatorService.js";import{TeleporterService as l}from"./services/TeleporterService.js";import{WebhooksService as q}from"./services/WebhooksService.js";class g{dataApiUsageMetrics;default;evmBalances;evmBlocks;evmChains;evmContracts;evmTransactions;healthCheck;interchainMessaging;nfTs;operations;primaryNetwork;primaryNetworkBalances;primaryNetworkBlocks;primaryNetworkRewards;primaryNetworkTransactions;primaryNetworkUtxOs;primaryNetworkVertices;signatureAggregator;teleporter;webhooks;request;constructor(g,j=e){this.request=new j({BASE:g?.BASE??"https://glacier-api-dev.avax.network",VERSION:g?.VERSION??"Beta",WITH_CREDENTIALS:g?.WITH_CREDENTIALS??!1,CREDENTIALS:g?.CREDENTIALS??"include",TOKEN:g?.TOKEN,USERNAME:g?.USERNAME,PASSWORD:g?.PASSWORD,HEADERS:g?.HEADERS,ENCODE_PATH:g?.ENCODE_PATH}),this.dataApiUsageMetrics=new r(this.request),this.default=new s(this.request),this.evmBalances=new t(this.request),this.evmBlocks=new i(this.request),this.evmChains=new o(this.request),this.evmContracts=new a(this.request),this.evmTransactions=new c(this.request),this.healthCheck=new m(this.request),this.interchainMessaging=new n(this.request),this.nfTs=new h(this.request),this.operations=new v(this.request),this.primaryNetwork=new p(this.request),this.primaryNetworkBalances=new w(this.request),this.primaryNetworkBlocks=new S(this.request),this.primaryNetworkRewards=new k(this.request),this.primaryNetworkTransactions=new N(this.request),this.primaryNetworkUtxOs=new u(this.request),this.primaryNetworkVertices=new E(this.request),this.signatureAggregator=new f(this.request),this.teleporter=new l(this.request),this.webhooks=new q(this.request)}}export{g as Glacier};
1
+ import{FetchHttpRequest as e}from"./core/FetchHttpRequest.js";import{DataApiUsageMetricsService as r}from"./services/DataApiUsageMetricsService.js";import{DefaultService as s}from"./services/DefaultService.js";import{EvmBalancesService as i}from"./services/EvmBalancesService.js";import{EvmBlocksService as t}from"./services/EvmBlocksService.js";import{EvmChainsService as o}from"./services/EvmChainsService.js";import{EvmContractsService as a}from"./services/EvmContractsService.js";import{EvmTransactionsService as c}from"./services/EvmTransactionsService.js";import{HealthCheckService as m}from"./services/HealthCheckService.js";import{InterchainMessagingService as n}from"./services/InterchainMessagingService.js";import{NfTsService as h}from"./services/NfTsService.js";import{NotificationsService as v}from"./services/NotificationsService.js";import{OperationsService as p}from"./services/OperationsService.js";import{PrimaryNetworkService as w}from"./services/PrimaryNetworkService.js";import{PrimaryNetworkBalancesService as S}from"./services/PrimaryNetworkBalancesService.js";import{PrimaryNetworkBlocksService as N}from"./services/PrimaryNetworkBlocksService.js";import{PrimaryNetworkRewardsService as k}from"./services/PrimaryNetworkRewardsService.js";import{PrimaryNetworkTransactionsService as u}from"./services/PrimaryNetworkTransactionsService.js";import{PrimaryNetworkUtxOsService as f}from"./services/PrimaryNetworkUtxOsService.js";import{PrimaryNetworkVerticesService as E}from"./services/PrimaryNetworkVerticesService.js";import{SignatureAggregatorService as q}from"./services/SignatureAggregatorService.js";import{TeleporterService as l}from"./services/TeleporterService.js";import{WebhooksService as j}from"./services/WebhooksService.js";class g{dataApiUsageMetrics;default;evmBalances;evmBlocks;evmChains;evmContracts;evmTransactions;healthCheck;interchainMessaging;nfTs;notifications;operations;primaryNetwork;primaryNetworkBalances;primaryNetworkBlocks;primaryNetworkRewards;primaryNetworkTransactions;primaryNetworkUtxOs;primaryNetworkVertices;signatureAggregator;teleporter;webhooks;request;constructor(g,y=e){this.request=new y({BASE:g?.BASE??"https://glacier-api-dev.avax.network",VERSION:g?.VERSION??"Beta",WITH_CREDENTIALS:g?.WITH_CREDENTIALS??!1,CREDENTIALS:g?.CREDENTIALS??"include",TOKEN:g?.TOKEN,USERNAME:g?.USERNAME,PASSWORD:g?.PASSWORD,HEADERS:g?.HEADERS,ENCODE_PATH:g?.ENCODE_PATH}),this.dataApiUsageMetrics=new r(this.request),this.default=new s(this.request),this.evmBalances=new i(this.request),this.evmBlocks=new t(this.request),this.evmChains=new o(this.request),this.evmContracts=new a(this.request),this.evmTransactions=new c(this.request),this.healthCheck=new m(this.request),this.interchainMessaging=new n(this.request),this.nfTs=new h(this.request),this.notifications=new v(this.request),this.operations=new p(this.request),this.primaryNetwork=new w(this.request),this.primaryNetworkBalances=new S(this.request),this.primaryNetworkBlocks=new N(this.request),this.primaryNetworkRewards=new k(this.request),this.primaryNetworkTransactions=new u(this.request),this.primaryNetworkUtxOs=new f(this.request),this.primaryNetworkVertices=new E(this.request),this.signatureAggregator=new q(this.request),this.teleporter=new l(this.request),this.webhooks=new j(this.request)}}export{g as Glacier};
@@ -0,0 +1,12 @@
1
+ type AccessRequest = {
2
+ /**
3
+ * The email address to send the access token to
4
+ */
5
+ email: string;
6
+ /**
7
+ * The captcha to verify the user
8
+ */
9
+ captcha: string;
10
+ };
11
+
12
+ export { AccessRequest };
@@ -39,16 +39,16 @@ type Erc20TokenBalance = {
39
39
  */
40
40
  balanceValue?: Money;
41
41
  /**
42
- * Indicates the reputation of the token based on a security analysis. 'Benign' suggests the token is likely safe, while 'Malicious' indicates potential security risks. This field is nullable and is only populated for tokens on the C-Chain. Possible values are 'Benign', 'Malicious', or null if the reputation is unknown.
42
+ * Indicates the reputation of the token based on a security analysis. 'Benign' suggests the token is likely safe, while 'Malicious' indicates potential security risks. This field is nullable and is only populated for tokens on the C-Chain. Possible values are 'Benign', 'Malicious', or null if the reputation is unknown.
43
43
  */
44
- tokenReputation: Erc20TokenBalance.tokenReputation | null;
44
+ tokenReputation: Erc20TokenBalance.tokenReputation;
45
45
  };
46
46
  declare namespace Erc20TokenBalance {
47
47
  enum ercType {
48
48
  ERC_20 = "ERC-20"
49
49
  }
50
50
  /**
51
- * Indicates the reputation of the token based on a security analysis. 'Benign' suggests the token is likely safe, while 'Malicious' indicates potential security risks. This field is nullable and is only populated for tokens on the C-Chain. Possible values are 'Benign', 'Malicious', or null if the reputation is unknown.
51
+ * Indicates the reputation of the token based on a security analysis. 'Benign' suggests the token is likely safe, while 'Malicious' indicates potential security risks. This field is nullable and is only populated for tokens on the C-Chain. Possible values are 'Benign', 'Malicious', or null if the reputation is unknown.
52
52
  */
53
53
  enum tokenReputation {
54
54
  MALICIOUS = "Malicious",
@@ -0,0 +1,17 @@
1
+ import { HealthIndicatorResultDto } from './HealthIndicatorResultDto.js';
2
+
3
+ type HealthCheckResultDto = {
4
+ status?: HealthCheckResultDto.status;
5
+ info?: any | null;
6
+ error?: any | null;
7
+ details?: Record<string, HealthIndicatorResultDto>;
8
+ };
9
+ declare namespace HealthCheckResultDto {
10
+ enum status {
11
+ ERROR = "error",
12
+ OK = "ok",
13
+ SHUTTING_DOWN = "shutting_down"
14
+ }
15
+ }
16
+
17
+ export { HealthCheckResultDto };
@@ -0,0 +1 @@
1
+ var t,r,s;r=t||(t={}),(s=r.status||(r.status={})).ERROR="error",s.OK="ok",s.SHUTTING_DOWN="shutting_down";export{t as HealthCheckResultDto};
@@ -0,0 +1,17 @@
1
+ type HealthIndicatorResultDto = {
2
+ /**
3
+ * Status of the health indicator.
4
+ */
5
+ status?: HealthIndicatorResultDto.status;
6
+ };
7
+ declare namespace HealthIndicatorResultDto {
8
+ /**
9
+ * Status of the health indicator.
10
+ */
11
+ enum status {
12
+ UP = "up",
13
+ DOWN = "down"
14
+ }
15
+ }
16
+
17
+ export { HealthIndicatorResultDto };
@@ -0,0 +1 @@
1
+ var t,s,a;s=t||(t={}),(a=s.status||(s.status={})).UP="up",a.DOWN="down";export{t as HealthIndicatorResultDto};
@@ -0,0 +1,5 @@
1
+ type NotificationsResponse = {
2
+ message: string;
3
+ };
4
+
5
+ export { NotificationsResponse };
@@ -7,7 +7,7 @@ type OperationStatusResponse = {
7
7
  operationType: OperationType;
8
8
  operationStatus: OperationStatus;
9
9
  message?: string;
10
- metadata: TransactionExportMetadata;
10
+ metadata?: TransactionExportMetadata;
11
11
  createdAtTimestamp: number;
12
12
  updatedAtTimestamp: number;
13
13
  };
@@ -1,4 +1,5 @@
1
1
  declare enum PrimaryNetworkRpcMetricsGroupByEnum {
2
+ RPC_METHOD = "rpcMethod",
2
3
  REQUEST_PATH = "requestPath",
3
4
  RESPONSE_CODE = "responseCode",
4
5
  COUNTRY = "country",
@@ -1 +1 @@
1
- var e=(e=>(e.REQUEST_PATH="requestPath",e.RESPONSE_CODE="responseCode",e.COUNTRY="country",e.CONTINENT="continent",e.USER_AGENT="userAgent",e))(e||{});export{e as PrimaryNetworkRpcMetricsGroupByEnum};
1
+ var e=(e=>(e.RPC_METHOD="rpcMethod",e.REQUEST_PATH="requestPath",e.RESPONSE_CODE="responseCode",e.COUNTRY="country",e.CONTINENT="continent",e.USER_AGENT="userAgent",e))(e||{});export{e as PrimaryNetworkRpcMetricsGroupByEnum};
@@ -0,0 +1,8 @@
1
+ declare enum PrimaryNetworkRpcTimeIntervalGranularity {
2
+ HOURLY = "hourly",
3
+ DAILY = "daily",
4
+ WEEKLY = "weekly",
5
+ MONTHLY = "monthly"
6
+ }
7
+
8
+ export { PrimaryNetworkRpcTimeIntervalGranularity };
@@ -0,0 +1 @@
1
+ var l=(l=>(l.HOURLY="hourly",l.DAILY="daily",l.WEEKLY="weekly",l.MONTHLY="monthly",l))(l||{});export{l as PrimaryNetworkRpcTimeIntervalGranularity};
@@ -0,0 +1,27 @@
1
+ import { RpcMetrics } from './RpcMetrics.js';
2
+
3
+ type PrimaryNetworkRpcUsageMetricsResponseDTO = {
4
+ /**
5
+ * Duration in which the metrics value is aggregated
6
+ */
7
+ aggregateDuration: string;
8
+ /**
9
+ * Metrics values
10
+ */
11
+ metrics: Array<RpcMetrics>;
12
+ /**
13
+ * Network type for which the metrics are aggregated
14
+ */
15
+ network: PrimaryNetworkRpcUsageMetricsResponseDTO.network;
16
+ };
17
+ declare namespace PrimaryNetworkRpcUsageMetricsResponseDTO {
18
+ /**
19
+ * Network type for which the metrics are aggregated
20
+ */
21
+ enum network {
22
+ MAINNET = "mainnet",
23
+ TESTNET = "testnet"
24
+ }
25
+ }
26
+
27
+ export { PrimaryNetworkRpcUsageMetricsResponseDTO };
@@ -0,0 +1 @@
1
+ var t,e,n;e=t||(t={}),(n=e.network||(e.network={})).MAINNET="mainnet",n.TESTNET="testnet";export{t as PrimaryNetworkRpcUsageMetricsResponseDTO};
@@ -44,6 +44,10 @@ declare namespace RpcUsageMetricsValueAggregated {
44
44
  RPC_METHOD = "rpcMethod",
45
45
  RESPONSE_CODE = "responseCode",
46
46
  RL_BYPASS_TOKEN = "rlBypassToken",
47
+ REQUEST_PATH = "requestPath",
48
+ COUNTRY = "country",
49
+ CONTINENT = "continent",
50
+ USER_AGENT = "userAgent",
47
51
  NONE = "None"
48
52
  }
49
53
  }
@@ -1 +1 @@
1
- var e,o,r;o=e||(e={}),(r=o.groupedBy||(o.groupedBy={})).RPC_METHOD="rpcMethod",r.RESPONSE_CODE="responseCode",r.RL_BYPASS_TOKEN="rlBypassToken",r.NONE="None";export{e as RpcUsageMetricsValueAggregated};
1
+ var e,E,o;E=e||(e={}),(o=E.groupedBy||(E.groupedBy={})).RPC_METHOD="rpcMethod",o.RESPONSE_CODE="responseCode",o.RL_BYPASS_TOKEN="rlBypassToken",o.REQUEST_PATH="requestPath",o.COUNTRY="country",o.CONTINENT="continent",o.USER_AGENT="userAgent",o.NONE="None";export{e as RpcUsageMetricsValueAggregated};
@@ -0,0 +1,16 @@
1
+ type SubscribeRequest = {
2
+ /**
3
+ * The access token to use for authentication
4
+ */
5
+ accessToken: string;
6
+ /**
7
+ * The node ID to subscribe to
8
+ */
9
+ nodeId: string;
10
+ /**
11
+ * The notification types to subscribe to. If not provided, all notification types will be subscribed to
12
+ */
13
+ notifications?: Array<'connectivity' | 'ports' | 'version'>;
14
+ };
15
+
16
+ export { SubscribeRequest };
@@ -0,0 +1,8 @@
1
+ type SubscriptionsRequest = {
2
+ /**
3
+ * The access token to use for authentication
4
+ */
5
+ accessToken: string;
6
+ };
7
+
8
+ export { SubscriptionsRequest };
@@ -0,0 +1,14 @@
1
+ type SubscriptionsResponse = {
2
+ /**
3
+ * The email address of the user
4
+ */
5
+ email: string;
6
+ /**
7
+ * The subscriptions of the user
8
+ */
9
+ subscriptions: Record<string, {
10
+ notifications?: Array<'connectivity' | 'ports' | 'version'>;
11
+ }>;
12
+ };
13
+
14
+ export { SubscriptionsResponse };
@@ -0,0 +1,12 @@
1
+ type UnsubscribeRequest = {
2
+ /**
3
+ * The access token to use for authentication
4
+ */
5
+ accessToken: string;
6
+ /**
7
+ * The node ID to subscribe to
8
+ */
9
+ nodeId: string;
10
+ };
11
+
12
+ export { UnsubscribeRequest };
@@ -1,6 +1,8 @@
1
1
  import { LogsResponseDTO } from '../models/LogsResponseDTO.js';
2
2
  import { Network } from '../models/Network.js';
3
3
  import { PrimaryNetworkRpcMetricsGroupByEnum } from '../models/PrimaryNetworkRpcMetricsGroupByEnum.js';
4
+ import { PrimaryNetworkRpcTimeIntervalGranularity } from '../models/PrimaryNetworkRpcTimeIntervalGranularity.js';
5
+ import { PrimaryNetworkRpcUsageMetricsResponseDTO } from '../models/PrimaryNetworkRpcUsageMetricsResponseDTO.js';
4
6
  import { RpcUsageMetricsGroupByEnum } from '../models/RpcUsageMetricsGroupByEnum.js';
5
7
  import { SubnetRpcTimeIntervalGranularity } from '../models/SubnetRpcTimeIntervalGranularity.js';
6
8
  import { SubnetRpcUsageMetricsResponseDTO } from '../models/SubnetRpcUsageMetricsResponseDTO.js';
@@ -115,6 +117,49 @@ declare class DataApiUsageMetricsService {
115
117
  * @returns SubnetRpcUsageMetricsResponseDTO Successful response
116
118
  * @throws ApiError
117
119
  */
120
+ getSubnetRpcUsageMetrics({ timeInterval, startTimestamp, endTimestamp, groupBy, chainId, responseCode, rpcMethod, rlBypassApiToken, }: {
121
+ /**
122
+ * Time interval granularity for data aggregation for subnet
123
+ * rpc metrics
124
+ */
125
+ timeInterval?: SubnetRpcTimeIntervalGranularity;
126
+ /**
127
+ * 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.
128
+ */
129
+ startTimestamp?: number;
130
+ /**
131
+ * 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.
132
+ */
133
+ endTimestamp?: number;
134
+ /**
135
+ * Query param for the criterion used for grouping metrics
136
+ */
137
+ groupBy?: RpcUsageMetricsGroupByEnum;
138
+ /**
139
+ * Filter data by chain ID.
140
+ */
141
+ chainId?: string;
142
+ /**
143
+ * Filter data by response status code.
144
+ */
145
+ responseCode?: string;
146
+ /**
147
+ * Filter data by RPC method.
148
+ */
149
+ rpcMethod?: string;
150
+ /**
151
+ * Filter data by Rl Bypass API Token.
152
+ */
153
+ rlBypassApiToken?: string;
154
+ }): CancelablePromise<SubnetRpcUsageMetricsResponseDTO>;
155
+ /**
156
+ * @deprecated
157
+ * **[Deprecated]** Gets metrics for public Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.
158
+ *
159
+ * ⚠️ **This operation will be removed in a future release. Please use /v1/subnetRpcUsageMetrics endpoint instead**.
160
+ * @returns SubnetRpcUsageMetricsResponseDTO Successful response
161
+ * @throws ApiError
162
+ */
118
163
  getRpcUsageMetrics({ timeInterval, startTimestamp, endTimestamp, groupBy, chainId, responseCode, rpcMethod, rlBypassApiToken, }: {
119
164
  /**
120
165
  * Time interval granularity for data aggregation for subnet
@@ -153,10 +198,10 @@ declare class DataApiUsageMetricsService {
153
198
  /**
154
199
  * Get usage metrics for the Primary Network RPC
155
200
  * Gets metrics for public Primary Network RPC usage over a specified time interval aggregated at the specified time-duration granularity.
156
- * @returns SubnetRpcUsageMetricsResponseDTO Successful response
201
+ * @returns PrimaryNetworkRpcUsageMetricsResponseDTO Successful response
157
202
  * @throws ApiError
158
203
  */
159
- getPrimaryNetworkRpcUsageMetrics({ network, timeInterval, startTimestamp, endTimestamp, groupBy, responseCode, requestPath, country, continent, userAgent, }: {
204
+ getPrimaryNetworkRpcUsageMetrics({ network, timeInterval, startTimestamp, endTimestamp, groupBy, responseCode, requestPath, country, continent, userAgent, rpcMethod, }: {
160
205
  /**
161
206
  * Either mainnet or testnet/fuji.
162
207
  */
@@ -165,7 +210,7 @@ declare class DataApiUsageMetricsService {
165
210
  * Time interval granularity for data aggregation for subnet
166
211
  * rpc metrics
167
212
  */
168
- timeInterval?: SubnetRpcTimeIntervalGranularity;
213
+ timeInterval?: PrimaryNetworkRpcTimeIntervalGranularity;
169
214
  /**
170
215
  * 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.
171
216
  */
@@ -187,18 +232,22 @@ declare class DataApiUsageMetricsService {
187
232
  */
188
233
  requestPath?: string;
189
234
  /**
190
- * Filter data by Country.
235
+ * Filter data by Country. Input must be a valid ISO 3166-1 alpha-2 country code. "XX" - Represents clients without country code data. "T1" - Represents clients using the Tor network.
191
236
  */
192
237
  country?: string;
193
238
  /**
194
- * Filter data by Continent.
239
+ * Filter data by Continent. Input must be a valid ISO 3166-1 alpha-2 continent code.
195
240
  */
196
241
  continent?: string;
197
242
  /**
198
243
  * Filter data by User Agent.
199
244
  */
200
245
  userAgent?: string;
201
- }): CancelablePromise<SubnetRpcUsageMetricsResponseDTO>;
246
+ /**
247
+ * Filter data by RPC method.
248
+ */
249
+ rpcMethod?: string;
250
+ }): CancelablePromise<PrimaryNetworkRpcUsageMetricsResponseDTO>;
202
251
  }
203
252
 
204
253
  export { DataApiUsageMetricsService };
@@ -1 +1 @@
1
- class e{constructor(e){this.httpRequest=e}getApiUsageMetrics({orgId:e,startTimestamp:r,endTimestamp:t,timeInterval:s,groupBy:n,chainId:a,responseCode:i,requestType:o,apiKeyId:h,requestPath:d}){return this.httpRequest.request({method:"GET",url:"/v1/apiUsageMetrics",query:{orgId:e,startTimestamp:r,endTimestamp:t,timeInterval:s,groupBy:n,chainId:a,responseCode:i,requestType:o,apiKeyId:h,requestPath:d},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getApiLogs({orgId:e,startTimestamp:r,endTimestamp:t,chainId:s,responseCode:n,requestType:a,apiKeyId:i,requestPath:o,pageToken:h,pageSize:d=10}){return this.httpRequest.request({method:"GET",url:"/v1/apiLogs",query:{orgId:e,startTimestamp:r,endTimestamp:t,chainId:s,responseCode:n,requestType:a,apiKeyId:i,requestPath:o,pageToken:h,pageSize:d},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getRpcUsageMetrics({timeInterval:e,startTimestamp:r,endTimestamp:t,groupBy:s,chainId:n,responseCode:a,rpcMethod:i,rlBypassApiToken:o}){return this.httpRequest.request({method:"GET",url:"/v1/rpcUsageMetrics",query:{timeInterval:e,startTimestamp:r,endTimestamp:t,groupBy:s,chainId:n,responseCode:a,rpcMethod:i,rlBypassApiToken:o},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getPrimaryNetworkRpcUsageMetrics({network:e,timeInterval:r,startTimestamp:t,endTimestamp:s,groupBy:n,responseCode:a,requestPath:i,country:o,continent:h,userAgent:d}){return this.httpRequest.request({method:"GET",url:"/v1/primaryNetworkRpcUsageMetrics",query:{timeInterval:r,startTimestamp:t,endTimestamp:s,groupBy:n,responseCode:a,requestPath:i,country:o,continent:h,userAgent:d,network:e},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}}export{e as DataApiUsageMetricsService};
1
+ class e{constructor(e){this.httpRequest=e}getApiUsageMetrics({orgId:e,startTimestamp:r,endTimestamp:t,timeInterval:s,groupBy:n,chainId:a,responseCode:i,requestType:o,apiKeyId:h,requestPath:d}){return this.httpRequest.request({method:"GET",url:"/v1/apiUsageMetrics",query:{orgId:e,startTimestamp:r,endTimestamp:t,timeInterval:s,groupBy:n,chainId:a,responseCode:i,requestType:o,apiKeyId:h,requestPath:d},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getApiLogs({orgId:e,startTimestamp:r,endTimestamp:t,chainId:s,responseCode:n,requestType:a,apiKeyId:i,requestPath:o,pageToken:h,pageSize:d=10}){return this.httpRequest.request({method:"GET",url:"/v1/apiLogs",query:{orgId:e,startTimestamp:r,endTimestamp:t,chainId:s,responseCode:n,requestType:a,apiKeyId:i,requestPath:o,pageToken:h,pageSize:d},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getSubnetRpcUsageMetrics({timeInterval:e,startTimestamp:r,endTimestamp:t,groupBy:s,chainId:n,responseCode:a,rpcMethod:i,rlBypassApiToken:o}){return this.httpRequest.request({method:"GET",url:"/v1/subnetRpcUsageMetrics",query:{timeInterval:e,startTimestamp:r,endTimestamp:t,groupBy:s,chainId:n,responseCode:a,rpcMethod:i,rlBypassApiToken:o},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getRpcUsageMetrics({timeInterval:e,startTimestamp:r,endTimestamp:t,groupBy:s,chainId:n,responseCode:a,rpcMethod:i,rlBypassApiToken:o}){return this.httpRequest.request({method:"GET",url:"/v1/rpcUsageMetrics",query:{timeInterval:e,startTimestamp:r,endTimestamp:t,groupBy:s,chainId:n,responseCode:a,rpcMethod:i,rlBypassApiToken:o},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getPrimaryNetworkRpcUsageMetrics({network:e,timeInterval:r,startTimestamp:t,endTimestamp:s,groupBy:n,responseCode:a,requestPath:i,country:o,continent:h,userAgent:d,rpcMethod:u}){return this.httpRequest.request({method:"GET",url:"/v1/primaryNetworkRpcUsageMetrics",query:{timeInterval:r,startTimestamp:t,endTimestamp:s,groupBy:n,responseCode:a,requestPath:i,country:o,continent:h,userAgent:d,rpcMethod:u,network:e},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}}export{e as DataApiUsageMetricsService};
@@ -1,3 +1,4 @@
1
+ import { HealthCheckResultDto } from '../models/HealthCheckResultDto.js';
1
2
  import { CancelablePromise } from '../core/CancelablePromise.js';
2
3
  import { BaseHttpRequest } from '../core/BaseHttpRequest.js';
3
4
 
@@ -6,15 +7,11 @@ declare class HealthCheckService {
6
7
  constructor(httpRequest: BaseHttpRequest);
7
8
  /**
8
9
  * Get the health of the service
9
- * @returns any The Health Check is successful
10
+ * Check the health of the service.
11
+ * @returns HealthCheckResultDto The health of the service
10
12
  * @throws ApiError
11
13
  */
12
- dataHealthCheck(): CancelablePromise<{
13
- status?: string;
14
- info?: Record<string, Record<string, string>> | null;
15
- error?: Record<string, Record<string, string>> | null;
16
- details?: Record<string, Record<string, string>>;
17
- }>;
14
+ dataHealthCheck(): CancelablePromise<HealthCheckResultDto>;
18
15
  }
19
16
 
20
17
  export { HealthCheckService };
@@ -1 +1 @@
1
- class t{constructor(t){this.httpRequest=t}dataHealthCheck(){return this.httpRequest.request({method:"GET",url:"/v1/health-check",errors:{503:"The Health Check is not successful"}})}}export{t as HealthCheckService};
1
+ class e{constructor(e){this.httpRequest=e}dataHealthCheck(){return this.httpRequest.request({method:"GET",url:"/v1/health-check",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}}export{e as HealthCheckService};
@@ -0,0 +1,51 @@
1
+ import { AccessRequest } from '../models/AccessRequest.js';
2
+ import { NotificationsResponse } from '../models/NotificationsResponse.js';
3
+ import { SubscribeRequest } from '../models/SubscribeRequest.js';
4
+ import { SubscriptionsRequest } from '../models/SubscriptionsRequest.js';
5
+ import { SubscriptionsResponse } from '../models/SubscriptionsResponse.js';
6
+ import { UnsubscribeRequest } from '../models/UnsubscribeRequest.js';
7
+ import { CancelablePromise } from '../core/CancelablePromise.js';
8
+ import { BaseHttpRequest } from '../core/BaseHttpRequest.js';
9
+
10
+ declare class NotificationsService {
11
+ readonly httpRequest: BaseHttpRequest;
12
+ constructor(httpRequest: BaseHttpRequest);
13
+ /**
14
+ * Access Notifications
15
+ * Access notifications.
16
+ * @returns NotificationsResponse Successful response
17
+ * @throws ApiError
18
+ */
19
+ access({ requestBody, }: {
20
+ requestBody: AccessRequest;
21
+ }): CancelablePromise<NotificationsResponse>;
22
+ /**
23
+ * Subscribe to Notifications
24
+ * Subscribe to receive notifications.
25
+ * @returns NotificationsResponse Successful response
26
+ * @throws ApiError
27
+ */
28
+ subscribe({ requestBody, }: {
29
+ requestBody: SubscribeRequest;
30
+ }): CancelablePromise<NotificationsResponse>;
31
+ /**
32
+ * Unsubscribe from Notifications
33
+ * Unsubscribe from receiving notifications.
34
+ * @returns NotificationsResponse Successful response
35
+ * @throws ApiError
36
+ */
37
+ unsubscribe({ requestBody, }: {
38
+ requestBody: UnsubscribeRequest;
39
+ }): CancelablePromise<NotificationsResponse>;
40
+ /**
41
+ * Get Subscriptions
42
+ * Get subscriptions.
43
+ * @returns SubscriptionsResponse Successful response
44
+ * @throws ApiError
45
+ */
46
+ subscriptions({ requestBody, }: {
47
+ requestBody: SubscriptionsRequest;
48
+ }): CancelablePromise<SubscriptionsResponse>;
49
+ }
50
+
51
+ export { NotificationsService };
@@ -0,0 +1 @@
1
+ class e{constructor(e){this.httpRequest=e}access({requestBody:e}){return this.httpRequest.request({method:"POST",url:"/v1/notifications/access",body:e,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}subscribe({requestBody:e}){return this.httpRequest.request({method:"POST",url:"/v1/notifications/subscribe",body:e,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}unsubscribe({requestBody:e}){return this.httpRequest.request({method:"POST",url:"/v1/notifications/unsubscribe",body:e,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}subscriptions({requestBody:e}){return this.httpRequest.request({method:"POST",url:"/v1/notifications/subscriptions",body:e,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}}export{e as NotificationsService};
@@ -79,12 +79,12 @@ declare class WebhooksService {
79
79
  requestBody: UpdateWebhookRequest;
80
80
  }): CancelablePromise<WebhookResponse>;
81
81
  /**
82
- * Generate a shared secret
83
- * Generates a new shared secret.
82
+ * Generate or rotate a shared secret
83
+ * Generates a new shared secret or rotate an existing one.
84
84
  * @returns SharedSecretsResponse Successful response
85
85
  * @throws ApiError
86
86
  */
87
- generateSharedSecret(): CancelablePromise<SharedSecretsResponse>;
87
+ generateOrRotateSharedSecret(): CancelablePromise<SharedSecretsResponse>;
88
88
  /**
89
89
  * Get a shared secret
90
90
  * Get a previously generated shared secret.
@@ -1 +1 @@
1
- class e{constructor(e){this.httpRequest=e}createWebhook({requestBody:e}){return this.httpRequest.request({method:"POST",url:"/v1/webhooks",body:e,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}listWebhooks({pageToken:e,pageSize:r=10,status:t}){return this.httpRequest.request({method:"GET",url:"/v1/webhooks",query:{pageToken:e,pageSize:r,status:t},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getWebhook({id:e}){return this.httpRequest.request({method:"GET",url:"/v1/webhooks/{id}",path:{id:e},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}deactivateWebhook({id:e}){return this.httpRequest.request({method:"DELETE",url:"/v1/webhooks/{id}",path:{id:e},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}updateWebhook({id:e,requestBody:r}){return this.httpRequest.request({method:"PATCH",url:"/v1/webhooks/{id}",path:{id:e},body:r,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}generateSharedSecret(){return this.httpRequest.request({method:"POST",url:"/v1/webhooks:generateOrRotateSharedSecret",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getSharedSecret(){return this.httpRequest.request({method:"GET",url:"/v1/webhooks:getSharedSecret",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}addAddressesToWebhook({id:e,requestBody:r}){return this.httpRequest.request({method:"PATCH",url:"/v1/webhooks/{id}/addresses",path:{id:e},body:r,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}removeAddressesFromWebhook({id:e,requestBody:r}){return this.httpRequest.request({method:"DELETE",url:"/v1/webhooks/{id}/addresses",path:{id:e},body:r,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getAddressesFromWebhook({id:e,pageToken:r,pageSize:t=10}){return this.httpRequest.request({method:"GET",url:"/v1/webhooks/{id}/addresses",path:{id:e},query:{pageToken:r,pageSize:t},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}}export{e as WebhooksService};
1
+ class e{constructor(e){this.httpRequest=e}createWebhook({requestBody:e}){return this.httpRequest.request({method:"POST",url:"/v1/webhooks",body:e,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}listWebhooks({pageToken:e,pageSize:r=10,status:t}){return this.httpRequest.request({method:"GET",url:"/v1/webhooks",query:{pageToken:e,pageSize:r,status:t},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getWebhook({id:e}){return this.httpRequest.request({method:"GET",url:"/v1/webhooks/{id}",path:{id:e},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}deactivateWebhook({id:e}){return this.httpRequest.request({method:"DELETE",url:"/v1/webhooks/{id}",path:{id:e},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}updateWebhook({id:e,requestBody:r}){return this.httpRequest.request({method:"PATCH",url:"/v1/webhooks/{id}",path:{id:e},body:r,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}generateOrRotateSharedSecret(){return this.httpRequest.request({method:"POST",url:"/v1/webhooks:generateOrRotateSharedSecret",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getSharedSecret(){return this.httpRequest.request({method:"GET",url:"/v1/webhooks:getSharedSecret",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}addAddressesToWebhook({id:e,requestBody:r}){return this.httpRequest.request({method:"PATCH",url:"/v1/webhooks/{id}/addresses",path:{id:e},body:r,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}removeAddressesFromWebhook({id:e,requestBody:r}){return this.httpRequest.request({method:"DELETE",url:"/v1/webhooks/{id}/addresses",path:{id:e},body:r,mediaType:"application/json",errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}getAddressesFromWebhook({id:e,pageToken:r,pageSize:t=10}){return this.httpRequest.request({method:"GET",url:"/v1/webhooks/{id}/addresses",path:{id:e},query:{pageToken:r,pageSize:t},errors:{400:"Bad requests generally mean the client has passed invalid\n or malformed parameters. Error messages in the response could help in\n evaluating the error.",401:"When a client attempts to access resources that require\n authorization credentials but the client lacks proper authentication\n in the request, the server responds with 401.",403:"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action,\n the server responds with 403.",404:"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted,\n or the resource doesn't exist.",429:"This error is returned when the client has sent too many,\n and has hit the rate limit.",500:"The error is a generic server side error that is\n returned for any uncaught and unexpected issues on the server side.\n This should be very rare, and you may reach out to us if the problem\n persists for a longer duration.",502:"This is an internal error indicating invalid response\n received by the client-facing proxy or gateway from the upstream server.",503:"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may\n not necessarily mean the Subnet is down or affected."}})}}export{e as WebhooksService};