@scaleway/sdk-dedibox 1.0.1

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.
@@ -0,0 +1,550 @@
1
+ import { API as ParentAPI } from '@scaleway/sdk-client';
2
+ import type { Zone as ScwZone, WaitForOptions } from '@scaleway/sdk-client';
3
+ import type { AttachFailoverIPToMacAddressRequest, AttachFailoverIPsRequest, BMCAccess, Backup, BillingApiCanOrderRequest, BillingApiDownloadInvoiceRequest, BillingApiDownloadRefundRequest, BillingApiGetInvoiceRequest, BillingApiGetRefundRequest, BillingApiListInvoicesRequest, BillingApiListRefundsRequest, CanOrderResponse, CancelServerInstallRequest, CreateFailoverIPsRequest, CreateFailoverIPsResponse, CreateServerRequest, DeleteFailoverIPRequest, DeleteServerRequest, DeleteServiceRequest, DetachFailoverIPFromMacAddressRequest, DetachFailoverIPsRequest, FailoverIP, GetBMCAccessRequest, GetFailoverIPRequest, GetIPv6BlockQuotasResponse, GetOSRequest, GetOfferRequest, GetOrderedServiceRequest, GetRaidRequest, GetRemainingQuotaRequest, GetRemainingQuotaResponse, GetRescueRequest, GetRpnStatusResponse, GetServerBackupRequest, GetServerDefaultPartitioningRequest, GetServerInstallRequest, GetServerRequest, GetServiceRequest, IP, IPv6Block, IPv6BlockApiCreateIPv6BlockRequest, IPv6BlockApiCreateIPv6BlockSubnetRequest, IPv6BlockApiDeleteIPv6BlockRequest, IPv6BlockApiGetIPv6BlockQuotasRequest, IPv6BlockApiGetIPv6BlockRequest, IPv6BlockApiListIPv6BlockSubnetsAvailableRequest, IPv6BlockApiUpdateIPv6BlockRequest, InstallServerRequest, Invoice, ListFailoverIPsRequest, ListFailoverIPsResponse, ListIPv6BlockSubnetsAvailableResponse, ListInvoicesResponse, ListIpsResponse, ListOSRequest, ListOSResponse, ListOffersRequest, ListOffersResponse, ListRefundsResponse, ListRpnCapableSanServersResponse, ListRpnCapableServersResponse, ListRpnGroupMembersResponse, ListRpnGroupsResponse, ListRpnInvitesResponse, ListRpnSansResponse, ListRpnServerCapabilitiesResponse, ListRpnV2CapableResourcesResponse, ListRpnV2GroupLogsResponse, ListRpnV2GroupsResponse, ListRpnV2MembersResponse, ListServerDisksRequest, ListServerDisksResponse, ListServerEventsRequest, ListServerEventsResponse, ListServersRequest, ListServersResponse, ListServicesRequest, ListServicesResponse, ListSubscribableServerOptionsRequest, ListSubscribableServerOptionsResponse, OS, Offer, Raid, RebootServerRequest, Refund, Rescue, RpnApiGetRpnStatusRequest, RpnApiListRpnServerCapabilitiesRequest, RpnGroup, RpnSan, RpnSanApiAddIpRequest, RpnSanApiCreateRpnSanRequest, RpnSanApiDeleteRpnSanRequest, RpnSanApiGetRpnSanRequest, RpnSanApiListAvailableIpsRequest, RpnSanApiListIpsRequest, RpnSanApiListRpnSansRequest, RpnSanApiRemoveIpRequest, RpnV1ApiAcceptRpnInviteRequest, RpnV1ApiAddRpnGroupMembersRequest, RpnV1ApiCreateRpnGroupRequest, RpnV1ApiDeleteRpnGroupMembersRequest, RpnV1ApiDeleteRpnGroupRequest, RpnV1ApiGetRpnGroupRequest, RpnV1ApiLeaveRpnGroupRequest, RpnV1ApiListRpnCapableSanServersRequest, RpnV1ApiListRpnCapableServersRequest, RpnV1ApiListRpnGroupMembersRequest, RpnV1ApiListRpnGroupsRequest, RpnV1ApiListRpnInvitesRequest, RpnV1ApiRefuseRpnInviteRequest, RpnV1ApiRpnGroupInviteRequest, RpnV1ApiUpdateRpnGroupNameRequest, RpnV2ApiAddRpnV2MembersRequest, RpnV2ApiCreateRpnV2GroupRequest, RpnV2ApiDeleteRpnV2GroupRequest, RpnV2ApiDeleteRpnV2MembersRequest, RpnV2ApiDisableRpnV2GroupCompatibilityRequest, RpnV2ApiEnableRpnV2GroupCompatibilityRequest, RpnV2ApiGetRpnV2GroupRequest, RpnV2ApiListRpnV2CapableResourcesRequest, RpnV2ApiListRpnV2GroupLogsRequest, RpnV2ApiListRpnV2GroupsRequest, RpnV2ApiListRpnV2MembersRequest, RpnV2ApiUpdateRpnV2GroupNameRequest, RpnV2ApiUpdateRpnV2VlanForMembersRequest, RpnV2Group, Server, ServerDefaultPartitioning, ServerInstall, Service, StartBMCAccessRequest, StartRescueRequest, StartServerRequest, StopBMCAccessRequest, StopRescueRequest, StopServerRequest, SubscribeServerOptionRequest, SubscribeStorageOptionsRequest, SubscribeStorageOptionsResponse, UpdateRaidRequest, UpdateReverseRequest, UpdateServerBackupRequest, UpdateServerRequest, UpdateServerTagsRequest } from './types.gen';
4
+ /**
5
+ * Dedibox Phoenix API.
6
+ */
7
+ export declare class API extends ParentAPI {
8
+ /** Lists the available zones of the API. */
9
+ static readonly LOCALITIES: ScwZone[];
10
+ protected pageOfListServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse>;
11
+ /**
12
+ * List baremetal servers for project.
13
+ *
14
+ * @param request - The request {@link ListServersRequest}
15
+ * @returns A Promise of ListServersResponse
16
+ */
17
+ listServers: (request?: Readonly<ListServersRequest>) => Promise<ListServersResponse> & {
18
+ all: () => Promise<import("./types.gen").ServerSummary[]>;
19
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ServerSummary[], void, void>;
20
+ };
21
+ /**
22
+ * Get a specific baremetal server. Get the server associated with the given ID.
23
+ *
24
+ * @param request - The request {@link GetServerRequest}
25
+ * @returns A Promise of Server
26
+ */
27
+ getServer: (request: Readonly<GetServerRequest>) => Promise<Server>;
28
+ /**
29
+ * Waits for {@link Server} to be in a final state.
30
+ *
31
+ * @param request - The request {@link GetServerRequest}
32
+ * @param options - The waiting options
33
+ * @returns A Promise of Server
34
+ */
35
+ waitForServer: (request: Readonly<GetServerRequest>, options?: Readonly<WaitForOptions<Server>>) => Promise<Server>;
36
+ getServerBackup: (request: Readonly<GetServerBackupRequest>) => Promise<Backup>;
37
+ updateServerBackup: (request: Readonly<UpdateServerBackupRequest>) => Promise<Backup>;
38
+ protected pageOfListSubscribableServerOptions: (request: Readonly<ListSubscribableServerOptionsRequest>) => Promise<ListSubscribableServerOptionsResponse>;
39
+ /**
40
+ * List subscribable server options. List subscribable options associated to the given server ID.
41
+ *
42
+ * @param request - The request {@link ListSubscribableServerOptionsRequest}
43
+ * @returns A Promise of ListSubscribableServerOptionsResponse
44
+ */
45
+ listSubscribableServerOptions: (request: Readonly<ListSubscribableServerOptionsRequest>) => Promise<ListSubscribableServerOptionsResponse> & {
46
+ all: () => Promise<Offer[]>;
47
+ [Symbol.asyncIterator]: () => AsyncGenerator<Offer[], void, void>;
48
+ };
49
+ /**
50
+ * Subscribe server option. Subscribe option for the given server ID.
51
+ *
52
+ * @param request - The request {@link SubscribeServerOptionRequest}
53
+ * @returns A Promise of Service
54
+ */
55
+ subscribeServerOption: (request: Readonly<SubscribeServerOptionRequest>) => Promise<Service>;
56
+ /**
57
+ * Create a baremetal server. Create a new baremetal server. The order return you a service ID to follow the provisionning status you could call GetService.
58
+ *
59
+ * @param request - The request {@link CreateServerRequest}
60
+ * @returns A Promise of Service
61
+ */
62
+ createServer: (request: Readonly<CreateServerRequest>) => Promise<Service>;
63
+ /**
64
+ * Subscribe storage server option. Subscribe storage option for the given server ID.
65
+ *
66
+ * @param request - The request {@link SubscribeStorageOptionsRequest}
67
+ * @returns A Promise of SubscribeStorageOptionsResponse
68
+ */
69
+ subscribeStorageOptions: (request: Readonly<SubscribeStorageOptionsRequest>) => Promise<SubscribeStorageOptionsResponse>;
70
+ /**
71
+ * Update a baremetal server. Update the server associated with the given ID.
72
+ *
73
+ * @param request - The request {@link UpdateServerRequest}
74
+ * @returns A Promise of Server
75
+ */
76
+ updateServer: (request: Readonly<UpdateServerRequest>) => Promise<Server>;
77
+ updateServerTags: (request: Readonly<UpdateServerTagsRequest>) => Promise<Server>;
78
+ /**
79
+ * Reboot a baremetal server. Reboot the server associated with the given ID, use boot param to reboot in rescue.
80
+ *
81
+ * @param request - The request {@link RebootServerRequest}
82
+ */
83
+ rebootServer: (request: Readonly<RebootServerRequest>) => Promise<void>;
84
+ /**
85
+ * Start a baremetal server. Start the server associated with the given ID.
86
+ *
87
+ * @param request - The request {@link StartServerRequest}
88
+ */
89
+ startServer: (request: Readonly<StartServerRequest>) => Promise<void>;
90
+ /**
91
+ * Stop a baremetal server. Stop the server associated with the given ID.
92
+ *
93
+ * @param request - The request {@link StopServerRequest}
94
+ */
95
+ stopServer: (request: Readonly<StopServerRequest>) => Promise<void>;
96
+ /**
97
+ * Delete a baremetal server. Delete the server associated with the given ID.
98
+ *
99
+ * @param request - The request {@link DeleteServerRequest}
100
+ */
101
+ deleteServer: (request: Readonly<DeleteServerRequest>) => Promise<void>;
102
+ protected pageOfListServerEvents: (request: Readonly<ListServerEventsRequest>) => Promise<ListServerEventsResponse>;
103
+ /**
104
+ * List server events. List events associated to the given server ID.
105
+ *
106
+ * @param request - The request {@link ListServerEventsRequest}
107
+ * @returns A Promise of ListServerEventsResponse
108
+ */
109
+ listServerEvents: (request: Readonly<ListServerEventsRequest>) => Promise<ListServerEventsResponse> & {
110
+ all: () => Promise<import("./types.gen").ServerEvent[]>;
111
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ServerEvent[], void, void>;
112
+ };
113
+ protected pageOfListServerDisks: (request: Readonly<ListServerDisksRequest>) => Promise<ListServerDisksResponse>;
114
+ /**
115
+ * List server disks. List disks associated to the given server ID.
116
+ *
117
+ * @param request - The request {@link ListServerDisksRequest}
118
+ * @returns A Promise of ListServerDisksResponse
119
+ */
120
+ listServerDisks: (request: Readonly<ListServerDisksRequest>) => Promise<ListServerDisksResponse> & {
121
+ all: () => Promise<import("./types.gen").ServerDisk[]>;
122
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ServerDisk[], void, void>;
123
+ };
124
+ getOrderedService: (request: Readonly<GetOrderedServiceRequest>) => Promise<Service>;
125
+ /**
126
+ * Get a specific service. Get the service associated with the given ID.
127
+ *
128
+ * @param request - The request {@link GetServiceRequest}
129
+ * @returns A Promise of Service
130
+ */
131
+ getService: (request: Readonly<GetServiceRequest>) => Promise<Service>;
132
+ /**
133
+ * Delete a specific service. Delete the service associated with the given ID.
134
+ *
135
+ * @param request - The request {@link DeleteServiceRequest}
136
+ * @returns A Promise of Service
137
+ */
138
+ deleteService: (request: Readonly<DeleteServiceRequest>) => Promise<Service>;
139
+ protected pageOfListServices: (request?: Readonly<ListServicesRequest>) => Promise<ListServicesResponse>;
140
+ /**
141
+ * List services.
142
+ *
143
+ * @param request - The request {@link ListServicesRequest}
144
+ * @returns A Promise of ListServicesResponse
145
+ */
146
+ listServices: (request?: Readonly<ListServicesRequest>) => Promise<ListServicesResponse> & {
147
+ all: () => Promise<Service[]>;
148
+ [Symbol.asyncIterator]: () => AsyncGenerator<Service[], void, void>;
149
+ };
150
+ /**
151
+ * Install a baremetal server. Install an OS on the server associated with the given ID.
152
+ *
153
+ * @param request - The request {@link InstallServerRequest}
154
+ * @returns A Promise of ServerInstall
155
+ */
156
+ installServer: (request: Readonly<InstallServerRequest>) => Promise<ServerInstall>;
157
+ /**
158
+ * Get a specific server installation status. Get the server installation status associated with the given server ID.
159
+ *
160
+ * @param request - The request {@link GetServerInstallRequest}
161
+ * @returns A Promise of ServerInstall
162
+ */
163
+ getServerInstall: (request: Readonly<GetServerInstallRequest>) => Promise<ServerInstall>;
164
+ /**
165
+ * Waits for {@link ServerInstall} to be in a final state.
166
+ *
167
+ * @param request - The request {@link GetServerInstallRequest}
168
+ * @param options - The waiting options
169
+ * @returns A Promise of ServerInstall
170
+ */
171
+ waitForServerInstall: (request: Readonly<GetServerInstallRequest>, options?: Readonly<WaitForOptions<ServerInstall>>) => Promise<ServerInstall>;
172
+ /**
173
+ * Cancels the current (running) server installation. Cancels the current server installation associated with the given server ID.
174
+ *
175
+ * @param request - The request {@link CancelServerInstallRequest}
176
+ */
177
+ cancelServerInstall: (request: Readonly<CancelServerInstallRequest>) => Promise<void>;
178
+ /**
179
+ * Get server default partitioning. Get the server default partitioning schema associated with the given server ID and OS ID.
180
+ *
181
+ * @param request - The request {@link GetServerDefaultPartitioningRequest}
182
+ * @returns A Promise of ServerDefaultPartitioning
183
+ */
184
+ getServerDefaultPartitioning: (request: Readonly<GetServerDefaultPartitioningRequest>) => Promise<ServerDefaultPartitioning>;
185
+ /**
186
+ * Start BMC (Baseboard Management Controller) access for a given baremetal server. Start BMC (Baseboard Management Controller) access associated with the given ID.
187
+ The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
188
+ *
189
+ * @param request - The request {@link StartBMCAccessRequest}
190
+ */
191
+ startBMCAccess: (request: Readonly<StartBMCAccessRequest>) => Promise<void>;
192
+ /**
193
+ * Get BMC (Baseboard Management Controller) access for a given baremetal server. Get the BMC (Baseboard Management Controller) access associated with the given ID.
194
+ *
195
+ * @param request - The request {@link GetBMCAccessRequest}
196
+ * @returns A Promise of BMCAccess
197
+ */
198
+ getBMCAccess: (request: Readonly<GetBMCAccessRequest>) => Promise<BMCAccess>;
199
+ /**
200
+ * Waits for {@link BMCAccess} to be in a final state.
201
+ *
202
+ * @param request - The request {@link GetBMCAccessRequest}
203
+ * @param options - The waiting options
204
+ * @returns A Promise of BMCAccess
205
+ */
206
+ waitForBMCAccess: (request: Readonly<GetBMCAccessRequest>, options?: Readonly<WaitForOptions<BMCAccess>>) => Promise<BMCAccess>;
207
+ /**
208
+ * Stop BMC (Baseboard Management Controller) access for a given baremetal server. Stop BMC (Baseboard Management Controller) access associated with the given ID.
209
+ *
210
+ * @param request - The request {@link StopBMCAccessRequest}
211
+ */
212
+ stopBMCAccess: (request: Readonly<StopBMCAccessRequest>) => Promise<void>;
213
+ protected pageOfListOffers: (request?: Readonly<ListOffersRequest>) => Promise<ListOffersResponse>;
214
+ /**
215
+ * List offers. List all available server offers.
216
+ *
217
+ * @param request - The request {@link ListOffersRequest}
218
+ * @returns A Promise of ListOffersResponse
219
+ */
220
+ listOffers: (request?: Readonly<ListOffersRequest>) => Promise<ListOffersResponse> & {
221
+ all: () => Promise<Offer[]>;
222
+ [Symbol.asyncIterator]: () => AsyncGenerator<Offer[], void, void>;
223
+ };
224
+ /**
225
+ * Get offer. Return specific offer for the given ID.
226
+ *
227
+ * @param request - The request {@link GetOfferRequest}
228
+ * @returns A Promise of Offer
229
+ */
230
+ getOffer: (request: Readonly<GetOfferRequest>) => Promise<Offer>;
231
+ protected pageOfListOS: (request: Readonly<ListOSRequest>) => Promise<ListOSResponse>;
232
+ /**
233
+ * List all available OS that can be install on a baremetal server.
234
+ *
235
+ * @param request - The request {@link ListOSRequest}
236
+ * @returns A Promise of ListOSResponse
237
+ */
238
+ listOS: (request: Readonly<ListOSRequest>) => Promise<ListOSResponse> & {
239
+ all: () => Promise<OS[]>;
240
+ [Symbol.asyncIterator]: () => AsyncGenerator<OS[], void, void>;
241
+ };
242
+ /**
243
+ * Get an OS with a given ID. Return specific OS for the given ID.
244
+ *
245
+ * @param request - The request {@link GetOSRequest}
246
+ * @returns A Promise of OS
247
+ */
248
+ getOS: (request: Readonly<GetOSRequest>) => Promise<OS>;
249
+ /**
250
+ * Update reverse of ip. Update reverse of ip associated with the given ID.
251
+ *
252
+ * @param request - The request {@link UpdateReverseRequest}
253
+ * @returns A Promise of IP
254
+ */
255
+ updateReverse: (request: Readonly<UpdateReverseRequest>) => Promise<IP>;
256
+ /**
257
+ * Order failover IPs. Order X failover IPs.
258
+ *
259
+ * @param request - The request {@link CreateFailoverIPsRequest}
260
+ * @returns A Promise of CreateFailoverIPsResponse
261
+ */
262
+ createFailoverIPs: (request: Readonly<CreateFailoverIPsRequest>) => Promise<CreateFailoverIPsResponse>;
263
+ /**
264
+ * Attach failovers on baremetal server. Attach failovers on the server associated with the given ID.
265
+ *
266
+ * @param request - The request {@link AttachFailoverIPsRequest}
267
+ */
268
+ attachFailoverIPs: (request: Readonly<AttachFailoverIPsRequest>) => Promise<void>;
269
+ /**
270
+ * Detach failovers on baremetal server. Detach failovers on the server associated with the given ID.
271
+ *
272
+ * @param request - The request {@link DetachFailoverIPsRequest}
273
+ */
274
+ detachFailoverIPs: (request: Readonly<DetachFailoverIPsRequest>) => Promise<void>;
275
+ /**
276
+ * Attach a failover IP to a MAC address.
277
+ *
278
+ * @param request - The request {@link AttachFailoverIPToMacAddressRequest}
279
+ * @returns A Promise of IP
280
+ */
281
+ attachFailoverIPToMacAddress: (request: Readonly<AttachFailoverIPToMacAddressRequest>) => Promise<IP>;
282
+ /**
283
+ * Detach a failover IP from a MAC address.
284
+ *
285
+ * @param request - The request {@link DetachFailoverIPFromMacAddressRequest}
286
+ * @returns A Promise of IP
287
+ */
288
+ detachFailoverIPFromMacAddress: (request: Readonly<DetachFailoverIPFromMacAddressRequest>) => Promise<IP>;
289
+ /**
290
+ * Delete a failover server. Delete the failover associated with the given ID.
291
+ *
292
+ * @param request - The request {@link DeleteFailoverIPRequest}
293
+ */
294
+ deleteFailoverIP: (request: Readonly<DeleteFailoverIPRequest>) => Promise<void>;
295
+ protected pageOfListFailoverIPs: (request?: Readonly<ListFailoverIPsRequest>) => Promise<ListFailoverIPsResponse>;
296
+ /**
297
+ * List failovers for project. List failovers servers for project.
298
+ *
299
+ * @param request - The request {@link ListFailoverIPsRequest}
300
+ * @returns A Promise of ListFailoverIPsResponse
301
+ */
302
+ listFailoverIPs: (request?: Readonly<ListFailoverIPsRequest>) => Promise<ListFailoverIPsResponse> & {
303
+ all: () => Promise<FailoverIP[]>;
304
+ [Symbol.asyncIterator]: () => AsyncGenerator<FailoverIP[], void, void>;
305
+ };
306
+ /**
307
+ * Get a specific baremetal server. Get the server associated with the given ID.
308
+ *
309
+ * @param request - The request {@link GetFailoverIPRequest}
310
+ * @returns A Promise of FailoverIP
311
+ */
312
+ getFailoverIP: (request: Readonly<GetFailoverIPRequest>) => Promise<FailoverIP>;
313
+ /**
314
+ * Get remaining quota.
315
+ *
316
+ * @param request - The request {@link GetRemainingQuotaRequest}
317
+ * @returns A Promise of GetRemainingQuotaResponse
318
+ */
319
+ getRemainingQuota: (request?: Readonly<GetRemainingQuotaRequest>) => Promise<GetRemainingQuotaResponse>;
320
+ /**
321
+ * Get raid. Return raid for the given server ID.
322
+ *
323
+ * @param request - The request {@link GetRaidRequest}
324
+ * @returns A Promise of Raid
325
+ */
326
+ getRaid: (request: Readonly<GetRaidRequest>) => Promise<Raid>;
327
+ /**
328
+ * Update RAID. Update RAID associated with the given server ID.
329
+ *
330
+ * @param request - The request {@link UpdateRaidRequest}
331
+ */
332
+ updateRaid: (request: Readonly<UpdateRaidRequest>) => Promise<void>;
333
+ /**
334
+ * Start in rescue baremetal server. Start in rescue the server associated with the given ID.
335
+ *
336
+ * @param request - The request {@link StartRescueRequest}
337
+ * @returns A Promise of Rescue
338
+ */
339
+ startRescue: (request: Readonly<StartRescueRequest>) => Promise<Rescue>;
340
+ /**
341
+ * Get rescue information. Return rescue information for the given server ID.
342
+ *
343
+ * @param request - The request {@link GetRescueRequest}
344
+ * @returns A Promise of Rescue
345
+ */
346
+ getRescue: (request: Readonly<GetRescueRequest>) => Promise<Rescue>;
347
+ /**
348
+ * Stop rescue on baremetal server. Stop rescue on the server associated with the given ID.
349
+ *
350
+ * @param request - The request {@link StopRescueRequest}
351
+ */
352
+ stopRescue: (request: Readonly<StopRescueRequest>) => Promise<void>;
353
+ }
354
+ /**
355
+ * Dedibox Phoenix Billing API.
356
+ */
357
+ export declare class BillingAPI extends ParentAPI {
358
+ protected pageOfListInvoices: (request?: Readonly<BillingApiListInvoicesRequest>) => Promise<ListInvoicesResponse>;
359
+ listInvoices: (request?: Readonly<BillingApiListInvoicesRequest>) => Promise<ListInvoicesResponse> & {
360
+ all: () => Promise<import("./types.gen").InvoiceSummary[]>;
361
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").InvoiceSummary[], void, void>;
362
+ };
363
+ getInvoice: (request: Readonly<BillingApiGetInvoiceRequest>) => Promise<Invoice>;
364
+ downloadInvoice: (request: Readonly<BillingApiDownloadInvoiceRequest>) => Promise<Blob>;
365
+ protected pageOfListRefunds: (request?: Readonly<BillingApiListRefundsRequest>) => Promise<ListRefundsResponse>;
366
+ listRefunds: (request?: Readonly<BillingApiListRefundsRequest>) => Promise<ListRefundsResponse> & {
367
+ all: () => Promise<import("./types.gen").RefundSummary[]>;
368
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RefundSummary[], void, void>;
369
+ };
370
+ getRefund: (request: Readonly<BillingApiGetRefundRequest>) => Promise<Refund>;
371
+ downloadRefund: (request: Readonly<BillingApiDownloadRefundRequest>) => Promise<Blob>;
372
+ canOrder: (request?: Readonly<BillingApiCanOrderRequest>) => Promise<CanOrderResponse>;
373
+ }
374
+ /**
375
+ * Dedibox Phoenix IPv6 Block API.
376
+ */
377
+ export declare class IPv6BlockAPI extends ParentAPI {
378
+ /**
379
+ * Get IPv6 block quota. Get IPv6 block quota with the given project ID.
380
+ /48 one per organization.
381
+ /56 link to your number of server.
382
+ /64 link to your number of failover IP.
383
+ *
384
+ * @param request - The request {@link IPv6BlockApiGetIPv6BlockQuotasRequest}
385
+ * @returns A Promise of GetIPv6BlockQuotasResponse
386
+ */
387
+ getIPv6BlockQuotas: (request?: Readonly<IPv6BlockApiGetIPv6BlockQuotasRequest>) => Promise<GetIPv6BlockQuotasResponse>;
388
+ /**
389
+ * Create IPv6 block for baremetal server. Create IPv6 block associated with the given project ID.
390
+ *
391
+ * @param request - The request {@link IPv6BlockApiCreateIPv6BlockRequest}
392
+ * @returns A Promise of IPv6Block
393
+ */
394
+ createIPv6Block: (request?: Readonly<IPv6BlockApiCreateIPv6BlockRequest>) => Promise<IPv6Block>;
395
+ /**
396
+ * Get a specific IPv6 block. Get the IPv6 block associated with the given ID.
397
+ *
398
+ * @param request - The request {@link IPv6BlockApiGetIPv6BlockRequest}
399
+ * @returns A Promise of IPv6Block
400
+ */
401
+ getIPv6Block: (request?: Readonly<IPv6BlockApiGetIPv6BlockRequest>) => Promise<IPv6Block>;
402
+ /**
403
+ * Update IPv6 block. Update DNS associated to IPv6 block.
404
+ If DNS is used, minimum of 2 is necessary and maximum of 5 (no duplicate).
405
+ *
406
+ * @param request - The request {@link IPv6BlockApiUpdateIPv6BlockRequest}
407
+ * @returns A Promise of IPv6Block
408
+ */
409
+ updateIPv6Block: (request: Readonly<IPv6BlockApiUpdateIPv6BlockRequest>) => Promise<IPv6Block>;
410
+ /**
411
+ * Delete IPv6 block. Delete IPv6 block subnet with the given ID.
412
+ *
413
+ * @param request - The request {@link IPv6BlockApiDeleteIPv6BlockRequest}
414
+ */
415
+ deleteIPv6Block: (request: Readonly<IPv6BlockApiDeleteIPv6BlockRequest>) => Promise<void>;
416
+ /**
417
+ * Create IPv6 block subnet. Create IPv6 block subnet for the given IP ID.
418
+ /48 could create subnet in /56 (quota link to your number of server).
419
+ /56 could create subnet in /64 (quota link to your number of failover IP).
420
+ *
421
+ * @param request - The request {@link IPv6BlockApiCreateIPv6BlockSubnetRequest}
422
+ * @returns A Promise of IPv6Block
423
+ */
424
+ createIPv6BlockSubnet: (request: Readonly<IPv6BlockApiCreateIPv6BlockSubnetRequest>) => Promise<IPv6Block>;
425
+ /**
426
+ * List available IPv6 block subnets. List all available IPv6 block subnets for given IP ID.
427
+ *
428
+ * @param request - The request {@link IPv6BlockApiListIPv6BlockSubnetsAvailableRequest}
429
+ * @returns A Promise of ListIPv6BlockSubnetsAvailableResponse
430
+ */
431
+ listIPv6BlockSubnetsAvailable: (request: Readonly<IPv6BlockApiListIPv6BlockSubnetsAvailableRequest>) => Promise<ListIPv6BlockSubnetsAvailableResponse>;
432
+ }
433
+ /**
434
+ * Dedibox Phoenix RPN API.
435
+ */
436
+ export declare class RpnAPI extends ParentAPI {
437
+ protected pageOfListRpnServerCapabilities: (request?: Readonly<RpnApiListRpnServerCapabilitiesRequest>) => Promise<ListRpnServerCapabilitiesResponse>;
438
+ listRpnServerCapabilities: (request?: Readonly<RpnApiListRpnServerCapabilitiesRequest>) => Promise<ListRpnServerCapabilitiesResponse> & {
439
+ all: () => Promise<import("./types.gen").RpnServerCapability[]>;
440
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RpnServerCapability[], void, void>;
441
+ };
442
+ getRpnStatus: (request?: Readonly<RpnApiGetRpnStatusRequest>) => Promise<GetRpnStatusResponse>;
443
+ }
444
+ /**
445
+ * Dedibox Phoenix RPN SAN API.
446
+ */
447
+ export declare class RpnSanAPI extends ParentAPI {
448
+ protected pageOfListRpnSans: (request?: Readonly<RpnSanApiListRpnSansRequest>) => Promise<ListRpnSansResponse>;
449
+ listRpnSans: (request?: Readonly<RpnSanApiListRpnSansRequest>) => Promise<ListRpnSansResponse> & {
450
+ all: () => Promise<import("./types.gen").RpnSanSummary[]>;
451
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RpnSanSummary[], void, void>;
452
+ };
453
+ getRpnSan: (request: Readonly<RpnSanApiGetRpnSanRequest>) => Promise<RpnSan>;
454
+ /**
455
+ * Waits for {@link RpnSan} to be in a final state.
456
+ *
457
+ * @param request - The request {@link RpnSanApiGetRpnSanRequest}
458
+ * @param options - The waiting options
459
+ * @returns A Promise of RpnSan
460
+ */
461
+ waitForRpnSan: (request: Readonly<RpnSanApiGetRpnSanRequest>, options?: Readonly<WaitForOptions<RpnSan>>) => Promise<RpnSan>;
462
+ deleteRpnSan: (request: Readonly<RpnSanApiDeleteRpnSanRequest>) => Promise<void>;
463
+ createRpnSan: (request: Readonly<RpnSanApiCreateRpnSanRequest>) => Promise<Service>;
464
+ listIps: (request: Readonly<RpnSanApiListIpsRequest>) => Promise<ListIpsResponse>;
465
+ addIp: (request: Readonly<RpnSanApiAddIpRequest>) => Promise<void>;
466
+ removeIp: (request: Readonly<RpnSanApiRemoveIpRequest>) => Promise<void>;
467
+ listAvailableIps: (request: Readonly<RpnSanApiListAvailableIpsRequest>) => Promise<ListIpsResponse>;
468
+ }
469
+ /**
470
+ * Dedibox Phoenix RPN v1 API.
471
+ */
472
+ export declare class RpnV1API extends ParentAPI {
473
+ protected pageOfListRpnGroups: (request?: Readonly<RpnV1ApiListRpnGroupsRequest>) => Promise<ListRpnGroupsResponse>;
474
+ listRpnGroups: (request?: Readonly<RpnV1ApiListRpnGroupsRequest>) => Promise<ListRpnGroupsResponse> & {
475
+ all: () => Promise<RpnGroup[]>;
476
+ [Symbol.asyncIterator]: () => AsyncGenerator<RpnGroup[], void, void>;
477
+ };
478
+ getRpnGroup: (request: Readonly<RpnV1ApiGetRpnGroupRequest>) => Promise<RpnGroup>;
479
+ createRpnGroup: (request: Readonly<RpnV1ApiCreateRpnGroupRequest>) => Promise<RpnGroup>;
480
+ deleteRpnGroup: (request: Readonly<RpnV1ApiDeleteRpnGroupRequest>) => Promise<void>;
481
+ updateRpnGroupName: (request: Readonly<RpnV1ApiUpdateRpnGroupNameRequest>) => Promise<RpnGroup>;
482
+ protected pageOfListRpnGroupMembers: (request: Readonly<RpnV1ApiListRpnGroupMembersRequest>) => Promise<ListRpnGroupMembersResponse>;
483
+ listRpnGroupMembers: (request: Readonly<RpnV1ApiListRpnGroupMembersRequest>) => Promise<ListRpnGroupMembersResponse> & {
484
+ all: () => Promise<import("./types.gen").RpnGroupMember[]>;
485
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RpnGroupMember[], void, void>;
486
+ };
487
+ rpnGroupInvite: (request: Readonly<RpnV1ApiRpnGroupInviteRequest>) => Promise<void>;
488
+ leaveRpnGroup: (request: Readonly<RpnV1ApiLeaveRpnGroupRequest>) => Promise<void>;
489
+ addRpnGroupMembers: (request: Readonly<RpnV1ApiAddRpnGroupMembersRequest>) => Promise<RpnGroup>;
490
+ deleteRpnGroupMembers: (request: Readonly<RpnV1ApiDeleteRpnGroupMembersRequest>) => Promise<RpnGroup>;
491
+ protected pageOfListRpnCapableServers: (request?: Readonly<RpnV1ApiListRpnCapableServersRequest>) => Promise<ListRpnCapableServersResponse>;
492
+ listRpnCapableServers: (request?: Readonly<RpnV1ApiListRpnCapableServersRequest>) => Promise<ListRpnCapableServersResponse> & {
493
+ all: () => Promise<Server[]>;
494
+ [Symbol.asyncIterator]: () => AsyncGenerator<Server[], void, void>;
495
+ };
496
+ protected pageOfListRpnCapableSanServers: (request?: Readonly<RpnV1ApiListRpnCapableSanServersRequest>) => Promise<ListRpnCapableSanServersResponse>;
497
+ listRpnCapableSanServers: (request?: Readonly<RpnV1ApiListRpnCapableSanServersRequest>) => Promise<ListRpnCapableSanServersResponse> & {
498
+ all: () => Promise<import("./types.gen").RpnSanServer[]>;
499
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RpnSanServer[], void, void>;
500
+ };
501
+ protected pageOfListRpnInvites: (request?: Readonly<RpnV1ApiListRpnInvitesRequest>) => Promise<ListRpnInvitesResponse>;
502
+ listRpnInvites: (request?: Readonly<RpnV1ApiListRpnInvitesRequest>) => Promise<ListRpnInvitesResponse> & {
503
+ all: () => Promise<import("./types.gen").RpnGroupMember[]>;
504
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RpnGroupMember[], void, void>;
505
+ };
506
+ acceptRpnInvite: (request: Readonly<RpnV1ApiAcceptRpnInviteRequest>) => Promise<void>;
507
+ refuseRpnInvite: (request: Readonly<RpnV1ApiRefuseRpnInviteRequest>) => Promise<void>;
508
+ }
509
+ /**
510
+ * Dedibox Phoenix RPN v2 API.
511
+ */
512
+ export declare class RpnV2API extends ParentAPI {
513
+ protected pageOfListRpnV2Groups: (request?: Readonly<RpnV2ApiListRpnV2GroupsRequest>) => Promise<ListRpnV2GroupsResponse>;
514
+ listRpnV2Groups: (request?: Readonly<RpnV2ApiListRpnV2GroupsRequest>) => Promise<ListRpnV2GroupsResponse> & {
515
+ all: () => Promise<RpnV2Group[]>;
516
+ [Symbol.asyncIterator]: () => AsyncGenerator<RpnV2Group[], void, void>;
517
+ };
518
+ protected pageOfListRpnV2Members: (request: Readonly<RpnV2ApiListRpnV2MembersRequest>) => Promise<ListRpnV2MembersResponse>;
519
+ listRpnV2Members: (request: Readonly<RpnV2ApiListRpnV2MembersRequest>) => Promise<ListRpnV2MembersResponse> & {
520
+ all: () => Promise<import("./types.gen").RpnV2Member[]>;
521
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").RpnV2Member[], void, void>;
522
+ };
523
+ getRpnV2Group: (request: Readonly<RpnV2ApiGetRpnV2GroupRequest>) => Promise<RpnV2Group>;
524
+ /**
525
+ * Waits for {@link RpnV2Group} to be in a final state.
526
+ *
527
+ * @param request - The request {@link RpnV2ApiGetRpnV2GroupRequest}
528
+ * @param options - The waiting options
529
+ * @returns A Promise of RpnV2Group
530
+ */
531
+ waitForRpnV2Group: (request: Readonly<RpnV2ApiGetRpnV2GroupRequest>, options?: Readonly<WaitForOptions<RpnV2Group>>) => Promise<RpnV2Group>;
532
+ createRpnV2Group: (request: Readonly<RpnV2ApiCreateRpnV2GroupRequest>) => Promise<RpnV2Group>;
533
+ deleteRpnV2Group: (request: Readonly<RpnV2ApiDeleteRpnV2GroupRequest>) => Promise<void>;
534
+ updateRpnV2GroupName: (request: Readonly<RpnV2ApiUpdateRpnV2GroupNameRequest>) => Promise<RpnV2Group>;
535
+ addRpnV2Members: (request: Readonly<RpnV2ApiAddRpnV2MembersRequest>) => Promise<void>;
536
+ deleteRpnV2Members: (request: Readonly<RpnV2ApiDeleteRpnV2MembersRequest>) => Promise<void>;
537
+ protected pageOfListRpnV2CapableResources: (request?: Readonly<RpnV2ApiListRpnV2CapableResourcesRequest>) => Promise<ListRpnV2CapableResourcesResponse>;
538
+ listRpnV2CapableResources: (request?: Readonly<RpnV2ApiListRpnV2CapableResourcesRequest>) => Promise<ListRpnV2CapableResourcesResponse> & {
539
+ all: () => Promise<Server[]>;
540
+ [Symbol.asyncIterator]: () => AsyncGenerator<Server[], void, void>;
541
+ };
542
+ protected pageOfListRpnV2GroupLogs: (request: Readonly<RpnV2ApiListRpnV2GroupLogsRequest>) => Promise<ListRpnV2GroupLogsResponse>;
543
+ listRpnV2GroupLogs: (request: Readonly<RpnV2ApiListRpnV2GroupLogsRequest>) => Promise<ListRpnV2GroupLogsResponse> & {
544
+ all: () => Promise<import("./types.gen").Log[]>;
545
+ [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Log[], void, void>;
546
+ };
547
+ updateRpnV2VlanForMembers: (request: Readonly<RpnV2ApiUpdateRpnV2VlanForMembersRequest>) => Promise<void>;
548
+ enableRpnV2GroupCompatibility: (request: Readonly<RpnV2ApiEnableRpnV2GroupCompatibilityRequest>) => Promise<void>;
549
+ disableRpnV2GroupCompatibility: (request: Readonly<RpnV2ApiDisableRpnV2GroupCompatibilityRequest>) => Promise<void>;
550
+ }