@scaleway/sdk 2.56.0 → 2.58.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.
- package/dist/api/audit_trail/index.gen.cjs +4 -0
- package/dist/api/audit_trail/index.gen.d.ts +5 -0
- package/dist/api/audit_trail/index.gen.js +4 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.cjs +59 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +30 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.js +59 -0
- package/dist/api/audit_trail/v1alpha1/index.gen.cjs +6 -0
- package/dist/api/audit_trail/v1alpha1/index.gen.d.ts +3 -0
- package/dist/api/audit_trail/v1alpha1/index.gen.js +6 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +155 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.d.ts +5 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +155 -0
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +161 -0
- package/dist/api/audit_trail/v1alpha1/validation-rules.gen.cjs +19 -0
- package/dist/api/audit_trail/v1alpha1/validation-rules.gen.d.ts +16 -0
- package/dist/api/audit_trail/v1alpha1/validation-rules.gen.js +19 -0
- package/dist/api/billing/v2beta1/types.gen.d.ts +1 -1
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +5 -1
- package/dist/api/iam/v1alpha1/api.gen.cjs +9 -7
- package/dist/api/iam/v1alpha1/api.gen.d.ts +9 -7
- package/dist/api/iam/v1alpha1/api.gen.js +9 -7
- package/dist/api/iam/v1alpha1/types.gen.d.ts +2 -2
- package/dist/api/index.gen.d.ts +2 -1
- package/dist/api/instance/v1/api.gen.cjs +11 -0
- package/dist/api/instance/v1/api.gen.d.ts +2 -1
- package/dist/api/instance/v1/api.gen.js +12 -1
- package/dist/api/instance/v1/index.gen.d.ts +1 -1
- package/dist/api/instance/v1/marshalling.gen.cjs +5 -1
- package/dist/api/instance/v1/marshalling.gen.d.ts +2 -1
- package/dist/api/instance/v1/marshalling.gen.js +5 -1
- package/dist/api/instance/v1/types.gen.d.ts +10 -5
- package/dist/api/ipam/v1/api.gen.cjs +1 -0
- package/dist/api/ipam/v1/api.gen.js +1 -0
- package/dist/api/ipam/v1/types.gen.d.ts +6 -1
- package/dist/api/jobs/v1alpha1/validation-rules.gen.cjs +6 -0
- package/dist/api/jobs/v1alpha1/validation-rules.gen.d.ts +6 -0
- package/dist/api/jobs/v1alpha1/validation-rules.gen.js +6 -0
- package/dist/api/k8s/v1/marshalling.gen.cjs +1 -2
- package/dist/api/k8s/v1/marshalling.gen.js +1 -2
- package/dist/api/k8s/v1/types.gen.d.ts +2 -7
- package/dist/api/mnq/v1beta1/api.gen.cjs +47 -42
- package/dist/api/mnq/v1beta1/api.gen.d.ts +51 -49
- package/dist/api/mnq/v1beta1/api.gen.js +47 -42
- package/dist/api/mnq/v1beta1/types.gen.d.ts +37 -32
- package/dist/api/rdb/v1/types.gen.d.ts +15 -3
- package/dist/api/tem/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/webhosting/v1/api.gen.cjs +41 -2
- package/dist/api/webhosting/v1/api.gen.d.ts +26 -2
- package/dist/api/webhosting/v1/api.gen.js +42 -3
- package/dist/api/webhosting/v1/index.gen.cjs +1 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +2 -2
- package/dist/api/webhosting/v1/index.gen.js +2 -1
- package/dist/api/webhosting/v1/marshalling.gen.cjs +123 -50
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +4 -1
- package/dist/api/webhosting/v1/marshalling.gen.js +124 -51
- package/dist/api/webhosting/v1/types.gen.d.ts +124 -60
- package/dist/index.cjs +46 -44
- package/dist/index.js +46 -44
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -14,7 +14,7 @@ export interface File {
|
|
|
14
14
|
export interface SnsPermissions {
|
|
15
15
|
/**
|
|
16
16
|
* Defines whether the credentials bearer can publish messages to the service
|
|
17
|
-
* (publish to
|
|
17
|
+
* (publish to Topics and Events topics).
|
|
18
18
|
*/
|
|
19
19
|
canPublish?: boolean;
|
|
20
20
|
/**
|
|
@@ -23,24 +23,24 @@ export interface SnsPermissions {
|
|
|
23
23
|
*/
|
|
24
24
|
canReceive?: boolean;
|
|
25
25
|
/**
|
|
26
|
-
* Defines whether the credentials bearer can manage the associated
|
|
27
|
-
* or subscriptions.
|
|
26
|
+
* Defines whether the credentials bearer can manage the associated Topics and
|
|
27
|
+
* Events topics or subscriptions.
|
|
28
28
|
*/
|
|
29
29
|
canManage?: boolean;
|
|
30
30
|
}
|
|
31
31
|
export interface SqsPermissions {
|
|
32
32
|
/**
|
|
33
33
|
* Defines whether the credentials bearer can publish messages to the service
|
|
34
|
-
* (send messages to
|
|
34
|
+
* (send messages to Queues queues).
|
|
35
35
|
*/
|
|
36
36
|
canPublish?: boolean;
|
|
37
37
|
/**
|
|
38
|
-
* Defines whether the credentials bearer can receive messages from
|
|
38
|
+
* Defines whether the credentials bearer can receive messages from Queues
|
|
39
39
|
* queues.
|
|
40
40
|
*/
|
|
41
41
|
canReceive?: boolean;
|
|
42
42
|
/**
|
|
43
|
-
* Defines whether the credentials bearer can manage the associated
|
|
43
|
+
* Defines whether the credentials bearer can manage the associated Queues
|
|
44
44
|
* queues.
|
|
45
45
|
*/
|
|
46
46
|
canManage?: boolean;
|
|
@@ -95,7 +95,10 @@ export interface SnsCredentials {
|
|
|
95
95
|
updatedAt?: Date;
|
|
96
96
|
/** Access key ID. */
|
|
97
97
|
accessKey: string;
|
|
98
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* Secret key ID (Only returned by **Create Topics and Events Credentials**
|
|
100
|
+
* call).
|
|
101
|
+
*/
|
|
99
102
|
secretKey: string;
|
|
100
103
|
/** Checksum of the Secret key. */
|
|
101
104
|
secretChecksum: string;
|
|
@@ -117,7 +120,7 @@ export interface SqsCredentials {
|
|
|
117
120
|
updatedAt?: Date;
|
|
118
121
|
/** Access key ID. */
|
|
119
122
|
accessKey: string;
|
|
120
|
-
/** Secret key ID (Only returned by **Create
|
|
123
|
+
/** Secret key ID (Only returned by **Create Queues Credentials** call). */
|
|
121
124
|
secretKey: string;
|
|
122
125
|
/** Checksum of the Secret key. */
|
|
123
126
|
secretChecksum: string;
|
|
@@ -139,13 +142,13 @@ export interface ListNatsCredentialsResponse {
|
|
|
139
142
|
export interface ListSnsCredentialsResponse {
|
|
140
143
|
/** Total count of existing credentials (matching any filters specified). */
|
|
141
144
|
totalCount: number;
|
|
142
|
-
/**
|
|
145
|
+
/** Topics and Events credentials on this page. */
|
|
143
146
|
snsCredentials: SnsCredentials[];
|
|
144
147
|
}
|
|
145
148
|
export interface ListSqsCredentialsResponse {
|
|
146
149
|
/** Total count of existing credentials (matching any filters specified). */
|
|
147
150
|
totalCount: number;
|
|
148
|
-
/**
|
|
151
|
+
/** Queues credentials on this page. */
|
|
149
152
|
sqsCredentials: SqsCredentials[];
|
|
150
153
|
}
|
|
151
154
|
export type NatsApiCreateNatsAccountRequest = {
|
|
@@ -227,6 +230,8 @@ export type NatsApiListNatsCredentialsRequest = {
|
|
|
227
230
|
* config.
|
|
228
231
|
*/
|
|
229
232
|
region?: Region;
|
|
233
|
+
/** Include only NATS accounts in this Project. */
|
|
234
|
+
projectId?: string;
|
|
230
235
|
/** Include only credentials for this NATS account. */
|
|
231
236
|
natsAccountId?: string;
|
|
232
237
|
/** Page number to return. */
|
|
@@ -253,7 +258,7 @@ export type SnsApiActivateSnsRequest = {
|
|
|
253
258
|
* config.
|
|
254
259
|
*/
|
|
255
260
|
region?: Region;
|
|
256
|
-
/** Project on which to activate the
|
|
261
|
+
/** Project on which to activate the Topics and Events service. */
|
|
257
262
|
projectId?: string;
|
|
258
263
|
};
|
|
259
264
|
export type SnsApiCreateSnsCredentialsRequest = {
|
|
@@ -262,7 +267,7 @@ export type SnsApiCreateSnsCredentialsRequest = {
|
|
|
262
267
|
* config.
|
|
263
268
|
*/
|
|
264
269
|
region?: Region;
|
|
265
|
-
/** Project containing the
|
|
270
|
+
/** Project containing the Topics and Events credentials. */
|
|
266
271
|
projectId?: string;
|
|
267
272
|
/** Name of the credentials. */
|
|
268
273
|
name?: string;
|
|
@@ -275,7 +280,7 @@ export type SnsApiDeactivateSnsRequest = {
|
|
|
275
280
|
* config.
|
|
276
281
|
*/
|
|
277
282
|
region?: Region;
|
|
278
|
-
/** Project on which to deactivate the
|
|
283
|
+
/** Project on which to deactivate the Topics and Events service. */
|
|
279
284
|
projectId?: string;
|
|
280
285
|
};
|
|
281
286
|
export type SnsApiDeleteSnsCredentialsRequest = {
|
|
@@ -293,7 +298,7 @@ export type SnsApiGetSnsCredentialsRequest = {
|
|
|
293
298
|
* config.
|
|
294
299
|
*/
|
|
295
300
|
region?: Region;
|
|
296
|
-
/** ID of the
|
|
301
|
+
/** ID of the Topics and Events credentials to get. */
|
|
297
302
|
snsCredentialsId: string;
|
|
298
303
|
};
|
|
299
304
|
export type SnsApiGetSnsInfoRequest = {
|
|
@@ -302,7 +307,7 @@ export type SnsApiGetSnsInfoRequest = {
|
|
|
302
307
|
* config.
|
|
303
308
|
*/
|
|
304
309
|
region?: Region;
|
|
305
|
-
/** Project to retrieve
|
|
310
|
+
/** Project to retrieve Topics and Events info from. */
|
|
306
311
|
projectId?: string;
|
|
307
312
|
};
|
|
308
313
|
export type SnsApiListSnsCredentialsRequest = {
|
|
@@ -311,7 +316,7 @@ export type SnsApiListSnsCredentialsRequest = {
|
|
|
311
316
|
* config.
|
|
312
317
|
*/
|
|
313
318
|
region?: Region;
|
|
314
|
-
/** Include only
|
|
319
|
+
/** Include only Topics and Events credentials in this Project. */
|
|
315
320
|
projectId?: string;
|
|
316
321
|
/** Page number to return. */
|
|
317
322
|
page?: number;
|
|
@@ -326,7 +331,7 @@ export type SnsApiUpdateSnsCredentialsRequest = {
|
|
|
326
331
|
* config.
|
|
327
332
|
*/
|
|
328
333
|
region?: Region;
|
|
329
|
-
/** ID of the
|
|
334
|
+
/** ID of the Topics and Events credentials to update. */
|
|
330
335
|
snsCredentialsId: string;
|
|
331
336
|
/** Name of the credentials. */
|
|
332
337
|
name?: string;
|
|
@@ -338,13 +343,13 @@ export interface SnsInfo {
|
|
|
338
343
|
projectId: string;
|
|
339
344
|
/** Region of the service. */
|
|
340
345
|
region: Region;
|
|
341
|
-
/**
|
|
346
|
+
/** Topics and Events creation date. */
|
|
342
347
|
createdAt?: Date;
|
|
343
|
-
/**
|
|
348
|
+
/** Topics and Events last modification date. */
|
|
344
349
|
updatedAt?: Date;
|
|
345
|
-
/**
|
|
350
|
+
/** Topics and Events activation status. */
|
|
346
351
|
status: SnsInfoStatus;
|
|
347
|
-
/** Endpoint of the
|
|
352
|
+
/** Endpoint of the Topics and Events service for this region and project. */
|
|
348
353
|
snsEndpointUrl: string;
|
|
349
354
|
}
|
|
350
355
|
export type SqsApiActivateSqsRequest = {
|
|
@@ -353,7 +358,7 @@ export type SqsApiActivateSqsRequest = {
|
|
|
353
358
|
* config.
|
|
354
359
|
*/
|
|
355
360
|
region?: Region;
|
|
356
|
-
/** Project on which to activate the
|
|
361
|
+
/** Project on which to activate the Queues service. */
|
|
357
362
|
projectId?: string;
|
|
358
363
|
};
|
|
359
364
|
export type SqsApiCreateSqsCredentialsRequest = {
|
|
@@ -362,7 +367,7 @@ export type SqsApiCreateSqsCredentialsRequest = {
|
|
|
362
367
|
* config.
|
|
363
368
|
*/
|
|
364
369
|
region?: Region;
|
|
365
|
-
/** Project containing the
|
|
370
|
+
/** Project containing the Queues credentials. */
|
|
366
371
|
projectId?: string;
|
|
367
372
|
/** Name of the credentials. */
|
|
368
373
|
name?: string;
|
|
@@ -375,7 +380,7 @@ export type SqsApiDeactivateSqsRequest = {
|
|
|
375
380
|
* config.
|
|
376
381
|
*/
|
|
377
382
|
region?: Region;
|
|
378
|
-
/** Project on which to deactivate the
|
|
383
|
+
/** Project on which to deactivate the Queues service. */
|
|
379
384
|
projectId?: string;
|
|
380
385
|
};
|
|
381
386
|
export type SqsApiDeleteSqsCredentialsRequest = {
|
|
@@ -393,7 +398,7 @@ export type SqsApiGetSqsCredentialsRequest = {
|
|
|
393
398
|
* config.
|
|
394
399
|
*/
|
|
395
400
|
region?: Region;
|
|
396
|
-
/** ID of the
|
|
401
|
+
/** ID of the Queues credentials to get. */
|
|
397
402
|
sqsCredentialsId: string;
|
|
398
403
|
};
|
|
399
404
|
export type SqsApiGetSqsInfoRequest = {
|
|
@@ -402,7 +407,7 @@ export type SqsApiGetSqsInfoRequest = {
|
|
|
402
407
|
* config.
|
|
403
408
|
*/
|
|
404
409
|
region?: Region;
|
|
405
|
-
/** Project to retrieve
|
|
410
|
+
/** Project to retrieve Queues info from. */
|
|
406
411
|
projectId?: string;
|
|
407
412
|
};
|
|
408
413
|
export type SqsApiListSqsCredentialsRequest = {
|
|
@@ -411,7 +416,7 @@ export type SqsApiListSqsCredentialsRequest = {
|
|
|
411
416
|
* config.
|
|
412
417
|
*/
|
|
413
418
|
region?: Region;
|
|
414
|
-
/** Include only
|
|
419
|
+
/** Include only Queues credentials in this Project. */
|
|
415
420
|
projectId?: string;
|
|
416
421
|
/** Page number to return. */
|
|
417
422
|
page?: number;
|
|
@@ -426,7 +431,7 @@ export type SqsApiUpdateSqsCredentialsRequest = {
|
|
|
426
431
|
* config.
|
|
427
432
|
*/
|
|
428
433
|
region?: Region;
|
|
429
|
-
/** ID of the
|
|
434
|
+
/** ID of the Queues credentials to update. */
|
|
430
435
|
sqsCredentialsId: string;
|
|
431
436
|
/** Name of the credentials. */
|
|
432
437
|
name?: string;
|
|
@@ -438,12 +443,12 @@ export interface SqsInfo {
|
|
|
438
443
|
projectId: string;
|
|
439
444
|
/** Region of the service. */
|
|
440
445
|
region: Region;
|
|
441
|
-
/**
|
|
446
|
+
/** Queues creation date. */
|
|
442
447
|
createdAt?: Date;
|
|
443
|
-
/**
|
|
448
|
+
/** Queues last modification date. */
|
|
444
449
|
updatedAt?: Date;
|
|
445
|
-
/**
|
|
450
|
+
/** Queues activation status. */
|
|
446
451
|
status: SqsInfoStatus;
|
|
447
|
-
/** Endpoint of the
|
|
452
|
+
/** Endpoint of the Queues service for this region and project. */
|
|
448
453
|
sqsEndpointUrl: string;
|
|
449
454
|
}
|
|
@@ -650,7 +650,11 @@ export type CreateInstanceRequest = {
|
|
|
650
650
|
engine: string;
|
|
651
651
|
/** Username created when the Database Instance is created. */
|
|
652
652
|
userName: string;
|
|
653
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* Password of the user. Password must be between 8 and 128 characters,
|
|
655
|
+
* contain at least one digit, one uppercase, one lowercase and one special
|
|
656
|
+
* character.
|
|
657
|
+
*/
|
|
654
658
|
password: string;
|
|
655
659
|
/** Type of node to use for the Database Instance. */
|
|
656
660
|
nodeType: string;
|
|
@@ -729,7 +733,11 @@ export type CreateUserRequest = {
|
|
|
729
733
|
instanceId: string;
|
|
730
734
|
/** Name of the user you want to create. */
|
|
731
735
|
name: string;
|
|
732
|
-
/**
|
|
736
|
+
/**
|
|
737
|
+
* Password of the user you want to create. Password must be between 8 and 128
|
|
738
|
+
* characters, contain at least one digit, one uppercase, one lowercase and
|
|
739
|
+
* one special character.
|
|
740
|
+
*/
|
|
733
741
|
password: string;
|
|
734
742
|
/** Defines whether the user will have administrative privileges. */
|
|
735
743
|
isAdmin: boolean;
|
|
@@ -1344,7 +1352,11 @@ export type UpdateUserRequest = {
|
|
|
1344
1352
|
instanceId: string;
|
|
1345
1353
|
/** Name of the database user. */
|
|
1346
1354
|
name: string;
|
|
1347
|
-
/**
|
|
1355
|
+
/**
|
|
1356
|
+
* Password of the database user. Password must be between 8 and 128
|
|
1357
|
+
* characters, contain at least one digit, one uppercase, one lowercase and
|
|
1358
|
+
* one special character.
|
|
1359
|
+
*/
|
|
1348
1360
|
password?: string;
|
|
1349
1361
|
/** Defines whether or not this user got administrative privileges. */
|
|
1350
1362
|
isAdmin?: boolean;
|
|
@@ -11,7 +11,7 @@ export type ListWebhookEventsRequestOrderBy = 'created_at_desc' | 'created_at_as
|
|
|
11
11
|
export type ListWebhooksRequestOrderBy = 'created_at_desc' | 'created_at_asc';
|
|
12
12
|
export type ProjectSettingsPeriodicReportFrequency = 'unknown_frequency' | 'monthly' | 'weekly' | 'daily';
|
|
13
13
|
export type WebhookEventStatus = 'unknown_status' | 'sending' | 'sent' | 'failed';
|
|
14
|
-
export type WebhookEventType = 'unknown_type' | 'email_queued' | 'email_dropped' | 'email_deferred' | 'email_delivered' | 'email_spam' | 'email_mailbox_not_found';
|
|
14
|
+
export type WebhookEventType = 'unknown_type' | 'email_queued' | 'email_dropped' | 'email_deferred' | 'email_delivered' | 'email_spam' | 'email_mailbox_not_found' | 'email_blocklisted' | 'blocklist_created';
|
|
15
15
|
export interface DomainRecordsDMARC {
|
|
16
16
|
/** Name of the DMARC TXT record. */
|
|
17
17
|
name: string;
|
|
@@ -12,7 +12,7 @@ const jsonContentHeaders = {
|
|
|
12
12
|
};
|
|
13
13
|
class ControlPanelAPI extends api.API {
|
|
14
14
|
/** Lists the available regions of the API. */
|
|
15
|
-
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
15
|
+
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
16
16
|
pageOfListControlPanels = (request = {}) => this.client.fetch(
|
|
17
17
|
{
|
|
18
18
|
method: "GET",
|
|
@@ -236,6 +236,44 @@ class DatabaseAPI extends api.API {
|
|
|
236
236
|
marshalling_gen.unmarshalDatabaseUser
|
|
237
237
|
);
|
|
238
238
|
}
|
|
239
|
+
class DnsAPI extends api.API {
|
|
240
|
+
/** Lists the available regions of the API. */
|
|
241
|
+
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
242
|
+
/**
|
|
243
|
+
* Get DNS records. Get the set of DNS records of a specified domain
|
|
244
|
+
* associated with a Web Hosting plan's domain.
|
|
245
|
+
*
|
|
246
|
+
* @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
|
|
247
|
+
* @returns A Promise of DnsRecords
|
|
248
|
+
*/
|
|
249
|
+
getDomainDnsRecords = (request) => this.client.fetch(
|
|
250
|
+
{
|
|
251
|
+
method: "GET",
|
|
252
|
+
path: `/webhosting/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/dns-records`
|
|
253
|
+
},
|
|
254
|
+
marshalling_gen.unmarshalDnsRecords
|
|
255
|
+
);
|
|
256
|
+
/**
|
|
257
|
+
* "Check whether you own this domain or not.".
|
|
258
|
+
*
|
|
259
|
+
* @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
|
|
260
|
+
* @returns A Promise of CheckUserOwnsDomainResponse
|
|
261
|
+
*/
|
|
262
|
+
checkUserOwnsDomain = (request) => this.client.fetch(
|
|
263
|
+
{
|
|
264
|
+
body: JSON.stringify(
|
|
265
|
+
marshalling_gen.marshalDnsApiCheckUserOwnsDomainRequest(
|
|
266
|
+
request,
|
|
267
|
+
this.client.settings
|
|
268
|
+
)
|
|
269
|
+
),
|
|
270
|
+
headers: jsonContentHeaders,
|
|
271
|
+
method: "POST",
|
|
272
|
+
path: `/webhosting/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/check-ownership`
|
|
273
|
+
},
|
|
274
|
+
marshalling_gen.unmarshalCheckUserOwnsDomainResponse
|
|
275
|
+
);
|
|
276
|
+
}
|
|
239
277
|
class OfferAPI extends api.API {
|
|
240
278
|
/** Lists the available regions of the API. */
|
|
241
279
|
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
@@ -267,7 +305,7 @@ class OfferAPI extends api.API {
|
|
|
267
305
|
}
|
|
268
306
|
class HostingAPI extends api.API {
|
|
269
307
|
/** Lists the available regions of the API. */
|
|
270
|
-
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
308
|
+
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
271
309
|
/**
|
|
272
310
|
* Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
|
|
273
311
|
* type required via the `offer_id` parameter.
|
|
@@ -621,6 +659,7 @@ class WebsiteAPI extends api.API {
|
|
|
621
659
|
}
|
|
622
660
|
exports.ControlPanelAPI = ControlPanelAPI;
|
|
623
661
|
exports.DatabaseAPI = DatabaseAPI;
|
|
662
|
+
exports.DnsAPI = DnsAPI;
|
|
624
663
|
exports.FtpAccountAPI = FtpAccountAPI;
|
|
625
664
|
exports.HostingAPI = HostingAPI;
|
|
626
665
|
exports.MailAccountAPI = MailAccountAPI;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
2
|
import type { Region, WaitForOptions } from '../../../bridge';
|
|
3
|
-
import type { ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, ResetHostingPasswordResponse, ResourceSummary, Session, WebsiteApiListWebsitesRequest } from './types.gen';
|
|
3
|
+
import type { CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsRecords, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, ResetHostingPasswordResponse, ResourceSummary, Session, WebsiteApiListWebsitesRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
|
-
* Web Hosting API.
|
|
5
|
+
* Web Hosting Control Panel API.
|
|
6
6
|
*
|
|
7
7
|
* This API allows you to manage your Web Hosting services.
|
|
8
8
|
*/
|
|
@@ -117,6 +117,30 @@ export declare class DatabaseAPI extends ParentAPI {
|
|
|
117
117
|
*/
|
|
118
118
|
unassignDatabaseUser: (request: Readonly<DatabaseApiUnassignDatabaseUserRequest>) => Promise<DatabaseUser>;
|
|
119
119
|
}
|
|
120
|
+
/**
|
|
121
|
+
* Web Hosting Dns API.
|
|
122
|
+
*
|
|
123
|
+
* This API allows you to manage your Web Hosting services.
|
|
124
|
+
*/
|
|
125
|
+
export declare class DnsAPI extends ParentAPI {
|
|
126
|
+
/** Lists the available regions of the API. */
|
|
127
|
+
static readonly LOCALITIES: Region[];
|
|
128
|
+
/**
|
|
129
|
+
* Get DNS records. Get the set of DNS records of a specified domain
|
|
130
|
+
* associated with a Web Hosting plan's domain.
|
|
131
|
+
*
|
|
132
|
+
* @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
|
|
133
|
+
* @returns A Promise of DnsRecords
|
|
134
|
+
*/
|
|
135
|
+
getDomainDnsRecords: (request: Readonly<DnsApiGetDomainDnsRecordsRequest>) => Promise<DnsRecords>;
|
|
136
|
+
/**
|
|
137
|
+
* "Check whether you own this domain or not.".
|
|
138
|
+
*
|
|
139
|
+
* @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
|
|
140
|
+
* @returns A Promise of CheckUserOwnsDomainResponse
|
|
141
|
+
*/
|
|
142
|
+
checkUserOwnsDomain: (request: Readonly<DnsApiCheckUserOwnsDomainRequest>) => Promise<CheckUserOwnsDomainResponse>;
|
|
143
|
+
}
|
|
120
144
|
/**
|
|
121
145
|
* Web Hosting Offer API.
|
|
122
146
|
*
|
|
@@ -4,13 +4,13 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
|
|
|
4
4
|
import "../../../vendor/base64/index.js";
|
|
5
5
|
import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
|
|
6
6
|
import { HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
7
|
-
import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalListOffersResponse, marshalHostingApiCreateHostingRequest, unmarshalHosting, unmarshalListHostingsResponse, marshalHostingApiUpdateHostingRequest, unmarshalSession, unmarshalResetHostingPasswordResponse, unmarshalResourceSummary, marshalFtpAccountApiCreateFtpAccountRequest, unmarshalFtpAccount, unmarshalListFtpAccountsResponse, marshalFtpAccountApiChangeFtpAccountPasswordRequest, marshalMailAccountApiCreateMailAccountRequest, unmarshalMailAccount, unmarshalListMailAccountsResponse, marshalMailAccountApiRemoveMailAccountRequest, marshalMailAccountApiChangeMailAccountPasswordRequest, unmarshalListWebsitesResponse } from "./marshalling.gen.js";
|
|
7
|
+
import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalDnsRecords, marshalDnsApiCheckUserOwnsDomainRequest, unmarshalCheckUserOwnsDomainResponse, unmarshalListOffersResponse, marshalHostingApiCreateHostingRequest, unmarshalHosting, unmarshalListHostingsResponse, marshalHostingApiUpdateHostingRequest, unmarshalSession, unmarshalResetHostingPasswordResponse, unmarshalResourceSummary, marshalFtpAccountApiCreateFtpAccountRequest, unmarshalFtpAccount, unmarshalListFtpAccountsResponse, marshalFtpAccountApiChangeFtpAccountPasswordRequest, marshalMailAccountApiCreateMailAccountRequest, unmarshalMailAccount, unmarshalListMailAccountsResponse, marshalMailAccountApiRemoveMailAccountRequest, marshalMailAccountApiChangeMailAccountPasswordRequest, unmarshalListWebsitesResponse } from "./marshalling.gen.js";
|
|
8
8
|
const jsonContentHeaders = {
|
|
9
9
|
"Content-Type": "application/json; charset=utf-8"
|
|
10
10
|
};
|
|
11
11
|
class ControlPanelAPI extends API$1 {
|
|
12
12
|
/** Lists the available regions of the API. */
|
|
13
|
-
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
13
|
+
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
14
14
|
pageOfListControlPanels = (request = {}) => this.client.fetch(
|
|
15
15
|
{
|
|
16
16
|
method: "GET",
|
|
@@ -234,6 +234,44 @@ class DatabaseAPI extends API$1 {
|
|
|
234
234
|
unmarshalDatabaseUser
|
|
235
235
|
);
|
|
236
236
|
}
|
|
237
|
+
class DnsAPI extends API$1 {
|
|
238
|
+
/** Lists the available regions of the API. */
|
|
239
|
+
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
240
|
+
/**
|
|
241
|
+
* Get DNS records. Get the set of DNS records of a specified domain
|
|
242
|
+
* associated with a Web Hosting plan's domain.
|
|
243
|
+
*
|
|
244
|
+
* @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
|
|
245
|
+
* @returns A Promise of DnsRecords
|
|
246
|
+
*/
|
|
247
|
+
getDomainDnsRecords = (request) => this.client.fetch(
|
|
248
|
+
{
|
|
249
|
+
method: "GET",
|
|
250
|
+
path: `/webhosting/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam("domain", request.domain)}/dns-records`
|
|
251
|
+
},
|
|
252
|
+
unmarshalDnsRecords
|
|
253
|
+
);
|
|
254
|
+
/**
|
|
255
|
+
* "Check whether you own this domain or not.".
|
|
256
|
+
*
|
|
257
|
+
* @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
|
|
258
|
+
* @returns A Promise of CheckUserOwnsDomainResponse
|
|
259
|
+
*/
|
|
260
|
+
checkUserOwnsDomain = (request) => this.client.fetch(
|
|
261
|
+
{
|
|
262
|
+
body: JSON.stringify(
|
|
263
|
+
marshalDnsApiCheckUserOwnsDomainRequest(
|
|
264
|
+
request,
|
|
265
|
+
this.client.settings
|
|
266
|
+
)
|
|
267
|
+
),
|
|
268
|
+
headers: jsonContentHeaders,
|
|
269
|
+
method: "POST",
|
|
270
|
+
path: `/webhosting/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam("domain", request.domain)}/check-ownership`
|
|
271
|
+
},
|
|
272
|
+
unmarshalCheckUserOwnsDomainResponse
|
|
273
|
+
);
|
|
274
|
+
}
|
|
237
275
|
class OfferAPI extends API$1 {
|
|
238
276
|
/** Lists the available regions of the API. */
|
|
239
277
|
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
@@ -265,7 +303,7 @@ class OfferAPI extends API$1 {
|
|
|
265
303
|
}
|
|
266
304
|
class HostingAPI extends API$1 {
|
|
267
305
|
/** Lists the available regions of the API. */
|
|
268
|
-
static LOCALITIES = ["fr-par", "nl-ams"];
|
|
306
|
+
static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
|
|
269
307
|
/**
|
|
270
308
|
* Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
|
|
271
309
|
* type required via the `offer_id` parameter.
|
|
@@ -620,6 +658,7 @@ class WebsiteAPI extends API$1 {
|
|
|
620
658
|
export {
|
|
621
659
|
ControlPanelAPI,
|
|
622
660
|
DatabaseAPI,
|
|
661
|
+
DnsAPI,
|
|
623
662
|
FtpAccountAPI,
|
|
624
663
|
HostingAPI,
|
|
625
664
|
MailAccountAPI,
|
|
@@ -5,6 +5,7 @@ const content_gen = require("./content.gen.cjs");
|
|
|
5
5
|
const validationRules_gen = require("./validation-rules.gen.cjs");
|
|
6
6
|
exports.ControlPanelAPI = api_gen.ControlPanelAPI;
|
|
7
7
|
exports.DatabaseAPI = api_gen.DatabaseAPI;
|
|
8
|
+
exports.DnsAPI = api_gen.DnsAPI;
|
|
8
9
|
exports.FtpAccountAPI = api_gen.FtpAccountAPI;
|
|
9
10
|
exports.HostingAPI = api_gen.HostingAPI;
|
|
10
11
|
exports.MailAccountAPI = api_gen.MailAccountAPI;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { ControlPanelAPI, DatabaseAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI, } from './api.gen';
|
|
1
|
+
export { ControlPanelAPI, DatabaseAPI, DnsAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI, } from './api.gen';
|
|
2
2
|
export * from './content.gen';
|
|
3
|
-
export type { ControlPanel, ControlPanelApiListControlPanelsRequest, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest,
|
|
3
|
+
export type { CheckUserOwnsDomainResponse, ControlPanel, ControlPanelApiListControlPanelsRequest, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsRecord, DnsRecordStatus, DnsRecordType, DnsRecords, DnsRecordsStatus, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingStatus, HostingSummary, HostingSummaryStatus, HostingUser, ListControlPanelsResponse, ListDatabaseUsersRequestOrderBy, ListDatabaseUsersResponse, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListFtpAccountsRequestOrderBy, ListFtpAccountsResponse, ListHostingsRequestOrderBy, ListHostingsResponse, ListMailAccountsRequestOrderBy, ListMailAccountsResponse, ListOffersRequestOrderBy, ListOffersResponse, ListWebsitesRequestOrderBy, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, Nameserver, NameserverStatus, Offer, OfferApiListOffersRequest, OfferOption, OfferOptionName, OfferOptionRequest, OfferOptionWarning, Platform, PlatformControlPanel, PlatformControlPanelUrls, PlatformPlatformGroup, ResetHostingPasswordResponse, ResourceSummary, Session, Website, WebsiteApiListWebsitesRequest, } from './types.gen';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
import { ControlPanelAPI, DatabaseAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI } from "./api.gen.js";
|
|
1
|
+
import { ControlPanelAPI, DatabaseAPI, DnsAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI } from "./api.gen.js";
|
|
2
2
|
import { HOSTING_SUMMARY_TRANSIENT_STATUSES, HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
3
3
|
import * as validationRules_gen from "./validation-rules.gen.js";
|
|
4
4
|
export {
|
|
5
5
|
ControlPanelAPI,
|
|
6
6
|
DatabaseAPI,
|
|
7
|
+
DnsAPI,
|
|
7
8
|
FtpAccountAPI,
|
|
8
9
|
HOSTING_SUMMARY_TRANSIENT_STATUSES,
|
|
9
10
|
HOSTING_TRANSIENT_STATUSES,
|