@scaleway/sdk 2.66.0 → 2.68.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.
Files changed (131) hide show
  1. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +5 -1
  2. package/dist/api/audit_trail/v1alpha1/api.gen.js +5 -1
  3. package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +1 -0
  4. package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +1 -0
  5. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +6 -2
  6. package/dist/api/baremetal/v1/api.gen.cjs +13 -0
  7. package/dist/api/baremetal/v1/api.gen.d.ts +8 -1
  8. package/dist/api/baremetal/v1/api.gen.js +13 -0
  9. package/dist/api/baremetal/v1/content.gen.cjs +2 -1
  10. package/dist/api/baremetal/v1/content.gen.js +2 -1
  11. package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
  12. package/dist/api/baremetal/v1/marshalling.gen.cjs +1 -0
  13. package/dist/api/baremetal/v1/marshalling.gen.js +1 -0
  14. package/dist/api/baremetal/v1/types.gen.d.ts +9 -1
  15. package/dist/api/block/index.gen.cjs +4 -2
  16. package/dist/api/block/index.gen.d.ts +1 -0
  17. package/dist/api/block/index.gen.js +4 -2
  18. package/dist/api/block/v1/api.gen.cjs +303 -0
  19. package/dist/api/block/v1/api.gen.d.ts +152 -0
  20. package/dist/api/block/v1/api.gen.js +303 -0
  21. package/dist/api/block/v1/content.gen.cjs +22 -0
  22. package/dist/api/block/v1/content.gen.d.ts +7 -0
  23. package/dist/api/block/v1/content.gen.js +22 -0
  24. package/dist/api/block/v1/index.gen.cjs +10 -0
  25. package/dist/api/block/v1/index.gen.d.ts +4 -0
  26. package/dist/api/block/v1/index.gen.js +10 -0
  27. package/dist/api/block/v1/marshalling.gen.cjs +200 -0
  28. package/dist/api/block/v1/marshalling.gen.d.ts +14 -0
  29. package/dist/api/block/v1/marshalling.gen.js +200 -0
  30. package/dist/api/block/v1/types.gen.d.ts +335 -0
  31. package/dist/api/block/v1/validation-rules.gen.cjs +56 -0
  32. package/dist/api/block/v1/validation-rules.gen.d.ts +47 -0
  33. package/dist/api/block/v1/validation-rules.gen.js +56 -0
  34. package/dist/api/block/v1alpha1/api.gen.cjs +1 -0
  35. package/dist/api/block/v1alpha1/api.gen.js +1 -0
  36. package/dist/api/block/v1alpha1/types.gen.d.ts +5 -0
  37. package/dist/api/cockpit/v1/api.gen.cjs +14 -17
  38. package/dist/api/cockpit/v1/api.gen.d.ts +6 -9
  39. package/dist/api/cockpit/v1/api.gen.js +15 -18
  40. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  41. package/dist/api/cockpit/v1/marshalling.gen.cjs +29 -26
  42. package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -2
  43. package/dist/api/cockpit/v1/marshalling.gen.js +29 -26
  44. package/dist/api/cockpit/v1/types.gen.d.ts +49 -34
  45. package/dist/api/cockpit/v1/validation-rules.gen.cjs +0 -10
  46. package/dist/api/cockpit/v1/validation-rules.gen.d.ts +0 -9
  47. package/dist/api/cockpit/v1/validation-rules.gen.js +0 -10
  48. package/dist/api/edge_services/index.gen.cjs +2 -0
  49. package/dist/api/edge_services/index.gen.d.ts +1 -0
  50. package/dist/api/edge_services/index.gen.js +3 -1
  51. package/dist/api/edge_services/v1beta1/api.gen.cjs +941 -0
  52. package/dist/api/edge_services/v1beta1/api.gen.d.ts +454 -0
  53. package/dist/api/edge_services/v1beta1/api.gen.js +941 -0
  54. package/dist/api/edge_services/v1beta1/content.gen.cjs +8 -0
  55. package/dist/api/edge_services/v1beta1/content.gen.d.ts +5 -0
  56. package/dist/api/edge_services/v1beta1/content.gen.js +8 -0
  57. package/dist/api/{webhosting/v1alpha1 → edge_services/v1beta1}/index.gen.cjs +2 -2
  58. package/dist/api/edge_services/v1beta1/index.gen.d.ts +4 -0
  59. package/dist/api/edge_services/v1beta1/index.gen.js +9 -0
  60. package/dist/api/edge_services/v1beta1/marshalling.gen.cjs +808 -0
  61. package/dist/api/edge_services/v1beta1/marshalling.gen.d.ts +53 -0
  62. package/dist/api/edge_services/v1beta1/marshalling.gen.js +808 -0
  63. package/dist/api/edge_services/v1beta1/types.gen.d.ts +1218 -0
  64. package/dist/api/edge_services/v1beta1/validation-rules.gen.cjs +23 -0
  65. package/dist/api/edge_services/v1beta1/validation-rules.gen.d.ts +18 -0
  66. package/dist/api/edge_services/v1beta1/validation-rules.gen.js +23 -0
  67. package/dist/api/instance/v1/api.gen.cjs +18 -0
  68. package/dist/api/instance/v1/api.gen.d.ts +13 -1
  69. package/dist/api/instance/v1/api.gen.js +19 -1
  70. package/dist/api/instance/v1/index.gen.d.ts +1 -1
  71. package/dist/api/instance/v1/marshalling.gen.cjs +12 -0
  72. package/dist/api/instance/v1/marshalling.gen.d.ts +2 -1
  73. package/dist/api/instance/v1/marshalling.gen.js +12 -0
  74. package/dist/api/instance/v1/types.gen.d.ts +12 -0
  75. package/dist/api/lb/v1/marshalling.gen.cjs +7 -0
  76. package/dist/api/lb/v1/marshalling.gen.js +7 -0
  77. package/dist/api/lb/v1/types.gen.d.ts +27 -0
  78. package/dist/api/mongodb/v1alpha1/api.gen.cjs +11 -0
  79. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +2 -1
  80. package/dist/api/mongodb/v1alpha1/api.gen.js +12 -1
  81. package/dist/api/mongodb/v1alpha1/index.gen.d.ts +1 -1
  82. package/dist/api/mongodb/v1alpha1/marshalling.gen.cjs +26 -1
  83. package/dist/api/mongodb/v1alpha1/marshalling.gen.d.ts +2 -1
  84. package/dist/api/mongodb/v1alpha1/marshalling.gen.js +26 -1
  85. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +29 -0
  86. package/dist/api/mongodb/v1alpha1/validation-rules.gen.cjs +8 -0
  87. package/dist/api/mongodb/v1alpha1/validation-rules.gen.d.ts +7 -0
  88. package/dist/api/mongodb/v1alpha1/validation-rules.gen.js +8 -0
  89. package/dist/api/secret/v1beta1/api.gen.cjs +33 -0
  90. package/dist/api/secret/v1beta1/api.gen.d.ts +17 -1
  91. package/dist/api/secret/v1beta1/api.gen.js +33 -0
  92. package/dist/api/secret/v1beta1/index.gen.d.ts +1 -1
  93. package/dist/api/secret/v1beta1/marshalling.gen.cjs +2 -0
  94. package/dist/api/secret/v1beta1/marshalling.gen.js +2 -0
  95. package/dist/api/secret/v1beta1/types.gen.d.ts +30 -3
  96. package/dist/api/vpcgw/v1/api.gen.cjs +6 -0
  97. package/dist/api/vpcgw/v1/api.gen.d.ts +2 -1
  98. package/dist/api/vpcgw/v1/api.gen.js +6 -0
  99. package/dist/api/vpcgw/v1/index.gen.d.ts +1 -1
  100. package/dist/api/vpcgw/v1/types.gen.d.ts +5 -0
  101. package/dist/api/webhosting/index.gen.cjs +0 -2
  102. package/dist/api/webhosting/index.gen.d.ts +0 -1
  103. package/dist/api/webhosting/index.gen.js +1 -3
  104. package/dist/api/webhosting/v1/content.gen.cjs +0 -6
  105. package/dist/api/webhosting/v1/content.gen.d.ts +1 -3
  106. package/dist/api/webhosting/v1/content.gen.js +0 -6
  107. package/dist/api/webhosting/v1/index.gen.cjs +0 -1
  108. package/dist/api/webhosting/v1/index.gen.d.ts +1 -1
  109. package/dist/api/webhosting/v1/index.gen.js +1 -2
  110. package/dist/api/webhosting/v1/marshalling.gen.cjs +5 -2
  111. package/dist/api/webhosting/v1/marshalling.gen.js +5 -2
  112. package/dist/api/webhosting/v1/types.gen.d.ts +12 -7
  113. package/dist/scw/constants.cjs +1 -1
  114. package/dist/scw/constants.d.ts +2 -2
  115. package/dist/scw/constants.js +1 -1
  116. package/package.json +2 -2
  117. package/dist/api/webhosting/v1alpha1/api.gen.cjs +0 -339
  118. package/dist/api/webhosting/v1alpha1/api.gen.d.ts +0 -168
  119. package/dist/api/webhosting/v1alpha1/api.gen.js +0 -339
  120. package/dist/api/webhosting/v1alpha1/content.gen.cjs +0 -8
  121. package/dist/api/webhosting/v1alpha1/content.gen.d.ts +0 -3
  122. package/dist/api/webhosting/v1alpha1/content.gen.js +0 -8
  123. package/dist/api/webhosting/v1alpha1/index.gen.d.ts +0 -4
  124. package/dist/api/webhosting/v1alpha1/index.gen.js +0 -9
  125. package/dist/api/webhosting/v1alpha1/marshalling.gen.cjs +0 -300
  126. package/dist/api/webhosting/v1alpha1/marshalling.gen.d.ts +0 -17
  127. package/dist/api/webhosting/v1alpha1/marshalling.gen.js +0 -300
  128. package/dist/api/webhosting/v1alpha1/types.gen.d.ts +0 -480
  129. package/dist/api/webhosting/v1alpha1/validation-rules.gen.cjs +0 -32
  130. package/dist/api/webhosting/v1alpha1/validation-rules.gen.d.ts +0 -27
  131. package/dist/api/webhosting/v1alpha1/validation-rules.gen.js +0 -32
