@scaleway/sdk-webhosting 2.11.0 → 2.12.0

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.
@@ -1,553 +0,0 @@
1
- import { API as ParentAPI } from '@scaleway/sdk-client';
2
- import type { WaitForOptions, ApiLocality } from '@scaleway/sdk-client';
3
- import type { Backup, BackupApiGetBackupRequest, BackupApiGetProgressRequest, BackupApiListBackupItemsRequest, BackupApiListBackupsRequest, BackupApiListRecentProgressesRequest, BackupApiRestoreBackupItemsRequest, BackupApiRestoreBackupRequest, CheckFreeDomainAvailabilityResponse, CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FreeDomainApiCheckFreeDomainAvailabilityRequest, FreeDomainApiListFreeRootDomainsRequest, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiAddCustomDomainRequest, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingDomainsRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiMigrateControlPanelRequest, HostingApiRemoveCustomDomainRequest, HostingApiResetHostingPasswordRequest, HostingApiResetHostingRequest, HostingApiUpdateHostingFreeDomainRequest, HostingApiUpdateHostingRequest, HostingSummary, ListBackupItemsResponse, ListBackupsResponse, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFreeRootDomainsResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListRecentProgressesResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, Progress, ResetHostingPasswordResponse, ResourceSummary, RestoreBackupItemsResponse, RestoreBackupResponse, SearchDomainsResponse, Session, Website, WebsiteApiCreateWebsiteRequest, WebsiteApiDeleteWebsiteRequest, WebsiteApiListWebsitesRequest, WebsiteApiResetWebsiteRequest } from './types.gen.js';
4
- /**
5
- * Web Hosting backup API.
6
-
7
- This API allows you to list and restore backups for your cPanel and WordPress Web Hosting service.
8
- */
9
- export declare class BackupAPI extends ParentAPI {
10
- /**
11
- * Locality of this API.
12
- * type ∈ {'zone','region','global','unspecified'}
13
- */
14
- static readonly LOCALITY: ApiLocality;
15
- protected pageOfListBackups: (request: Readonly<BackupApiListBackupsRequest>) => Promise<ListBackupsResponse>;
16
- /**
17
- * List all available backups for a hosting account.. List all available backups for a hosting account.
18
- *
19
- * @param request - The request {@link BackupApiListBackupsRequest}
20
- * @returns A Promise of ListBackupsResponse
21
- */
22
- listBackups: (request: Readonly<BackupApiListBackupsRequest>) => Promise<ListBackupsResponse> & {
23
- all: () => Promise<Backup[]>;
24
- [Symbol.asyncIterator]: () => AsyncGenerator<Backup[], void, void>;
25
- };
26
- /**
27
- * Get info about a backup specified by the backup ID.. Get info about a backup specified by the backup ID.
28
- *
29
- * @param request - The request {@link BackupApiGetBackupRequest}
30
- * @returns A Promise of Backup
31
- */
32
- getBackup: (request: Readonly<BackupApiGetBackupRequest>) => Promise<Backup>;
33
- /**
34
- * Waits for {@link Backup} to be in a final state.
35
- *
36
- * @param request - The request {@link BackupApiGetBackupRequest}
37
- * @param options - The waiting options
38
- * @returns A Promise of Backup
39
- */
40
- waitForBackup: (request: Readonly<BackupApiGetBackupRequest>, options?: Readonly<WaitForOptions<Backup>>) => Promise<Backup>;
41
- /**
42
- * Restore an entire backup to your hosting environment.. Restore an entire backup to your hosting environment.
43
- *
44
- * @param request - The request {@link BackupApiRestoreBackupRequest}
45
- * @returns A Promise of RestoreBackupResponse
46
- */
47
- restoreBackup: (request: Readonly<BackupApiRestoreBackupRequest>) => Promise<RestoreBackupResponse>;
48
- /**
49
- * List items within a specific backup, grouped by type.. List items within a specific backup, grouped by type.
50
- *
51
- * @param request - The request {@link BackupApiListBackupItemsRequest}
52
- * @returns A Promise of ListBackupItemsResponse
53
- */
54
- listBackupItems: (request: Readonly<BackupApiListBackupItemsRequest>) => Promise<ListBackupItemsResponse>;
55
- /**
56
- * Restore specific items from a backup (e.g., a database or mailbox).. Restore specific items from a backup (e.g., a database or mailbox).
57
- *
58
- * @param request - The request {@link BackupApiRestoreBackupItemsRequest}
59
- * @returns A Promise of RestoreBackupItemsResponse
60
- */
61
- restoreBackupItems: (request: Readonly<BackupApiRestoreBackupItemsRequest>) => Promise<RestoreBackupItemsResponse>;
62
- /**
63
- * Retrieve detailed information about a specific progress by its ID.. Retrieve detailed information about a specific progress by its ID.
64
- *
65
- * @param request - The request {@link BackupApiGetProgressRequest}
66
- * @returns A Promise of Progress
67
- */
68
- getProgress: (request: Readonly<BackupApiGetProgressRequest>) => Promise<Progress>;
69
- /**
70
- * List recent progresses associated with a specific backup, grouped by type.. List recent progresses associated with a specific backup, grouped by type.
71
- *
72
- * @param request - The request {@link BackupApiListRecentProgressesRequest}
73
- * @returns A Promise of ListRecentProgressesResponse
74
- */
75
- listRecentProgresses: (request: Readonly<BackupApiListRecentProgressesRequest>) => Promise<ListRecentProgressesResponse>;
76
- }
77
- /**
78
- * Web Hosting Control Panel API.
79
-
80
- This API allows you to manage your Web Hosting services.
81
- */
82
- export declare class ControlPanelAPI extends ParentAPI {
83
- /**
84
- * Locality of this API.
85
- * type ∈ {'zone','region','global','unspecified'}
86
- */
87
- static readonly LOCALITY: ApiLocality;
88
- protected pageOfListControlPanels: (request?: Readonly<ControlPanelApiListControlPanelsRequest>) => Promise<ListControlPanelsResponse>;
89
- /**
90
- * "List the control panels type: cpanel or plesk.".
91
- *
92
- * @param request - The request {@link ControlPanelApiListControlPanelsRequest}
93
- * @returns A Promise of ListControlPanelsResponse
94
- */
95
- listControlPanels: (request?: Readonly<ControlPanelApiListControlPanelsRequest>) => Promise<ListControlPanelsResponse> & {
96
- all: () => Promise<import("./types.gen.js").ControlPanel[]>;
97
- [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").ControlPanel[], void, void>;
98
- };
99
- }
100
- /**
101
- * Web Hosting Database API.
102
-
103
- This API allows you to manage your databases and database users for your Web Hosting services.
104
- */
105
- export declare class DatabaseAPI extends ParentAPI {
106
- /**
107
- * Locality of this API.
108
- * type ∈ {'zone','region','global','unspecified'}
109
- */
110
- static readonly LOCALITY: ApiLocality;
111
- /**
112
- * "Create a new database within your hosting plan".
113
- *
114
- * @param request - The request {@link DatabaseApiCreateDatabaseRequest}
115
- * @returns A Promise of Database
116
- */
117
- createDatabase: (request: Readonly<DatabaseApiCreateDatabaseRequest>) => Promise<Database>;
118
- protected pageOfListDatabases: (request: Readonly<DatabaseApiListDatabasesRequest>) => Promise<ListDatabasesResponse>;
119
- /**
120
- * "List all databases within your hosting plan".
121
- *
122
- * @param request - The request {@link DatabaseApiListDatabasesRequest}
123
- * @returns A Promise of ListDatabasesResponse
124
- */
125
- listDatabases: (request: Readonly<DatabaseApiListDatabasesRequest>) => Promise<ListDatabasesResponse> & {
126
- all: () => Promise<Database[]>;
127
- [Symbol.asyncIterator]: () => AsyncGenerator<Database[], void, void>;
128
- };
129
- /**
130
- * "Get details of a database within your hosting plan".
131
- *
132
- * @param request - The request {@link DatabaseApiGetDatabaseRequest}
133
- * @returns A Promise of Database
134
- */
135
- getDatabase: (request: Readonly<DatabaseApiGetDatabaseRequest>) => Promise<Database>;
136
- /**
137
- * "Delete a database within your hosting plan".
138
- *
139
- * @param request - The request {@link DatabaseApiDeleteDatabaseRequest}
140
- * @returns A Promise of Database
141
- */
142
- deleteDatabase: (request: Readonly<DatabaseApiDeleteDatabaseRequest>) => Promise<Database>;
143
- /**
144
- * "Create a new database user".
145
- *
146
- * @param request - The request {@link DatabaseApiCreateDatabaseUserRequest}
147
- * @returns A Promise of DatabaseUser
148
- */
149
- createDatabaseUser: (request: Readonly<DatabaseApiCreateDatabaseUserRequest>) => Promise<DatabaseUser>;
150
- protected pageOfListDatabaseUsers: (request: Readonly<DatabaseApiListDatabaseUsersRequest>) => Promise<ListDatabaseUsersResponse>;
151
- /**
152
- * "List all database users".
153
- *
154
- * @param request - The request {@link DatabaseApiListDatabaseUsersRequest}
155
- * @returns A Promise of ListDatabaseUsersResponse
156
- */
157
- listDatabaseUsers: (request: Readonly<DatabaseApiListDatabaseUsersRequest>) => Promise<ListDatabaseUsersResponse> & {
158
- all: () => Promise<DatabaseUser[]>;
159
- [Symbol.asyncIterator]: () => AsyncGenerator<DatabaseUser[], void, void>;
160
- };
161
- /**
162
- * "Get details of a database user".
163
- *
164
- * @param request - The request {@link DatabaseApiGetDatabaseUserRequest}
165
- * @returns A Promise of DatabaseUser
166
- */
167
- getDatabaseUser: (request: Readonly<DatabaseApiGetDatabaseUserRequest>) => Promise<DatabaseUser>;
168
- /**
169
- * "Delete a database user".
170
- *
171
- * @param request - The request {@link DatabaseApiDeleteDatabaseUserRequest}
172
- * @returns A Promise of DatabaseUser
173
- */
174
- deleteDatabaseUser: (request: Readonly<DatabaseApiDeleteDatabaseUserRequest>) => Promise<DatabaseUser>;
175
- /**
176
- * "Change the password of a database user".
177
- *
178
- * @param request - The request {@link DatabaseApiChangeDatabaseUserPasswordRequest}
179
- * @returns A Promise of DatabaseUser
180
- */
181
- changeDatabaseUserPassword: (request: Readonly<DatabaseApiChangeDatabaseUserPasswordRequest>) => Promise<DatabaseUser>;
182
- /**
183
- * "Assign a database user to a database".
184
- *
185
- * @param request - The request {@link DatabaseApiAssignDatabaseUserRequest}
186
- * @returns A Promise of DatabaseUser
187
- */
188
- assignDatabaseUser: (request: Readonly<DatabaseApiAssignDatabaseUserRequest>) => Promise<DatabaseUser>;
189
- /**
190
- * "Unassign a database user from a database".
191
- *
192
- * @param request - The request {@link DatabaseApiUnassignDatabaseUserRequest}
193
- * @returns A Promise of DatabaseUser
194
- */
195
- unassignDatabaseUser: (request: Readonly<DatabaseApiUnassignDatabaseUserRequest>) => Promise<DatabaseUser>;
196
- }
197
- /**
198
- * Web Hosting Dns API.
199
-
200
- This API allows you to manage your Web Hosting services.
201
- */
202
- export declare class DnsAPI extends ParentAPI {
203
- /**
204
- * Locality of this API.
205
- * type ∈ {'zone','region','global','unspecified'}
206
- */
207
- static readonly LOCALITY: ApiLocality;
208
- /**
209
- * Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain.
210
- *
211
- * @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
212
- * @returns A Promise of DnsRecords
213
- */
214
- getDomainDnsRecords: (request: Readonly<DnsApiGetDomainDnsRecordsRequest>) => Promise<DnsRecords>;
215
- /**
216
- * Check whether you own this domain or not.. Check whether you own this domain or not.
217
- *
218
- * @deprecated
219
- * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
220
- * @returns A Promise of CheckUserOwnsDomainResponse
221
- */
222
- checkUserOwnsDomain: (request: Readonly<DnsApiCheckUserOwnsDomainRequest>) => Promise<CheckUserOwnsDomainResponse>;
223
- /**
224
- * Synchronize your DNS records on the Elements Console and on cPanel.. Synchronize your DNS records on the Elements Console and on cPanel.
225
- *
226
- * @param request - The request {@link DnsApiSyncDomainDnsRecordsRequest}
227
- * @returns A Promise of DnsRecords
228
- */
229
- syncDomainDnsRecords: (request: Readonly<DnsApiSyncDomainDnsRecordsRequest>) => Promise<DnsRecords>;
230
- /**
231
- * Search for available domains based on domain name.. Search for available domains based on domain name.
232
- *
233
- * @param request - The request {@link DnsApiSearchDomainsRequest}
234
- * @returns A Promise of SearchDomainsResponse
235
- */
236
- searchDomains: (request: Readonly<DnsApiSearchDomainsRequest>) => Promise<SearchDomainsResponse>;
237
- /**
238
- * Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.. Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.
239
- *
240
- * @param request - The request {@link DnsApiGetDomainRequest}
241
- * @returns A Promise of Domain
242
- */
243
- getDomain: (request: Readonly<DnsApiGetDomainRequest>) => Promise<Domain>;
244
- /**
245
- * Waits for {@link Domain} to be in a final state.
246
- *
247
- * @param request - The request {@link DnsApiGetDomainRequest}
248
- * @param options - The waiting options
249
- * @returns A Promise of Domain
250
- */
251
- waitForDomain: (request: Readonly<DnsApiGetDomainRequest>, options?: Readonly<WaitForOptions<Domain>>) => Promise<Domain>;
252
- }
253
- /**
254
- * Web Hosting Offer API.
255
-
256
- This API allows you to manage your offer for your Web Hosting services.
257
- */
258
- export declare class OfferAPI extends ParentAPI {
259
- /**
260
- * Locality of this API.
261
- * type ∈ {'zone','region','global','unspecified'}
262
- */
263
- static readonly LOCALITY: ApiLocality;
264
- protected pageOfListOffers: (request?: Readonly<OfferApiListOffersRequest>) => Promise<ListOffersResponse>;
265
- /**
266
- * List all available hosting offers along with their specific options.. List all available hosting offers along with their specific options.
267
- *
268
- * @param request - The request {@link OfferApiListOffersRequest}
269
- * @returns A Promise of ListOffersResponse
270
- */
271
- listOffers: (request?: Readonly<OfferApiListOffersRequest>) => Promise<ListOffersResponse> & {
272
- all: () => Promise<import("./types.gen.js").Offer[]>;
273
- [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").Offer[], void, void>;
274
- };
275
- }
276
- /**
277
- * Web Hosting API.
278
-
279
- This API allows you to manage your Web Hosting services.
280
- */
281
- export declare class HostingAPI extends ParentAPI {
282
- /**
283
- * Locality of this API.
284
- * type ∈ {'zone','region','global','unspecified'}
285
- */
286
- static readonly LOCALITY: ApiLocality;
287
- /**
288
- * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the `offer_id` parameter.
289
- *
290
- * @param request - The request {@link HostingApiCreateHostingRequest}
291
- * @returns A Promise of Hosting
292
- */
293
- createHosting: (request: Readonly<HostingApiCreateHostingRequest>) => Promise<Hosting>;
294
- protected pageOfListHostings: (request?: Readonly<HostingApiListHostingsRequest>) => Promise<ListHostingsResponse>;
295
- /**
296
- * List all Web Hosting plans. List all of your existing Web Hosting plans. Various filters are available to limit the results, including filtering by domain, status, tag and Project ID.
297
- *
298
- * @param request - The request {@link HostingApiListHostingsRequest}
299
- * @returns A Promise of ListHostingsResponse
300
- */
301
- listHostings: (request?: Readonly<HostingApiListHostingsRequest>) => Promise<ListHostingsResponse> & {
302
- all: () => Promise<HostingSummary[]>;
303
- [Symbol.asyncIterator]: () => AsyncGenerator<HostingSummary[], void, void>;
304
- };
305
- /**
306
- * Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its `hosting_id`.
307
- *
308
- * @param request - The request {@link HostingApiGetHostingRequest}
309
- * @returns A Promise of Hosting
310
- */
311
- getHosting: (request: Readonly<HostingApiGetHostingRequest>) => Promise<Hosting>;
312
- /**
313
- * Waits for {@link Hosting} to be in a final state.
314
- *
315
- * @param request - The request {@link HostingApiGetHostingRequest}
316
- * @param options - The waiting options
317
- * @returns A Promise of Hosting
318
- */
319
- waitForHosting: (request: Readonly<HostingApiGetHostingRequest>, options?: Readonly<WaitForOptions<Hosting>>) => Promise<Hosting>;
320
- /**
321
- * Update a Web Hosting plan. Update the details of one of your existing Web Hosting plans, specified by its `hosting_id`. You can update parameters including the contact email address, tags, options and offer.
322
- *
323
- * @param request - The request {@link HostingApiUpdateHostingRequest}
324
- * @returns A Promise of Hosting
325
- */
326
- updateHosting: (request: Readonly<HostingApiUpdateHostingRequest>) => Promise<Hosting>;
327
- /**
328
- * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its `hosting_id`. Note that deletion is not immediate: it will take place at the end of the calendar month, after which time your Web Hosting plan and all its data (files and emails) will be irreversibly lost.
329
- *
330
- * @param request - The request {@link HostingApiDeleteHostingRequest}
331
- * @returns A Promise of Hosting
332
- */
333
- deleteHosting: (request: Readonly<HostingApiDeleteHostingRequest>) => Promise<Hosting>;
334
- /**
335
- * Create a user session.
336
- *
337
- * @param request - The request {@link HostingApiCreateSessionRequest}
338
- * @returns A Promise of Session
339
- */
340
- createSession: (request: Readonly<HostingApiCreateSessionRequest>) => Promise<Session>;
341
- /**
342
- * Reset a Web Hosting plan password.
343
- *
344
- * @param request - The request {@link HostingApiResetHostingPasswordRequest}
345
- * @returns A Promise of ResetHostingPasswordResponse
346
- */
347
- resetHostingPassword: (request: Readonly<HostingApiResetHostingPasswordRequest>) => Promise<ResetHostingPasswordResponse>;
348
- /**
349
- * Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan.
350
- *
351
- * @param request - The request {@link HostingApiGetResourceSummaryRequest}
352
- * @returns A Promise of ResourceSummary
353
- */
354
- getResourceSummary: (request: Readonly<HostingApiGetResourceSummaryRequest>) => Promise<ResourceSummary>;
355
- /**
356
- * Attach a custom domain to a webhosting as an alias to the main domain.
357
- *
358
- * @param request - The request {@link HostingApiAddCustomDomainRequest}
359
- * @returns A Promise of HostingSummary
360
- */
361
- addCustomDomain: (request: Readonly<HostingApiAddCustomDomainRequest>) => Promise<HostingSummary>;
362
- /**
363
- * Detach a custom domain from a webhosting.
364
- *
365
- * @param request - The request {@link HostingApiRemoveCustomDomainRequest}
366
- * @returns A Promise of HostingSummary
367
- */
368
- removeCustomDomain: (request: Readonly<HostingApiRemoveCustomDomainRequest>) => Promise<HostingSummary>;
369
- /**
370
- * Migrate a hosting to a new control panel.. Migrate a hosting to a new control panel.
371
- *
372
- * @param request - The request {@link HostingApiMigrateControlPanelRequest}
373
- * @returns A Promise of HostingSummary
374
- */
375
- migrateControlPanel: (request: Readonly<HostingApiMigrateControlPanelRequest>) => Promise<HostingSummary>;
376
- /**
377
- * Reset a Web Hosting plan. Reset a Web Hosting plan to its initial state, specified by its `hosting_id`. This permanently deletes all hosting data including files, databases and emails. The hosting will be re-provisioned.
378
- *
379
- * @param request - The request {@link HostingApiResetHostingRequest}
380
- * @returns A Promise of Hosting
381
- */
382
- resetHosting: (request: Readonly<HostingApiResetHostingRequest>) => Promise<Hosting>;
383
- /**
384
- * Delete domains from a Web Hosting plan. Remove one or more domains from a Web Hosting plan, specified by its `hosting_id`. This permanently deletes the domains and all services tied to them, including mailboxes, FTP accounts and DNS zones.
385
- *
386
- * @param request - The request {@link HostingApiDeleteHostingDomainsRequest}
387
- * @returns A Promise of Hosting
388
- */
389
- deleteHostingDomains: (request: Readonly<HostingApiDeleteHostingDomainsRequest>) => Promise<Hosting>;
390
- /**
391
- * Update the free domain of a Web Hosting plan. Change the free domain associated with a Web Hosting plan, specified by its `hosting_id`.
392
- *
393
- * @param request - The request {@link HostingApiUpdateHostingFreeDomainRequest}
394
- * @returns A Promise of Hosting
395
- */
396
- updateHostingFreeDomain: (request: Readonly<HostingApiUpdateHostingFreeDomainRequest>) => Promise<Hosting>;
397
- }
398
- /**
399
- * Web Hosting free domain API.
400
-
401
- This API allows you to list and check a free domain's validity.
402
- */
403
- export declare class FreeDomainAPI extends ParentAPI {
404
- /**
405
- * Locality of this API.
406
- * type ∈ {'zone','region','global','unspecified'}
407
- */
408
- static readonly LOCALITY: ApiLocality;
409
- /**
410
- * Check whether a given slug and free domain combination is available.. Check whether a given slug and free domain combination is available.
411
- *
412
- * @param request - The request {@link FreeDomainApiCheckFreeDomainAvailabilityRequest}
413
- * @returns A Promise of CheckFreeDomainAvailabilityResponse
414
- */
415
- checkFreeDomainAvailability: (request: Readonly<FreeDomainApiCheckFreeDomainAvailabilityRequest>) => Promise<CheckFreeDomainAvailabilityResponse>;
416
- protected pageOfListFreeRootDomains: (request?: Readonly<FreeDomainApiListFreeRootDomainsRequest>) => Promise<ListFreeRootDomainsResponse>;
417
- /**
418
- * Retrieve the list of free root domains available for a Web Hosting.. Retrieve the list of free root domains available for a Web Hosting.
419
- *
420
- * @param request - The request {@link FreeDomainApiListFreeRootDomainsRequest}
421
- * @returns A Promise of ListFreeRootDomainsResponse
422
- */
423
- listFreeRootDomains: (request?: Readonly<FreeDomainApiListFreeRootDomainsRequest>) => Promise<ListFreeRootDomainsResponse> & {
424
- all: () => Promise<string[]>;
425
- [Symbol.asyncIterator]: () => AsyncGenerator<string[], void, void>;
426
- };
427
- }
428
- /**
429
- * Web Hosting FTP Account API.
430
-
431
- This API allows you to manage your FTP accounts for your Web Hosting services.
432
- */
433
- export declare class FtpAccountAPI extends ParentAPI {
434
- /**
435
- * Locality of this API.
436
- * type ∈ {'zone','region','global','unspecified'}
437
- */
438
- static readonly LOCALITY: ApiLocality;
439
- /**
440
- * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan.
441
- *
442
- * @param request - The request {@link FtpAccountApiCreateFtpAccountRequest}
443
- * @returns A Promise of FtpAccount
444
- */
445
- createFtpAccount: (request: Readonly<FtpAccountApiCreateFtpAccountRequest>) => Promise<FtpAccount>;
446
- protected pageOfListFtpAccounts: (request: Readonly<FtpAccountApiListFtpAccountsRequest>) => Promise<ListFtpAccountsResponse>;
447
- /**
448
- * List all FTP accounts within your hosting plan.. List all FTP accounts within your hosting plan.
449
- *
450
- * @param request - The request {@link FtpAccountApiListFtpAccountsRequest}
451
- * @returns A Promise of ListFtpAccountsResponse
452
- */
453
- listFtpAccounts: (request: Readonly<FtpAccountApiListFtpAccountsRequest>) => Promise<ListFtpAccountsResponse> & {
454
- all: () => Promise<FtpAccount[]>;
455
- [Symbol.asyncIterator]: () => AsyncGenerator<FtpAccount[], void, void>;
456
- };
457
- /**
458
- * Delete a specific FTP account within your hosting plan.. Delete a specific FTP account within your hosting plan.
459
- *
460
- * @param request - The request {@link FtpAccountApiRemoveFtpAccountRequest}
461
- * @returns A Promise of FtpAccount
462
- */
463
- removeFtpAccount: (request: Readonly<FtpAccountApiRemoveFtpAccountRequest>) => Promise<FtpAccount>;
464
- changeFtpAccountPassword: (request: Readonly<FtpAccountApiChangeFtpAccountPasswordRequest>) => Promise<FtpAccount>;
465
- }
466
- /**
467
- * Web Hosting Mail Account API.
468
-
469
- This API allows you to manage your mail accounts for your Web Hosting services.
470
- */
471
- export declare class MailAccountAPI extends ParentAPI {
472
- /**
473
- * Locality of this API.
474
- * type ∈ {'zone','region','global','unspecified'}
475
- */
476
- static readonly LOCALITY: ApiLocality;
477
- /**
478
- * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.
479
- *
480
- * @param request - The request {@link MailAccountApiCreateMailAccountRequest}
481
- * @returns A Promise of MailAccount
482
- */
483
- createMailAccount: (request: Readonly<MailAccountApiCreateMailAccountRequest>) => Promise<MailAccount>;
484
- protected pageOfListMailAccounts: (request: Readonly<MailAccountApiListMailAccountsRequest>) => Promise<ListMailAccountsResponse>;
485
- /**
486
- * List all mail accounts within your hosting plan.. List all mail accounts within your hosting plan.
487
- *
488
- * @param request - The request {@link MailAccountApiListMailAccountsRequest}
489
- * @returns A Promise of ListMailAccountsResponse
490
- */
491
- listMailAccounts: (request: Readonly<MailAccountApiListMailAccountsRequest>) => Promise<ListMailAccountsResponse> & {
492
- all: () => Promise<MailAccount[]>;
493
- [Symbol.asyncIterator]: () => AsyncGenerator<MailAccount[], void, void>;
494
- };
495
- /**
496
- * Delete a mail account within your hosting plan.. Delete a mail account within your hosting plan.
497
- *
498
- * @param request - The request {@link MailAccountApiRemoveMailAccountRequest}
499
- * @returns A Promise of MailAccount
500
- */
501
- removeMailAccount: (request: Readonly<MailAccountApiRemoveMailAccountRequest>) => Promise<MailAccount>;
502
- /**
503
- * Update the password of a mail account within your hosting plan.. Update the password of a mail account within your hosting plan.
504
- *
505
- * @param request - The request {@link MailAccountApiChangeMailAccountPasswordRequest}
506
- * @returns A Promise of MailAccount
507
- */
508
- changeMailAccountPassword: (request: Readonly<MailAccountApiChangeMailAccountPasswordRequest>) => Promise<MailAccount>;
509
- }
510
- /**
511
- * Web Hosting Website API.
512
-
513
- This API allows you to manage your websites for your Web Hosting services.
514
- */
515
- export declare class WebsiteAPI extends ParentAPI {
516
- /**
517
- * Locality of this API.
518
- * type ∈ {'zone','region','global','unspecified'}
519
- */
520
- static readonly LOCALITY: ApiLocality;
521
- protected pageOfListWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse>;
522
- /**
523
- * List all websites for a specific hosting.. List all websites for a specific hosting.
524
- *
525
- * @param request - The request {@link WebsiteApiListWebsitesRequest}
526
- * @returns A Promise of ListWebsitesResponse
527
- */
528
- listWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse> & {
529
- all: () => Promise<Website[]>;
530
- [Symbol.asyncIterator]: () => AsyncGenerator<Website[], void, void>;
531
- };
532
- /**
533
- * Create a new website and attach it to a webhosting.
534
- *
535
- * @param request - The request {@link WebsiteApiCreateWebsiteRequest}
536
- * @returns A Promise of Website
537
- */
538
- createWebsite: (request: Readonly<WebsiteApiCreateWebsiteRequest>) => Promise<Website>;
539
- /**
540
- * Delete a website from a webhosting.
541
- *
542
- * @param request - The request {@link WebsiteApiDeleteWebsiteRequest}
543
- */
544
- deleteWebsite: (request: Readonly<WebsiteApiDeleteWebsiteRequest>) => Promise<void>;
545
- /**
546
- * Delete a website's content, all files and directories. This. Permanently deletes data including files and configurations. The
547
- website will display the default welcome page.
548
- *
549
- * @param request - The request {@link WebsiteApiResetWebsiteRequest}
550
- * @returns A Promise of Website
551
- */
552
- resetWebsite: (request: Readonly<WebsiteApiResetWebsiteRequest>) => Promise<Website>;
553
- }