@@ -90,6 +90,7 @@ const unmarshalDnsRecords = (data) => {
90
90
  );
91
91
  }
92
92
  return {
93
+ dnsConfig: data.dns_config,
93
94
  nameServers: unmarshalArrayOfObject(data.name_servers, unmarshalNameserver),
94
95
  records: unmarshalArrayOfObject(data.records, unmarshalDnsRecord),
95
96
  status: data.status
@@ -201,8 +202,9 @@ const unmarshalHosting = (data) => {
201
202
  }
202
203
  return {
203
204
  createdAt: unmarshalDate(data.created_at),
204
- dnsStatus: data.dns_status,
205
+ dnsStatus: data.dns_status ? data.dns_status : void 0,
205
206
  domain: data.domain,
207
+ domainStatus: data.domain_status,
206
208
  id: data.id,
207
209
  ipv4: data.ipv4,
208
210
  offer: data.offer ? unmarshalOffer(data.offer) : void 0,
@@ -284,8 +286,9 @@ const unmarshalHostingSummary = (data) => {
284
286
  }
285
287
  return {
286
288
  createdAt: unmarshalDate(data.created_at),
287
- dnsStatus: data.dns_status,
289
+ dnsStatus: data.dns_status ? data.dns_status : void 0,
288
290
  domain: data.domain,
291
+ domainStatus: data.domain_status,
289
292
  id: data.id,
290
293
  offerName: data.offer_name,
291
294
  projectId: data.project_id,
@@ -6,11 +6,10 @@ export type DnsRecordsStatus = 'unknown_status' | 'valid' | 'invalid';
6
6
  export type DomainAction = 'unknown_action' | 'transfer' | 'manage_external' | 'renew';
7
7
  export type DomainAvailabilityAction = 'unknown_action' | 'register' | 'transfer' | 'manage_external';
8
8
  export type DomainAvailabilityStatus = 'unknown_status' | 'available' | 'not_available' | 'owned' | 'validating' | 'error';
9
- export type DomainDnsAction = 'unknown_dns_action' | 'auto_config_all_records' | 'auto_config_web_records' | 'auto_config_mail_records' | 'auto_config_nameservers';
9
+ export type DomainDnsAction = 'unknown_dns_action' | 'auto_config_all_records' | 'auto_config_web_records' | 'auto_config_mail_records' | 'auto_config_nameservers' | 'auto_config_none';
10
10
  export type DomainStatus = 'unknown_status' | 'valid' | 'invalid' | 'validating' | 'error';
11
11
  export type DomainZoneOwner = 'unknown_zone_owner' | 'external' | 'scaleway' | 'online' | 'webhosting';
12
12
  export type HostingStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
13
- export type HostingSummaryStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
14
13
  export type ListDatabaseUsersRequestOrderBy = 'username_asc' | 'username_desc';
15
14
  export type ListDatabasesRequestOrderBy = 'database_name_asc' | 'database_name_desc';
16
15
  export type ListFtpAccountsRequestOrderBy = 'username_asc' | 'username_desc';
@@ -191,15 +190,17 @@ export interface HostingSummary {
191
190
  /** Date on which the Web Hosting plan was last updated. */
192
191
  updatedAt?: Date;
193
192
  /** Status of the Web Hosting plan. */
194
- status: HostingSummaryStatus;
193
+ status: HostingStatus;
195
194
  /** Main domain associated with the Web Hosting plan. */
196
195
  domain: string;
197
196
  /** Whether the hosting is protected or not. */
198
197
  protected: boolean;
199
- /** DNS status of the Web Hosting plan. */
200
- dnsStatus: DnsRecordsStatus;
198
+ /** @deprecated DNS status of the Web Hosting plan. */
199
+ dnsStatus?: DnsRecordsStatus;
201
200
  /** Name of the active offer for the Web Hosting plan. */
202
201
  offerName: string;
202
+ /** Main domain status of the Web Hosting plan. */
203
+ domainStatus: DomainStatus;
203
204
  /** Region where the Web Hosting plan is hosted. */
204
205
  region: ScwRegion;
205
206
  }
@@ -478,6 +479,8 @@ export interface DnsRecords {
478
479
  nameServers: Nameserver[];
479
480
  /** Status of the records. */
480
481
  status: DnsRecordsStatus;
482
+ /** Records dns auto configuration settings. */
483
+ dnsConfig: DomainDnsAction[];
481
484
  }
482
485
  export interface Domain {
483
486
  /** Name of the domain. */
@@ -569,14 +572,16 @@ export interface Hosting {
569
572
  platform?: Platform;
570
573
  /** List of tags associated with the Web Hosting plan. */
571
574
  tags: string[];
572
- /** DNS status of the Web Hosting plan. */
573
- dnsStatus: DnsRecordsStatus;
575
+ /** @deprecated DNS status of the Web Hosting plan. */
576
+ dnsStatus?: DnsRecordsStatus;
574
577
  /** Current IPv4 address of the hosting. */
575
578
  ipv4: string;
576
579
  /** Whether the hosting is protected or not. */
577
580
  protected: boolean;
578
581
  /** Details of the hosting user. */
579
582
  user?: HostingUser;
583
+ /** Main domain status of the Web Hosting plan. */
584
+ domainStatus: DomainStatus;
580
585
  /** Region where the Web Hosting plan is hosted. */
581
586
  region: ScwRegion;
582
587
  }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const version = "v2.65.0";
3
+ const version = "v2.67.0";
4
4
  const userAgent = `scaleway-sdk-js/${version}`;
5
5
  exports.userAgent = userAgent;
6
6
  exports.version = version;
@@ -1,2 +1,2 @@
1
- export declare const version = "v2.65.0";
2
- export declare const userAgent = "scaleway-sdk-js/v2.65.0";
1
+ export declare const version = "v2.67.0";
2
+ export declare const userAgent = "scaleway-sdk-js/v2.67.0";
@@ -1,4 +1,4 @@
1
- const version = "v2.65.0";
1
+ const version = "v2.67.0";
2
2
  const userAgent = `scaleway-sdk-js/${version}`;
3
3
  export {
4
4
  userAgent,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk",
3
- "version": "2.66.0",
3
+ "version": "2.68.0",
4
4
  "license": "Apache-2.0",
5
5
  "description": "Scaleway SDK.",
6
6
  "keywords": [
@@ -39,5 +39,5 @@
39
39
  "bundledDependencies": [
40
40
  "@scaleway/random-name"
41
41
  ],
42
- "gitHead": "2fa209a59b671b24c1bcaf5af66aff8b247eccb0"
42
+ "gitHead": "f772f3f49c9d00453fb7bf7207d49198658963a9"
43
43
  }
@@ -1,339 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
4
- const api = require("../../../scw/api.cjs");
5
- const marshalling = require("../../../helpers/marshalling.cjs");
6
- require("../../../vendor/base64/index.cjs");
7
- const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
8
- const content_gen = require("./content.gen.cjs");
9
- const marshalling_gen = require("./marshalling.gen.cjs");
10
- const jsonContentHeaders = {
11
- "Content-Type": "application/json; charset=utf-8"
12
- };
13
- class API extends api.API {
14
- /** Lists the available regions of the API. */
15
- static LOCALITIES = ["fr-par", "nl-ams"];
16
- /**
17
- * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
18
- * type required via the `offer_id` parameter.
19
- *
20
- * @param request - The request {@link CreateHostingRequest}
21
- * @returns A Promise of Hosting
22
- */
23
- createHosting = (request) => this.client.fetch(
24
- {
25
- body: JSON.stringify(
26
- marshalling_gen.marshalCreateHostingRequest(request, this.client.settings)
27
- ),
28
- headers: jsonContentHeaders,
29
- method: "POST",
30
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings`
31
- },
32
- marshalling_gen.unmarshalHosting
33
- );
34
- pageOfListHostings = (request = {}) => this.client.fetch(
35
- {
36
- method: "GET",
37
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings`,
38
- urlParams: marshalling.urlParams(
39
- ["control_panels", request.controlPanels],
40
- ["domain", request.domain],
41
- ["order_by", request.orderBy],
42
- ["organization_id", request.organizationId],
43
- ["page", request.page],
44
- [
45
- "page_size",
46
- request.pageSize ?? this.client.settings.defaultPageSize
47
- ],
48
- ["project_id", request.projectId],
49
- ["statuses", request.statuses],
50
- ["tags", request.tags]
51
- )
52
- },
53
- marshalling_gen.unmarshalListHostingsResponse
54
- );
55
- /**
56
- * List all Web Hosting plans. List all of your existing Web Hosting plans.
57
- * Various filters are available to limit the results, including filtering by
58
- * domain, status, tag and Project ID.
59
- *
60
- * @param request - The request {@link ListHostingsRequest}
61
- * @returns A Promise of ListHostingsResponse
62
- */
63
- listHostings = (request = {}) => resourcePaginator.enrichForPagination("hostings", this.pageOfListHostings, request);
64
- /**
65
- * Get a Web Hosting plan. Get the details of one of your existing Web Hosting
66
- * plans, specified by its `hosting_id`.
67
- *
68
- * @param request - The request {@link GetHostingRequest}
69
- * @returns A Promise of Hosting
70
- */
71
- getHosting = (request) => this.client.fetch(
72
- {
73
- method: "GET",
74
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${marshalling.validatePathParam("hostingId", request.hostingId)}`
75
- },
76
- marshalling_gen.unmarshalHosting
77
- );
78
- /**
79
- * Waits for {@link Hosting} to be in a final state.
80
- *
81
- * @param request - The request {@link GetHostingRequest}
82
- * @param options - The waiting options
83
- * @returns A Promise of Hosting
84
- */
85
- waitForHosting = (request, options) => intervalRetrier.waitForResource(
86
- options?.stop ?? ((res) => Promise.resolve(!content_gen.HOSTING_TRANSIENT_STATUSES.includes(res.status))),
87
- this.getHosting,
88
- request,
89
- options
90
- );
91
- /**
92
- * Update a Web Hosting plan. Update the details of one of your existing Web
93
- * Hosting plans, specified by its `hosting_id`. You can update parameters
94
- * including the contact email address, tags, options and offer.
95
- *
96
- * @param request - The request {@link UpdateHostingRequest}
97
- * @returns A Promise of Hosting
98
- */
99
- updateHosting = (request) => this.client.fetch(
100
- {
101
- body: JSON.stringify(
102
- marshalling_gen.marshalUpdateHostingRequest(request, this.client.settings)
103
- ),
104
- headers: jsonContentHeaders,
105
- method: "PATCH",
106
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${marshalling.validatePathParam("hostingId", request.hostingId)}`
107
- },
108
- marshalling_gen.unmarshalHosting
109
- );
110
- /**
111
- * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its
112
- * `hosting_id`. Note that deletion is not immediate: it will take place at
113
- * the end of the calendar month, after which time your Web Hosting plan and
114
- * all its data (files and emails) will be irreversibly lost.
115
- *
116
- * @param request - The request {@link DeleteHostingRequest}
117
- * @returns A Promise of Hosting
118
- */
119
- deleteHosting = (request) => this.client.fetch(
120
- {
121
- method: "DELETE",
122
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${marshalling.validatePathParam("hostingId", request.hostingId)}`
123
- },
124
- marshalling_gen.unmarshalHosting
125
- );
126
- /**
127
- * Restore a Web Hosting plan. When you [delete a Web Hosting
128
- * plan](#path-hostings-delete-a-hosting), definitive deletion does not take
129
- * place until the end of the calendar month. In the time between initiating
130
- * the deletion, and definitive deletion at the end of the month, you can
131
- * choose to **restore** the Web Hosting plan, using this endpoint and
132
- * specifying its `hosting_id`.
133
- *
134
- * @param request - The request {@link RestoreHostingRequest}
135
- * @returns A Promise of Hosting
136
- */
137
- restoreHosting = (request) => this.client.fetch(
138
- {
139
- body: "{}",
140
- headers: jsonContentHeaders,
141
- method: "POST",
142
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${marshalling.validatePathParam("hostingId", request.hostingId)}/restore`
143
- },
144
- marshalling_gen.unmarshalHosting
145
- );
146
- /**
147
- * Get DNS records. Get the set of DNS records of a specified domain
148
- * associated with a Web Hosting plan.
149
- *
150
- * @param request - The request {@link GetDomainDnsRecordsRequest}
151
- * @returns A Promise of DnsRecords
152
- */
153
- getDomainDnsRecords = (request) => this.client.fetch(
154
- {
155
- method: "GET",
156
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/dns-records`
157
- },
158
- marshalling_gen.unmarshalDnsRecords
159
- );
160
- /**
161
- * "Check whether you own this domain or not.".
162
- *
163
- * @param request - The request {@link CheckUserOwnsDomainRequest}
164
- * @returns A Promise of CheckUserOwnsDomainResponse
165
- */
166
- checkUserOwnsDomain = (request) => this.client.fetch(
167
- {
168
- body: JSON.stringify(
169
- marshalling_gen.marshalCheckUserOwnsDomainRequest(request, this.client.settings)
170
- ),
171
- headers: jsonContentHeaders,
172
- method: "POST",
173
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/check-ownership`
174
- },
175
- marshalling_gen.unmarshalCheckUserOwnsDomainResponse
176
- );
177
- /**
178
- * List all offers. List the different Web Hosting offers, and their options,
179
- * available to order from Scaleway.
180
- *
181
- * @param request - The request {@link ListOffersRequest}
182
- * @returns A Promise of ListOffersResponse
183
- */
184
- listOffers = (request) => this.client.fetch(
185
- {
186
- method: "GET",
187
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/offers`,
188
- urlParams: marshalling.urlParams(
189
- ["control_panels", request.controlPanels],
190
- ["hosting_id", request.hostingId],
191
- ["only_options", request.onlyOptions],
192
- ["order_by", request.orderBy],
193
- ["without_options", request.withoutOptions]
194
- )
195
- },
196
- marshalling_gen.unmarshalListOffersResponse
197
- );
198
- pageOfListControlPanels = (request = {}) => this.client.fetch(
199
- {
200
- method: "GET",
201
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/control-panels`,
202
- urlParams: marshalling.urlParams(
203
- ["page", request.page],
204
- [
205
- "page_size",
206
- request.pageSize ?? this.client.settings.defaultPageSize
207
- ]
208
- )
209
- },
210
- marshalling_gen.unmarshalListControlPanelsResponse
211
- );
212
- /**
213
- * "List the control panels type: cpanel or plesk.".
214
- *
215
- * @param request - The request {@link ListControlPanelsRequest}
216
- * @returns A Promise of ListControlPanelsResponse
217
- */
218
- listControlPanels = (request = {}) => resourcePaginator.enrichForPagination("controlPanels", this.pageOfListControlPanels, request);
219
- /**
220
- * Create a user session.
221
- *
222
- * @param request - The request {@link CreateSessionRequest}
223
- * @returns A Promise of Session
224
- */
225
- createSession = (request) => this.client.fetch(
226
- {
227
- body: "{}",
228
- headers: jsonContentHeaders,
229
- method: "POST",
230
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${marshalling.validatePathParam("hostingId", request.hostingId)}/sessions`
231
- },
232
- marshalling_gen.unmarshalSession
233
- );
234
- resetHostingPassword = (request) => this.client.fetch(
235
- {
236
- body: "{}",
237
- headers: jsonContentHeaders,
238
- method: "POST",
239
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${marshalling.validatePathParam("hostingId", request.hostingId)}/reset-password`
240
- },
241
- marshalling_gen.unmarshalResetHostingPasswordResponse
242
- );
243
- }
244
- class ClassicMailAPI extends api.API {
245
- /** Lists the available regions of the API. */
246
- static LOCALITIES = [
247
- "fr-par",
248
- "nl-ams",
249
- "pl-waw"
250
- ];
251
- /**
252
- * Create a new mailbox within your hosting plan.. Create a new mailbox within
253
- * your hosting plan.
254
- *
255
- * @param request - The request {@link ClassicMailApiCreateMailboxRequest}
256
- * @returns A Promise of Mailbox
257
- */
258
- createMailbox = (request) => this.client.fetch(
259
- {
260
- body: JSON.stringify(
261
- marshalling_gen.marshalClassicMailApiCreateMailboxRequest(
262
- request,
263
- this.client.settings
264
- )
265
- ),
266
- headers: jsonContentHeaders,
267
- method: "POST",
268
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes`
269
- },
270
- marshalling_gen.unmarshalMailbox
271
- );
272
- /**
273
- * Get a mailbox by id within your hosting plan.. Get a mailbox by id within
274
- * your hosting plan.
275
- *
276
- * @param request - The request {@link ClassicMailApiGetMailboxRequest}
277
- * @returns A Promise of Mailbox
278
- */
279
- getMailbox = (request) => this.client.fetch(
280
- {
281
- method: "GET",
282
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes/${marshalling.validatePathParam("mailboxId", request.mailboxId)}`
283
- },
284
- marshalling_gen.unmarshalMailbox
285
- );
286
- pageOfListMailboxes = (request) => this.client.fetch(
287
- {
288
- method: "GET",
289
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes`,
290
- urlParams: marshalling.urlParams(
291
- ["domain", request.domain],
292
- ["page", request.page],
293
- [
294
- "page_size",
295
- request.pageSize ?? this.client.settings.defaultPageSize
296
- ]
297
- )
298
- },
299
- marshalling_gen.unmarshalListMailboxesResponse
300
- );
301
- /**
302
- * List all mailboxes within your hosting plan.. List all mailboxes within
303
- * your hosting plan.
304
- *
305
- * @param request - The request {@link ClassicMailApiListMailboxesRequest}
306
- * @returns A Promise of ListMailboxesResponse
307
- */
308
- listMailboxes = (request) => resourcePaginator.enrichForPagination("mailboxes", this.pageOfListMailboxes, request);
309
- deleteMailbox = (request) => this.client.fetch(
310
- {
311
- method: "DELETE",
312
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes/${marshalling.validatePathParam("mailboxId", request.mailboxId)}`
313
- },
314
- marshalling_gen.unmarshalMailbox
315
- );
316
- /**
317
- * Update the mailbox within your hosting plan.. Update the mailbox within
318
- * your hosting plan.
319
- *
320
- * @param request - The request {@link ClassicMailApiUpdateMailboxRequest}
321
- * @returns A Promise of Mailbox
322
- */
323
- updateMailbox = (request) => this.client.fetch(
324
- {
325
- body: JSON.stringify(
326
- marshalling_gen.marshalClassicMailApiUpdateMailboxRequest(
327
- request,
328
- this.client.settings
329
- )
330
- ),
331
- headers: jsonContentHeaders,
332
- method: "PATCH",
333
- path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes/${marshalling.validatePathParam("mailboxId", request.mailboxId)}`
334
- },
335
- marshalling_gen.unmarshalMailbox
336
- );
337
- }
338
- exports.API = API;
339
- exports.ClassicMailAPI = ClassicMailAPI;
@@ -1,168 +0,0 @@
1
- import { API as ParentAPI } from '../../../bridge';
2
- import type { Region as ScwRegion, WaitForOptions } from '../../../bridge';
3
- import type { CheckUserOwnsDomainRequest, CheckUserOwnsDomainResponse, ClassicMailApiCreateMailboxRequest, ClassicMailApiDeleteMailboxRequest, ClassicMailApiGetMailboxRequest, ClassicMailApiListMailboxesRequest, ClassicMailApiUpdateMailboxRequest, CreateHostingRequest, CreateSessionRequest, DeleteHostingRequest, DnsRecords, GetDomainDnsRecordsRequest, GetHostingRequest, Hosting, ListControlPanelsRequest, ListControlPanelsResponse, ListHostingsRequest, ListHostingsResponse, ListMailboxesResponse, ListOffersRequest, ListOffersResponse, Mailbox, ResetHostingPasswordRequest, ResetHostingPasswordResponse, RestoreHostingRequest, Session, UpdateHostingRequest } from './types.gen';
4
- /**
5
- * Web Hosting API.
6
- *
7
- * This API allows you to manage your Web Hosting services.
8
- */
9
- export declare class API extends ParentAPI {
10
- /** Lists the available regions of the API. */
11
- static readonly LOCALITIES: ScwRegion[];
12
- /**
13
- * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
14
- * type required via the `offer_id` parameter.
15
- *
16
- * @param request - The request {@link CreateHostingRequest}
17
- * @returns A Promise of Hosting
18
- */
19
- createHosting: (request: Readonly<CreateHostingRequest>) => Promise<Hosting>;
20
- protected pageOfListHostings: (request?: Readonly<ListHostingsRequest>) => Promise<ListHostingsResponse>;
21
- /**
22
- * List all Web Hosting plans. List all of your existing Web Hosting plans.
23
- * Various filters are available to limit the results, including filtering by
24
- * domain, status, tag and Project ID.
25
- *
26
- * @param request - The request {@link ListHostingsRequest}
27
- * @returns A Promise of ListHostingsResponse
28
- */
29
- listHostings: (request?: Readonly<ListHostingsRequest>) => Promise<ListHostingsResponse> & {
30
- all: () => Promise<Hosting[]>;
31
- [Symbol.asyncIterator]: () => AsyncGenerator<Hosting[], void, void>;
32
- };
33
- /**
34
- * Get a Web Hosting plan. Get the details of one of your existing Web Hosting
35
- * plans, specified by its `hosting_id`.
36
- *
37
- * @param request - The request {@link GetHostingRequest}
38
- * @returns A Promise of Hosting
39
- */
40
- getHosting: (request: Readonly<GetHostingRequest>) => Promise<Hosting>;
41
- /**
42
- * Waits for {@link Hosting} to be in a final state.
43
- *
44
- * @param request - The request {@link GetHostingRequest}
45
- * @param options - The waiting options
46
- * @returns A Promise of Hosting
47
- */
48
- waitForHosting: (request: Readonly<GetHostingRequest>, options?: Readonly<WaitForOptions<Hosting>>) => Promise<Hosting>;
49
- /**
50
- * Update a Web Hosting plan. Update the details of one of your existing Web
51
- * Hosting plans, specified by its `hosting_id`. You can update parameters
52
- * including the contact email address, tags, options and offer.
53
- *
54
- * @param request - The request {@link UpdateHostingRequest}
55
- * @returns A Promise of Hosting
56
- */
57
- updateHosting: (request: Readonly<UpdateHostingRequest>) => Promise<Hosting>;
58
- /**
59
- * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its
60
- * `hosting_id`. Note that deletion is not immediate: it will take place at
61
- * the end of the calendar month, after which time your Web Hosting plan and
62
- * all its data (files and emails) will be irreversibly lost.
63
- *
64
- * @param request - The request {@link DeleteHostingRequest}
65
- * @returns A Promise of Hosting
66
- */
67
- deleteHosting: (request: Readonly<DeleteHostingRequest>) => Promise<Hosting>;
68
- /**
69
- * Restore a Web Hosting plan. When you [delete a Web Hosting
70
- * plan](#path-hostings-delete-a-hosting), definitive deletion does not take
71
- * place until the end of the calendar month. In the time between initiating
72
- * the deletion, and definitive deletion at the end of the month, you can
73
- * choose to **restore** the Web Hosting plan, using this endpoint and
74
- * specifying its `hosting_id`.
75
- *
76
- * @param request - The request {@link RestoreHostingRequest}
77
- * @returns A Promise of Hosting
78
- */
79
- restoreHosting: (request: Readonly<RestoreHostingRequest>) => Promise<Hosting>;
80
- /**
81
- * Get DNS records. Get the set of DNS records of a specified domain
82
- * associated with a Web Hosting plan.
83
- *
84
- * @param request - The request {@link GetDomainDnsRecordsRequest}
85
- * @returns A Promise of DnsRecords
86
- */
87
- getDomainDnsRecords: (request: Readonly<GetDomainDnsRecordsRequest>) => Promise<DnsRecords>;
88
- /**
89
- * "Check whether you own this domain or not.".
90
- *
91
- * @param request - The request {@link CheckUserOwnsDomainRequest}
92
- * @returns A Promise of CheckUserOwnsDomainResponse
93
- */
94
- checkUserOwnsDomain: (request: Readonly<CheckUserOwnsDomainRequest>) => Promise<CheckUserOwnsDomainResponse>;
95
- /**
96
- * List all offers. List the different Web Hosting offers, and their options,
97
- * available to order from Scaleway.
98
- *
99
- * @param request - The request {@link ListOffersRequest}
100
- * @returns A Promise of ListOffersResponse
101
- */
102
- listOffers: (request: Readonly<ListOffersRequest>) => Promise<ListOffersResponse>;
103
- protected pageOfListControlPanels: (request?: Readonly<ListControlPanelsRequest>) => Promise<ListControlPanelsResponse>;
104
- /**
105
- * "List the control panels type: cpanel or plesk.".
106
- *
107
- * @param request - The request {@link ListControlPanelsRequest}
108
- * @returns A Promise of ListControlPanelsResponse
109
- */
110
- listControlPanels: (request?: Readonly<ListControlPanelsRequest>) => Promise<ListControlPanelsResponse> & {
111
- all: () => Promise<import("./types.gen").ControlPanel[]>;
112
- [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ControlPanel[], void, void>;
113
- };
114
- /**
115
- * Create a user session.
116
- *
117
- * @param request - The request {@link CreateSessionRequest}
118
- * @returns A Promise of Session
119
- */
120
- createSession: (request: Readonly<CreateSessionRequest>) => Promise<Session>;
121
- resetHostingPassword: (request: Readonly<ResetHostingPasswordRequest>) => Promise<ResetHostingPasswordResponse>;
122
- }
123
- /**
124
- * Web Hosting Classic Mailbox API.
125
- *
126
- * This API allows you to manage your mailboxes for your Web Hosting services.
127
- */
128
- export declare class ClassicMailAPI extends ParentAPI {
129
- /** Lists the available regions of the API. */
130
- static readonly LOCALITIES: ScwRegion[];
131
- /**
132
- * Create a new mailbox within your hosting plan.. Create a new mailbox within
133
- * your hosting plan.
134
- *
135
- * @param request - The request {@link ClassicMailApiCreateMailboxRequest}
136
- * @returns A Promise of Mailbox
137
- */
138
- createMailbox: (request: Readonly<ClassicMailApiCreateMailboxRequest>) => Promise<Mailbox>;
139
- /**
140
- * Get a mailbox by id within your hosting plan.. Get a mailbox by id within
141
- * your hosting plan.
142
- *
143
- * @param request - The request {@link ClassicMailApiGetMailboxRequest}
144
- * @returns A Promise of Mailbox
145
- */
146
- getMailbox: (request: Readonly<ClassicMailApiGetMailboxRequest>) => Promise<Mailbox>;
147
- protected pageOfListMailboxes: (request: Readonly<ClassicMailApiListMailboxesRequest>) => Promise<ListMailboxesResponse>;
148
- /**
149
- * List all mailboxes within your hosting plan.. List all mailboxes within
150
- * your hosting plan.
151
- *
152
- * @param request - The request {@link ClassicMailApiListMailboxesRequest}
153
- * @returns A Promise of ListMailboxesResponse
154
- */
155
- listMailboxes: (request: Readonly<ClassicMailApiListMailboxesRequest>) => Promise<ListMailboxesResponse> & {
156
- all: () => Promise<Mailbox[]>;
157
- [Symbol.asyncIterator]: () => AsyncGenerator<Mailbox[], void, void>;
158
- };
159
- deleteMailbox: (request: Readonly<ClassicMailApiDeleteMailboxRequest>) => Promise<Mailbox>;
160
- /**
161
- * Update the mailbox within your hosting plan.. Update the mailbox within
162
- * your hosting plan.
163
- *
164
- * @param request - The request {@link ClassicMailApiUpdateMailboxRequest}
165
- * @returns A Promise of Mailbox
166
- */
167
- updateMailbox: (request: Readonly<ClassicMailApiUpdateMailboxRequest>) => Promise<Mailbox>;
168
- }