@scaleway/sdk 2.64.0 → 2.66.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/applesilicon/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/applesilicon/v1alpha1/marshalling.gen.cjs +17 -0
- package/dist/api/applesilicon/v1alpha1/marshalling.gen.js +17 -0
- package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +21 -0
- package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/audit_trail/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +9 -0
- package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +9 -0
- package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +24 -16
- package/dist/api/baremetal/v1/api.gen.d.ts +3 -3
- package/dist/api/baremetal/v1/types.gen.d.ts +33 -33
- package/dist/api/baremetal/v3/api.gen.d.ts +2 -2
- package/dist/api/baremetal/v3/types.gen.d.ts +5 -5
- package/dist/api/block/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/block/v1alpha1/types.gen.d.ts +17 -17
- package/dist/api/cockpit/v1/api.gen.cjs +19 -1
- package/dist/api/cockpit/v1/api.gen.d.ts +4 -3
- package/dist/api/cockpit/v1/api.gen.js +20 -2
- package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
- package/dist/api/cockpit/v1/marshalling.gen.cjs +13 -0
- package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -1
- package/dist/api/cockpit/v1/marshalling.gen.js +13 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +50 -31
- package/dist/api/container/v1beta1/api.gen.cjs +5 -1
- package/dist/api/container/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/container/v1beta1/api.gen.js +5 -1
- package/dist/api/container/v1beta1/types.gen.d.ts +32 -32
- package/dist/api/dedibox/v1/api.gen.d.ts +2 -2
- package/dist/api/dedibox/v1/types.gen.d.ts +51 -51
- package/dist/api/edge_services/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/edge_services/v1alpha1/marshalling.gen.cjs +21 -2
- package/dist/api/edge_services/v1alpha1/marshalling.gen.js +22 -3
- package/dist/api/edge_services/v1alpha1/types.gen.d.ts +34 -0
- package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +14 -14
- package/dist/api/function/v1beta1/api.gen.cjs +5 -1
- package/dist/api/function/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/function/v1beta1/api.gen.js +5 -1
- package/dist/api/function/v1beta1/types.gen.d.ts +35 -35
- package/dist/api/iot/v1/api.gen.d.ts +2 -2
- package/dist/api/iot/v1/types.gen.d.ts +38 -38
- package/dist/api/ipam/v1/api.gen.cjs +5 -1
- package/dist/api/ipam/v1/api.gen.d.ts +2 -2
- package/dist/api/ipam/v1/api.gen.js +5 -1
- package/dist/api/ipam/v1/types.gen.d.ts +13 -13
- package/dist/api/jobs/v1alpha1/api.gen.cjs +5 -1
- package/dist/api/jobs/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/jobs/v1alpha1/api.gen.js +5 -1
- package/dist/api/jobs/v1alpha1/types.gen.d.ts +19 -19
- package/dist/api/k8s/v1/api.gen.cjs +5 -1
- package/dist/api/k8s/v1/api.gen.d.ts +2 -2
- package/dist/api/k8s/v1/api.gen.js +5 -1
- package/dist/api/k8s/v1/marshalling.gen.cjs +1 -0
- package/dist/api/k8s/v1/marshalling.gen.js +1 -0
- package/dist/api/k8s/v1/types.gen.d.ts +42 -41
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +41 -37
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +38 -38
- package/dist/api/key_manager/v1alpha1/api.gen.js +41 -37
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +31 -30
- package/dist/api/lb/v1/api.gen.cjs +5 -1
- package/dist/api/lb/v1/api.gen.d.ts +3 -3
- package/dist/api/lb/v1/api.gen.js +5 -1
- package/dist/api/lb/v1/types.gen.d.ts +116 -116
- package/dist/api/marketplace/v2/types.gen.d.ts +3 -3
- package/dist/api/mnq/v1beta1/api.gen.d.ts +4 -4
- package/dist/api/mnq/v1beta1/types.gen.d.ts +31 -31
- package/dist/api/mongodb/v1alpha1/api.gen.d.ts +3 -3
- package/dist/api/mongodb/v1alpha1/types.gen.d.ts +24 -24
- package/dist/api/rdb/v1/api.gen.cjs +5 -1
- package/dist/api/rdb/v1/api.gen.d.ts +2 -2
- package/dist/api/rdb/v1/api.gen.js +5 -1
- package/dist/api/rdb/v1/types.gen.d.ts +67 -67
- package/dist/api/redis/v1/api.gen.d.ts +2 -2
- package/dist/api/redis/v1/types.gen.d.ts +28 -28
- package/dist/api/registry/v1/api.gen.cjs +5 -1
- package/dist/api/registry/v1/api.gen.d.ts +2 -2
- package/dist/api/registry/v1/api.gen.js +5 -1
- package/dist/api/registry/v1/types.gen.d.ts +14 -14
- package/dist/api/secret/v1beta1/api.gen.cjs +5 -1
- package/dist/api/secret/v1beta1/api.gen.d.ts +2 -2
- package/dist/api/secret/v1beta1/api.gen.js +5 -1
- package/dist/api/secret/v1beta1/types.gen.d.ts +22 -22
- package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +12 -12
- package/dist/api/tem/v1alpha1/api.gen.d.ts +2 -2
- package/dist/api/tem/v1alpha1/types.gen.d.ts +25 -25
- package/dist/api/vpcgw/v1/api.gen.d.ts +2 -2
- package/dist/api/vpcgw/v1/types.gen.d.ts +44 -44
- package/dist/api/vpcgw/v2/api.gen.d.ts +2 -2
- package/dist/api/vpcgw/v2/types.gen.d.ts +33 -33
- package/dist/api/webhosting/v1/api.gen.cjs +58 -2
- package/dist/api/webhosting/v1/api.gen.d.ts +31 -3
- package/dist/api/webhosting/v1/api.gen.js +60 -4
- package/dist/api/webhosting/v1/content.gen.cjs +4 -0
- package/dist/api/webhosting/v1/content.gen.d.ts +5 -1
- package/dist/api/webhosting/v1/content.gen.js +4 -0
- package/dist/api/webhosting/v1/index.gen.cjs +2 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +1 -1
- package/dist/api/webhosting/v1/index.gen.js +3 -1
- package/dist/api/webhosting/v1/marshalling.gen.cjs +45 -0
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +3 -1
- package/dist/api/webhosting/v1/marshalling.gen.js +45 -0
- package/dist/api/webhosting/v1/types.gen.d.ts +66 -0
- package/dist/api/webhosting/v1alpha1/api.gen.cjs +1 -1
- package/dist/api/webhosting/v1alpha1/api.gen.js +1 -1
- package/dist/scw/client-settings.cjs +2 -2
- package/dist/scw/client-settings.d.ts +2 -2
- package/dist/scw/client-settings.js +2 -2
- 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
|
@@ -266,7 +266,8 @@ class DnsAPI extends api.API {
|
|
|
266
266
|
marshalling_gen.unmarshalDnsRecords
|
|
267
267
|
);
|
|
268
268
|
/**
|
|
269
|
-
*
|
|
269
|
+
* Check whether you own this domain or not.. Check whether you own this
|
|
270
|
+
* domain or not.
|
|
270
271
|
*
|
|
271
272
|
* @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
|
|
272
273
|
* @returns A Promise of CheckUserOwnsDomainResponse
|
|
@@ -286,7 +287,8 @@ class DnsAPI extends api.API {
|
|
|
286
287
|
marshalling_gen.unmarshalCheckUserOwnsDomainResponse
|
|
287
288
|
);
|
|
288
289
|
/**
|
|
289
|
-
*
|
|
290
|
+
* Synchronize your DNS records on the Elements Console and on cPanel..
|
|
291
|
+
* Synchronize your DNS records on the Elements Console and on cPanel.
|
|
290
292
|
*
|
|
291
293
|
* @param request - The request {@link DnsApiSyncDomainDnsRecordsRequest}
|
|
292
294
|
* @returns A Promise of DnsRecords
|
|
@@ -305,6 +307,60 @@ class DnsAPI extends api.API {
|
|
|
305
307
|
},
|
|
306
308
|
marshalling_gen.unmarshalDnsRecords
|
|
307
309
|
);
|
|
310
|
+
/**
|
|
311
|
+
* Search for available domains based on domain name.. Search for available
|
|
312
|
+
* domains based on domain name.
|
|
313
|
+
*
|
|
314
|
+
* @param request - The request {@link DnsApiSearchDomainsRequest}
|
|
315
|
+
* @returns A Promise of SearchDomainsResponse
|
|
316
|
+
*/
|
|
317
|
+
searchDomains = (request) => this.client.fetch(
|
|
318
|
+
{
|
|
319
|
+
method: "GET",
|
|
320
|
+
path: `/webhosting/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/search-domains`,
|
|
321
|
+
urlParams: marshalling.urlParams(
|
|
322
|
+
["domain_name", request.domainName],
|
|
323
|
+
[
|
|
324
|
+
"project_id",
|
|
325
|
+
request.projectId ?? this.client.settings.defaultProjectId
|
|
326
|
+
]
|
|
327
|
+
)
|
|
328
|
+
},
|
|
329
|
+
marshalling_gen.unmarshalSearchDomainsResponse
|
|
330
|
+
);
|
|
331
|
+
/**
|
|
332
|
+
* Retrieve detailed information about a specific domain, including its
|
|
333
|
+
* status, DNS configuration, and ownership.. Retrieve detailed information
|
|
334
|
+
* about a specific domain, including its status, DNS configuration, and
|
|
335
|
+
* ownership.
|
|
336
|
+
*
|
|
337
|
+
* @param request - The request {@link DnsApiGetDomainRequest}
|
|
338
|
+
* @returns A Promise of Domain
|
|
339
|
+
*/
|
|
340
|
+
getDomain = (request) => this.client.fetch(
|
|
341
|
+
{
|
|
342
|
+
method: "GET",
|
|
343
|
+
path: `/webhosting/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domainName", request.domainName)}`,
|
|
344
|
+
urlParams: marshalling.urlParams([
|
|
345
|
+
"project_id",
|
|
346
|
+
request.projectId ?? this.client.settings.defaultProjectId
|
|
347
|
+
])
|
|
348
|
+
},
|
|
349
|
+
marshalling_gen.unmarshalDomain
|
|
350
|
+
);
|
|
351
|
+
/**
|
|
352
|
+
* Waits for {@link Domain} to be in a final state.
|
|
353
|
+
*
|
|
354
|
+
* @param request - The request {@link DnsApiGetDomainRequest}
|
|
355
|
+
* @param options - The waiting options
|
|
356
|
+
* @returns A Promise of Domain
|
|
357
|
+
*/
|
|
358
|
+
waitForDomain = (request, options) => intervalRetrier.waitForResource(
|
|
359
|
+
options?.stop ?? ((res) => Promise.resolve(!content_gen.DOMAIN_TRANSIENT_STATUSES.includes(res.status))),
|
|
360
|
+
this.getDomain,
|
|
361
|
+
request,
|
|
362
|
+
options
|
|
363
|
+
);
|
|
308
364
|
}
|
|
309
365
|
class OfferAPI extends api.API {
|
|
310
366
|
/** Lists the available regions of the API. */
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { API as ParentAPI } from '../../../bridge';
|
|
2
2
|
import type { Region as ScwRegion, WaitForOptions } from '../../../bridge';
|
|
3
|
-
import type { CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiSyncDomainDnsRecordsRequest, 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';
|
|
3
|
+
import type { CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, 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, SearchDomainsResponse, Session, WebsiteApiListWebsitesRequest } from './types.gen';
|
|
4
4
|
/**
|
|
5
5
|
* Web Hosting Control Panel API.
|
|
6
6
|
*
|
|
@@ -134,19 +134,47 @@ export declare class DnsAPI extends ParentAPI {
|
|
|
134
134
|
*/
|
|
135
135
|
getDomainDnsRecords: (request: Readonly<DnsApiGetDomainDnsRecordsRequest>) => Promise<DnsRecords>;
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
137
|
+
* Check whether you own this domain or not.. Check whether you own this
|
|
138
|
+
* domain or not.
|
|
138
139
|
*
|
|
139
140
|
* @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
|
|
140
141
|
* @returns A Promise of CheckUserOwnsDomainResponse
|
|
141
142
|
*/
|
|
142
143
|
checkUserOwnsDomain: (request: Readonly<DnsApiCheckUserOwnsDomainRequest>) => Promise<CheckUserOwnsDomainResponse>;
|
|
143
144
|
/**
|
|
144
|
-
*
|
|
145
|
+
* Synchronize your DNS records on the Elements Console and on cPanel..
|
|
146
|
+
* Synchronize your DNS records on the Elements Console and on cPanel.
|
|
145
147
|
*
|
|
146
148
|
* @param request - The request {@link DnsApiSyncDomainDnsRecordsRequest}
|
|
147
149
|
* @returns A Promise of DnsRecords
|
|
148
150
|
*/
|
|
149
151
|
syncDomainDnsRecords: (request: Readonly<DnsApiSyncDomainDnsRecordsRequest>) => Promise<DnsRecords>;
|
|
152
|
+
/**
|
|
153
|
+
* Search for available domains based on domain name.. Search for available
|
|
154
|
+
* domains based on domain name.
|
|
155
|
+
*
|
|
156
|
+
* @param request - The request {@link DnsApiSearchDomainsRequest}
|
|
157
|
+
* @returns A Promise of SearchDomainsResponse
|
|
158
|
+
*/
|
|
159
|
+
searchDomains: (request: Readonly<DnsApiSearchDomainsRequest>) => Promise<SearchDomainsResponse>;
|
|
160
|
+
/**
|
|
161
|
+
* Retrieve detailed information about a specific domain, including its
|
|
162
|
+
* status, DNS configuration, and ownership.. Retrieve detailed information
|
|
163
|
+
* about a specific domain, including its status, DNS configuration, and
|
|
164
|
+
* ownership.
|
|
165
|
+
*
|
|
166
|
+
* @param request - The request {@link DnsApiGetDomainRequest}
|
|
167
|
+
* @returns A Promise of Domain
|
|
168
|
+
*/
|
|
169
|
+
getDomain: (request: Readonly<DnsApiGetDomainRequest>) => Promise<Domain>;
|
|
170
|
+
/**
|
|
171
|
+
* Waits for {@link Domain} to be in a final state.
|
|
172
|
+
*
|
|
173
|
+
* @param request - The request {@link DnsApiGetDomainRequest}
|
|
174
|
+
* @param options - The waiting options
|
|
175
|
+
* @returns A Promise of Domain
|
|
176
|
+
*/
|
|
177
|
+
waitForDomain: (request: Readonly<DnsApiGetDomainRequest>, options?: Readonly<WaitForOptions<Domain>>) => Promise<Domain>;
|
|
150
178
|
}
|
|
151
179
|
/**
|
|
152
180
|
* Web Hosting Offer API.
|
|
@@ -3,8 +3,8 @@ import { API as API$1 } from "../../../scw/api.js";
|
|
|
3
3
|
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
|
-
import { HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
7
|
-
import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalDnsRecords, marshalDnsApiCheckUserOwnsDomainRequest, unmarshalCheckUserOwnsDomainResponse, marshalDnsApiSyncDomainDnsRecordsRequest, unmarshalListOffersResponse, marshalHostingApiCreateHostingRequest, unmarshalHosting, unmarshalListHostingsResponse, marshalHostingApiUpdateHostingRequest, unmarshalSession, unmarshalResetHostingPasswordResponse, unmarshalResourceSummary, marshalFtpAccountApiCreateFtpAccountRequest, unmarshalFtpAccount, unmarshalListFtpAccountsResponse, marshalFtpAccountApiChangeFtpAccountPasswordRequest, marshalMailAccountApiCreateMailAccountRequest, unmarshalMailAccount, unmarshalListMailAccountsResponse, marshalMailAccountApiRemoveMailAccountRequest, marshalMailAccountApiChangeMailAccountPasswordRequest, unmarshalListWebsitesResponse } from "./marshalling.gen.js";
|
|
6
|
+
import { DOMAIN_TRANSIENT_STATUSES, HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
7
|
+
import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalDnsRecords, marshalDnsApiCheckUserOwnsDomainRequest, unmarshalCheckUserOwnsDomainResponse, marshalDnsApiSyncDomainDnsRecordsRequest, unmarshalSearchDomainsResponse, unmarshalDomain, 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
|
};
|
|
@@ -264,7 +264,8 @@ class DnsAPI extends API$1 {
|
|
|
264
264
|
unmarshalDnsRecords
|
|
265
265
|
);
|
|
266
266
|
/**
|
|
267
|
-
*
|
|
267
|
+
* Check whether you own this domain or not.. Check whether you own this
|
|
268
|
+
* domain or not.
|
|
268
269
|
*
|
|
269
270
|
* @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
|
|
270
271
|
* @returns A Promise of CheckUserOwnsDomainResponse
|
|
@@ -284,7 +285,8 @@ class DnsAPI extends API$1 {
|
|
|
284
285
|
unmarshalCheckUserOwnsDomainResponse
|
|
285
286
|
);
|
|
286
287
|
/**
|
|
287
|
-
*
|
|
288
|
+
* Synchronize your DNS records on the Elements Console and on cPanel..
|
|
289
|
+
* Synchronize your DNS records on the Elements Console and on cPanel.
|
|
288
290
|
*
|
|
289
291
|
* @param request - The request {@link DnsApiSyncDomainDnsRecordsRequest}
|
|
290
292
|
* @returns A Promise of DnsRecords
|
|
@@ -303,6 +305,60 @@ class DnsAPI extends API$1 {
|
|
|
303
305
|
},
|
|
304
306
|
unmarshalDnsRecords
|
|
305
307
|
);
|
|
308
|
+
/**
|
|
309
|
+
* Search for available domains based on domain name.. Search for available
|
|
310
|
+
* domains based on domain name.
|
|
311
|
+
*
|
|
312
|
+
* @param request - The request {@link DnsApiSearchDomainsRequest}
|
|
313
|
+
* @returns A Promise of SearchDomainsResponse
|
|
314
|
+
*/
|
|
315
|
+
searchDomains = (request) => this.client.fetch(
|
|
316
|
+
{
|
|
317
|
+
method: "GET",
|
|
318
|
+
path: `/webhosting/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/search-domains`,
|
|
319
|
+
urlParams: urlParams(
|
|
320
|
+
["domain_name", request.domainName],
|
|
321
|
+
[
|
|
322
|
+
"project_id",
|
|
323
|
+
request.projectId ?? this.client.settings.defaultProjectId
|
|
324
|
+
]
|
|
325
|
+
)
|
|
326
|
+
},
|
|
327
|
+
unmarshalSearchDomainsResponse
|
|
328
|
+
);
|
|
329
|
+
/**
|
|
330
|
+
* Retrieve detailed information about a specific domain, including its
|
|
331
|
+
* status, DNS configuration, and ownership.. Retrieve detailed information
|
|
332
|
+
* about a specific domain, including its status, DNS configuration, and
|
|
333
|
+
* ownership.
|
|
334
|
+
*
|
|
335
|
+
* @param request - The request {@link DnsApiGetDomainRequest}
|
|
336
|
+
* @returns A Promise of Domain
|
|
337
|
+
*/
|
|
338
|
+
getDomain = (request) => this.client.fetch(
|
|
339
|
+
{
|
|
340
|
+
method: "GET",
|
|
341
|
+
path: `/webhosting/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam("domainName", request.domainName)}`,
|
|
342
|
+
urlParams: urlParams([
|
|
343
|
+
"project_id",
|
|
344
|
+
request.projectId ?? this.client.settings.defaultProjectId
|
|
345
|
+
])
|
|
346
|
+
},
|
|
347
|
+
unmarshalDomain
|
|
348
|
+
);
|
|
349
|
+
/**
|
|
350
|
+
* Waits for {@link Domain} to be in a final state.
|
|
351
|
+
*
|
|
352
|
+
* @param request - The request {@link DnsApiGetDomainRequest}
|
|
353
|
+
* @param options - The waiting options
|
|
354
|
+
* @returns A Promise of Domain
|
|
355
|
+
*/
|
|
356
|
+
waitForDomain = (request, options) => waitForResource(
|
|
357
|
+
options?.stop ?? ((res) => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))),
|
|
358
|
+
this.getDomain,
|
|
359
|
+
request,
|
|
360
|
+
options
|
|
361
|
+
);
|
|
306
362
|
}
|
|
307
363
|
class OfferAPI extends API$1 {
|
|
308
364
|
/** Lists the available regions of the API. */
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
+
const DOMAIN_AVAILABILITY_TRANSIENT_STATUSES = ["validating"];
|
|
4
|
+
const DOMAIN_TRANSIENT_STATUSES = ["validating"];
|
|
3
5
|
const HOSTING_TRANSIENT_STATUSES = [
|
|
4
6
|
"delivering",
|
|
5
7
|
"deleting",
|
|
@@ -10,5 +12,7 @@ const HOSTING_SUMMARY_TRANSIENT_STATUSES = [
|
|
|
10
12
|
"deleting",
|
|
11
13
|
"migrating"
|
|
12
14
|
];
|
|
15
|
+
exports.DOMAIN_AVAILABILITY_TRANSIENT_STATUSES = DOMAIN_AVAILABILITY_TRANSIENT_STATUSES;
|
|
16
|
+
exports.DOMAIN_TRANSIENT_STATUSES = DOMAIN_TRANSIENT_STATUSES;
|
|
13
17
|
exports.HOSTING_SUMMARY_TRANSIENT_STATUSES = HOSTING_SUMMARY_TRANSIENT_STATUSES;
|
|
14
18
|
exports.HOSTING_TRANSIENT_STATUSES = HOSTING_TRANSIENT_STATUSES;
|
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
import type { HostingStatus, HostingSummaryStatus } from './types.gen';
|
|
1
|
+
import type { DomainAvailabilityStatus, DomainStatus, HostingStatus, HostingSummaryStatus } from './types.gen';
|
|
2
|
+
/** Lists transient statutes of the enum {@link DomainAvailabilityStatus}. */
|
|
3
|
+
export declare const DOMAIN_AVAILABILITY_TRANSIENT_STATUSES: DomainAvailabilityStatus[];
|
|
4
|
+
/** Lists transient statutes of the enum {@link DomainStatus}. */
|
|
5
|
+
export declare const DOMAIN_TRANSIENT_STATUSES: DomainStatus[];
|
|
2
6
|
/** Lists transient statutes of the enum {@link HostingStatus}. */
|
|
3
7
|
export declare const HOSTING_TRANSIENT_STATUSES: HostingStatus[];
|
|
4
8
|
/** Lists transient statutes of the enum {@link HostingSummaryStatus}. */
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
const DOMAIN_AVAILABILITY_TRANSIENT_STATUSES = ["validating"];
|
|
2
|
+
const DOMAIN_TRANSIENT_STATUSES = ["validating"];
|
|
1
3
|
const HOSTING_TRANSIENT_STATUSES = [
|
|
2
4
|
"delivering",
|
|
3
5
|
"deleting",
|
|
@@ -9,6 +11,8 @@ const HOSTING_SUMMARY_TRANSIENT_STATUSES = [
|
|
|
9
11
|
"migrating"
|
|
10
12
|
];
|
|
11
13
|
export {
|
|
14
|
+
DOMAIN_AVAILABILITY_TRANSIENT_STATUSES,
|
|
15
|
+
DOMAIN_TRANSIENT_STATUSES,
|
|
12
16
|
HOSTING_SUMMARY_TRANSIENT_STATUSES,
|
|
13
17
|
HOSTING_TRANSIENT_STATUSES
|
|
14
18
|
};
|
|
@@ -11,6 +11,8 @@ exports.HostingAPI = api_gen.HostingAPI;
|
|
|
11
11
|
exports.MailAccountAPI = api_gen.MailAccountAPI;
|
|
12
12
|
exports.OfferAPI = api_gen.OfferAPI;
|
|
13
13
|
exports.WebsiteAPI = api_gen.WebsiteAPI;
|
|
14
|
+
exports.DOMAIN_AVAILABILITY_TRANSIENT_STATUSES = content_gen.DOMAIN_AVAILABILITY_TRANSIENT_STATUSES;
|
|
15
|
+
exports.DOMAIN_TRANSIENT_STATUSES = content_gen.DOMAIN_TRANSIENT_STATUSES;
|
|
14
16
|
exports.HOSTING_SUMMARY_TRANSIENT_STATUSES = content_gen.HOSTING_SUMMARY_TRANSIENT_STATUSES;
|
|
15
17
|
exports.HOSTING_TRANSIENT_STATUSES = content_gen.HOSTING_TRANSIENT_STATUSES;
|
|
16
18
|
exports.ValidationRules = validationRules_gen;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { ControlPanelAPI, DatabaseAPI, DnsAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI, } from './api.gen.js';
|
|
2
2
|
export * from './content.gen.js';
|
|
3
|
-
export type { CheckUserOwnsDomainResponse, ControlPanel, ControlPanelApiListControlPanelsRequest, CreateDatabaseRequestUser, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiSyncDomainDnsRecordsRequest, 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, SyncDomainDnsRecordsRequestRecord, Website, WebsiteApiListWebsitesRequest, } from './types.gen';
|
|
3
|
+
export type { CheckUserOwnsDomainResponse, ControlPanel, ControlPanelApiListControlPanelsRequest, CreateDatabaseRequestUser, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecord, DnsRecordStatus, DnsRecordType, DnsRecords, DnsRecordsStatus, Domain, DomainAction, DomainAvailability, DomainAvailabilityAction, DomainAvailabilityStatus, DomainDnsAction, DomainStatus, DomainZoneOwner, 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, SearchDomainsResponse, Session, SyncDomainDnsRecordsRequestRecord, Website, WebsiteApiListWebsitesRequest, } from './types.gen';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen.js';
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import { ControlPanelAPI, DatabaseAPI, DnsAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI } from "./api.gen.js";
|
|
2
|
-
import { HOSTING_SUMMARY_TRANSIENT_STATUSES, HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
|
|
2
|
+
import { DOMAIN_AVAILABILITY_TRANSIENT_STATUSES, DOMAIN_TRANSIENT_STATUSES, 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
|
+
DOMAIN_AVAILABILITY_TRANSIENT_STATUSES,
|
|
7
|
+
DOMAIN_TRANSIENT_STATUSES,
|
|
6
8
|
DatabaseAPI,
|
|
7
9
|
DnsAPI,
|
|
8
10
|
FtpAccountAPI,
|
|
@@ -97,6 +97,20 @@ const unmarshalDnsRecords = (data) => {
|
|
|
97
97
|
status: data.status
|
|
98
98
|
};
|
|
99
99
|
};
|
|
100
|
+
const unmarshalDomain = (data) => {
|
|
101
|
+
if (!json.isJSONObject(data)) {
|
|
102
|
+
throw new TypeError(
|
|
103
|
+
`Unmarshalling the type 'Domain' failed as data isn't a dictionary.`
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
return {
|
|
107
|
+
availableActions: data.available_actions,
|
|
108
|
+
availableDnsActions: data.available_dns_actions,
|
|
109
|
+
name: data.name,
|
|
110
|
+
owner: data.owner,
|
|
111
|
+
status: data.status
|
|
112
|
+
};
|
|
113
|
+
};
|
|
100
114
|
const unmarshalPlatformControlPanelUrls = (data) => {
|
|
101
115
|
if (!json.isJSONObject(data)) {
|
|
102
116
|
throw new TypeError(
|
|
@@ -365,6 +379,34 @@ const unmarshalResourceSummary = (data) => {
|
|
|
365
379
|
websitesCount: data.websites_count
|
|
366
380
|
};
|
|
367
381
|
};
|
|
382
|
+
const unmarshalDomainAvailability = (data) => {
|
|
383
|
+
if (!json.isJSONObject(data)) {
|
|
384
|
+
throw new TypeError(
|
|
385
|
+
`Unmarshalling the type 'DomainAvailability' failed as data isn't a dictionary.`
|
|
386
|
+
);
|
|
387
|
+
}
|
|
388
|
+
return {
|
|
389
|
+
availableActions: data.available_actions,
|
|
390
|
+
canCreateHosting: data.can_create_hosting,
|
|
391
|
+
name: data.name,
|
|
392
|
+
price: data.price ? customMarshalling.unmarshalMoney(data.price) : void 0,
|
|
393
|
+
status: data.status,
|
|
394
|
+
zoneName: data.zone_name
|
|
395
|
+
};
|
|
396
|
+
};
|
|
397
|
+
const unmarshalSearchDomainsResponse = (data) => {
|
|
398
|
+
if (!json.isJSONObject(data)) {
|
|
399
|
+
throw new TypeError(
|
|
400
|
+
`Unmarshalling the type 'SearchDomainsResponse' failed as data isn't a dictionary.`
|
|
401
|
+
);
|
|
402
|
+
}
|
|
403
|
+
return {
|
|
404
|
+
domainsAvailable: marshalling.unmarshalArrayOfObject(
|
|
405
|
+
data.domains_available,
|
|
406
|
+
unmarshalDomainAvailability
|
|
407
|
+
)
|
|
408
|
+
};
|
|
409
|
+
};
|
|
368
410
|
const unmarshalSession = (data) => {
|
|
369
411
|
if (!json.isJSONObject(data)) {
|
|
370
412
|
throw new TypeError(
|
|
@@ -415,6 +457,7 @@ const marshalDnsApiSyncDomainDnsRecordsRequest = (request, defaults) => ({
|
|
|
415
457
|
) : void 0,
|
|
416
458
|
update_all_records: request.updateAllRecords,
|
|
417
459
|
update_mail_records: request.updateMailRecords,
|
|
460
|
+
update_nameservers: request.updateNameservers,
|
|
418
461
|
update_web_records: request.updateWebRecords
|
|
419
462
|
});
|
|
420
463
|
const marshalFtpAccountApiChangeFtpAccountPasswordRequest = (request, defaults) => ({
|
|
@@ -491,6 +534,7 @@ exports.unmarshalCheckUserOwnsDomainResponse = unmarshalCheckUserOwnsDomainRespo
|
|
|
491
534
|
exports.unmarshalDatabase = unmarshalDatabase;
|
|
492
535
|
exports.unmarshalDatabaseUser = unmarshalDatabaseUser;
|
|
493
536
|
exports.unmarshalDnsRecords = unmarshalDnsRecords;
|
|
537
|
+
exports.unmarshalDomain = unmarshalDomain;
|
|
494
538
|
exports.unmarshalFtpAccount = unmarshalFtpAccount;
|
|
495
539
|
exports.unmarshalHosting = unmarshalHosting;
|
|
496
540
|
exports.unmarshalListControlPanelsResponse = unmarshalListControlPanelsResponse;
|
|
@@ -504,4 +548,5 @@ exports.unmarshalListWebsitesResponse = unmarshalListWebsitesResponse;
|
|
|
504
548
|
exports.unmarshalMailAccount = unmarshalMailAccount;
|
|
505
549
|
exports.unmarshalResetHostingPasswordResponse = unmarshalResetHostingPasswordResponse;
|
|
506
550
|
exports.unmarshalResourceSummary = unmarshalResourceSummary;
|
|
551
|
+
exports.unmarshalSearchDomainsResponse = unmarshalSearchDomainsResponse;
|
|
507
552
|
exports.unmarshalSession = unmarshalSession;
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import type { DefaultValues } from '../../../bridge';
|
|
2
|
-
import type { CheckUserOwnsDomainResponse, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiUpdateHostingRequest, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiRemoveMailAccountRequest, ResetHostingPasswordResponse, ResourceSummary, Session } from './types.gen';
|
|
2
|
+
import type { CheckUserOwnsDomainResponse, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiUpdateHostingRequest, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiRemoveMailAccountRequest, ResetHostingPasswordResponse, ResourceSummary, SearchDomainsResponse, Session } from './types.gen';
|
|
3
3
|
export declare const unmarshalDatabaseUser: (data: unknown) => DatabaseUser;
|
|
4
4
|
export declare const unmarshalDatabase: (data: unknown) => Database;
|
|
5
5
|
export declare const unmarshalFtpAccount: (data: unknown) => FtpAccount;
|
|
6
6
|
export declare const unmarshalMailAccount: (data: unknown) => MailAccount;
|
|
7
7
|
export declare const unmarshalCheckUserOwnsDomainResponse: (data: unknown) => CheckUserOwnsDomainResponse;
|
|
8
8
|
export declare const unmarshalDnsRecords: (data: unknown) => DnsRecords;
|
|
9
|
+
export declare const unmarshalDomain: (data: unknown) => Domain;
|
|
9
10
|
export declare const unmarshalHosting: (data: unknown) => Hosting;
|
|
10
11
|
export declare const unmarshalListControlPanelsResponse: (data: unknown) => ListControlPanelsResponse;
|
|
11
12
|
export declare const unmarshalListDatabaseUsersResponse: (data: unknown) => ListDatabaseUsersResponse;
|
|
@@ -17,6 +18,7 @@ export declare const unmarshalListOffersResponse: (data: unknown) => ListOffersR
|
|
|
17
18
|
export declare const unmarshalListWebsitesResponse: (data: unknown) => ListWebsitesResponse;
|
|
18
19
|
export declare const unmarshalResetHostingPasswordResponse: (data: unknown) => ResetHostingPasswordResponse;
|
|
19
20
|
export declare const unmarshalResourceSummary: (data: unknown) => ResourceSummary;
|
|
21
|
+
export declare const unmarshalSearchDomainsResponse: (data: unknown) => SearchDomainsResponse;
|
|
20
22
|
export declare const unmarshalSession: (data: unknown) => Session;
|
|
21
23
|
export declare const marshalDatabaseApiAssignDatabaseUserRequest: (request: DatabaseApiAssignDatabaseUserRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
22
24
|
export declare const marshalDatabaseApiChangeDatabaseUserPasswordRequest: (request: DatabaseApiChangeDatabaseUserPasswordRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
@@ -95,6 +95,20 @@ const unmarshalDnsRecords = (data) => {
|
|
|
95
95
|
status: data.status
|
|
96
96
|
};
|
|
97
97
|
};
|
|
98
|
+
const unmarshalDomain = (data) => {
|
|
99
|
+
if (!isJSONObject(data)) {
|
|
100
|
+
throw new TypeError(
|
|
101
|
+
`Unmarshalling the type 'Domain' failed as data isn't a dictionary.`
|
|
102
|
+
);
|
|
103
|
+
}
|
|
104
|
+
return {
|
|
105
|
+
availableActions: data.available_actions,
|
|
106
|
+
availableDnsActions: data.available_dns_actions,
|
|
107
|
+
name: data.name,
|
|
108
|
+
owner: data.owner,
|
|
109
|
+
status: data.status
|
|
110
|
+
};
|
|
111
|
+
};
|
|
98
112
|
const unmarshalPlatformControlPanelUrls = (data) => {
|
|
99
113
|
if (!isJSONObject(data)) {
|
|
100
114
|
throw new TypeError(
|
|
@@ -363,6 +377,34 @@ const unmarshalResourceSummary = (data) => {
|
|
|
363
377
|
websitesCount: data.websites_count
|
|
364
378
|
};
|
|
365
379
|
};
|
|
380
|
+
const unmarshalDomainAvailability = (data) => {
|
|
381
|
+
if (!isJSONObject(data)) {
|
|
382
|
+
throw new TypeError(
|
|
383
|
+
`Unmarshalling the type 'DomainAvailability' failed as data isn't a dictionary.`
|
|
384
|
+
);
|
|
385
|
+
}
|
|
386
|
+
return {
|
|
387
|
+
availableActions: data.available_actions,
|
|
388
|
+
canCreateHosting: data.can_create_hosting,
|
|
389
|
+
name: data.name,
|
|
390
|
+
price: data.price ? unmarshalMoney(data.price) : void 0,
|
|
391
|
+
status: data.status,
|
|
392
|
+
zoneName: data.zone_name
|
|
393
|
+
};
|
|
394
|
+
};
|
|
395
|
+
const unmarshalSearchDomainsResponse = (data) => {
|
|
396
|
+
if (!isJSONObject(data)) {
|
|
397
|
+
throw new TypeError(
|
|
398
|
+
`Unmarshalling the type 'SearchDomainsResponse' failed as data isn't a dictionary.`
|
|
399
|
+
);
|
|
400
|
+
}
|
|
401
|
+
return {
|
|
402
|
+
domainsAvailable: unmarshalArrayOfObject(
|
|
403
|
+
data.domains_available,
|
|
404
|
+
unmarshalDomainAvailability
|
|
405
|
+
)
|
|
406
|
+
};
|
|
407
|
+
};
|
|
366
408
|
const unmarshalSession = (data) => {
|
|
367
409
|
if (!isJSONObject(data)) {
|
|
368
410
|
throw new TypeError(
|
|
@@ -413,6 +455,7 @@ const marshalDnsApiSyncDomainDnsRecordsRequest = (request, defaults) => ({
|
|
|
413
455
|
) : void 0,
|
|
414
456
|
update_all_records: request.updateAllRecords,
|
|
415
457
|
update_mail_records: request.updateMailRecords,
|
|
458
|
+
update_nameservers: request.updateNameservers,
|
|
416
459
|
update_web_records: request.updateWebRecords
|
|
417
460
|
});
|
|
418
461
|
const marshalFtpAccountApiChangeFtpAccountPasswordRequest = (request, defaults) => ({
|
|
@@ -490,6 +533,7 @@ export {
|
|
|
490
533
|
unmarshalDatabase,
|
|
491
534
|
unmarshalDatabaseUser,
|
|
492
535
|
unmarshalDnsRecords,
|
|
536
|
+
unmarshalDomain,
|
|
493
537
|
unmarshalFtpAccount,
|
|
494
538
|
unmarshalHosting,
|
|
495
539
|
unmarshalListControlPanelsResponse,
|
|
@@ -503,5 +547,6 @@ export {
|
|
|
503
547
|
unmarshalMailAccount,
|
|
504
548
|
unmarshalResetHostingPasswordResponse,
|
|
505
549
|
unmarshalResourceSummary,
|
|
550
|
+
unmarshalSearchDomainsResponse,
|
|
506
551
|
unmarshalSession
|
|
507
552
|
};
|
|
@@ -3,6 +3,12 @@ import type { LanguageCode as StdLanguageCode } from '../../std/types.gen';
|
|
|
3
3
|
export type DnsRecordStatus = 'unknown_status' | 'valid' | 'invalid';
|
|
4
4
|
export type DnsRecordType = 'unknown_type' | 'a' | 'cname' | 'mx' | 'txt' | 'ns' | 'aaaa';
|
|
5
5
|
export type DnsRecordsStatus = 'unknown_status' | 'valid' | 'invalid';
|
|
6
|
+
export type DomainAction = 'unknown_action' | 'transfer' | 'manage_external' | 'renew';
|
|
7
|
+
export type DomainAvailabilityAction = 'unknown_action' | 'register' | 'transfer' | 'manage_external';
|
|
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';
|
|
10
|
+
export type DomainStatus = 'unknown_status' | 'valid' | 'invalid' | 'validating' | 'error';
|
|
11
|
+
export type DomainZoneOwner = 'unknown_zone_owner' | 'external' | 'scaleway' | 'online' | 'webhosting';
|
|
6
12
|
export type HostingStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
|
|
7
13
|
export type HostingSummaryStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
|
|
8
14
|
export type ListDatabaseUsersRequestOrderBy = 'username_asc' | 'username_desc';
|
|
@@ -211,6 +217,20 @@ export interface Website {
|
|
|
211
217
|
/** The SSL status of the website. */
|
|
212
218
|
sslStatus: boolean;
|
|
213
219
|
}
|
|
220
|
+
export interface DomainAvailability {
|
|
221
|
+
/** Fully qualified domain name (FQDN). */
|
|
222
|
+
name: string;
|
|
223
|
+
/** DNS zone associated with the domain. */
|
|
224
|
+
zoneName: string;
|
|
225
|
+
/** Availability status of the domain. */
|
|
226
|
+
status: DomainAvailabilityStatus;
|
|
227
|
+
/** A list of actions that can be performed on the domain. */
|
|
228
|
+
availableActions: DomainAvailabilityAction[];
|
|
229
|
+
/** Whether a hosting can be created for this domain. */
|
|
230
|
+
canCreateHosting: boolean;
|
|
231
|
+
/** Price for registering the domain. */
|
|
232
|
+
price?: Money;
|
|
233
|
+
}
|
|
214
234
|
export interface CheckUserOwnsDomainResponse {
|
|
215
235
|
/** Indicates whether the specified project owns the domain. */
|
|
216
236
|
ownsDomain: boolean;
|
|
@@ -404,6 +424,34 @@ export type DnsApiGetDomainDnsRecordsRequest = {
|
|
|
404
424
|
/** Domain associated with the DNS records. */
|
|
405
425
|
domain: string;
|
|
406
426
|
};
|
|
427
|
+
export type DnsApiGetDomainRequest = {
|
|
428
|
+
/**
|
|
429
|
+
* Region to target. If none is passed will use default region from the
|
|
430
|
+
* config.
|
|
431
|
+
*/
|
|
432
|
+
region?: ScwRegion;
|
|
433
|
+
/** Domain name to get. */
|
|
434
|
+
domainName: string;
|
|
435
|
+
/**
|
|
436
|
+
* ID of the Scaleway Project in which to get the domain to create the Web
|
|
437
|
+
* Hosting plan.
|
|
438
|
+
*/
|
|
439
|
+
projectId?: string;
|
|
440
|
+
};
|
|
441
|
+
export type DnsApiSearchDomainsRequest = {
|
|
442
|
+
/**
|
|
443
|
+
* Region to target. If none is passed will use default region from the
|
|
444
|
+
* config.
|
|
445
|
+
*/
|
|
446
|
+
region?: ScwRegion;
|
|
447
|
+
/** Domain name to search. */
|
|
448
|
+
domainName: string;
|
|
449
|
+
/**
|
|
450
|
+
* ID of the Scaleway Project in which to search the domain to create the Web
|
|
451
|
+
* Hosting plan.
|
|
452
|
+
*/
|
|
453
|
+
projectId?: string;
|
|
454
|
+
};
|
|
407
455
|
export type DnsApiSyncDomainDnsRecordsRequest = {
|
|
408
456
|
/**
|
|
409
457
|
* Region to target. If none is passed will use default region from the
|
|
@@ -418,6 +466,8 @@ export type DnsApiSyncDomainDnsRecordsRequest = {
|
|
|
418
466
|
updateMailRecords: boolean;
|
|
419
467
|
/** Whether or not to synchronize all types of records. This one has priority. */
|
|
420
468
|
updateAllRecords: boolean;
|
|
469
|
+
/** Whether or not to synchronize domain nameservers. */
|
|
470
|
+
updateNameservers: boolean;
|
|
421
471
|
/** Custom records to synchronize. */
|
|
422
472
|
customRecords?: SyncDomainDnsRecordsRequestRecord[];
|
|
423
473
|
};
|
|
@@ -429,6 +479,18 @@ export interface DnsRecords {
|
|
|
429
479
|
/** Status of the records. */
|
|
430
480
|
status: DnsRecordsStatus;
|
|
431
481
|
}
|
|
482
|
+
export interface Domain {
|
|
483
|
+
/** Name of the domain. */
|
|
484
|
+
name: string;
|
|
485
|
+
/** Current status of the domain. */
|
|
486
|
+
status: DomainStatus;
|
|
487
|
+
/** Zone owner of the domain. */
|
|
488
|
+
owner: DomainZoneOwner;
|
|
489
|
+
/** A list of actions that can be performed on the domain. */
|
|
490
|
+
availableActions: DomainAction[];
|
|
491
|
+
/** A list of DNS-related actions that can be auto configured for the domain. */
|
|
492
|
+
availableDnsActions: DomainDnsAction[];
|
|
493
|
+
}
|
|
432
494
|
export type FtpAccountApiChangeFtpAccountPasswordRequest = {
|
|
433
495
|
/**
|
|
434
496
|
* Region to target. If none is passed will use default region from the
|
|
@@ -810,6 +872,10 @@ export interface ResourceSummary {
|
|
|
810
872
|
/** Total number of active domains in the the Web Hosting plan. */
|
|
811
873
|
websitesCount: number;
|
|
812
874
|
}
|
|
875
|
+
export interface SearchDomainsResponse {
|
|
876
|
+
/** List of domains availability. */
|
|
877
|
+
domainsAvailable: DomainAvailability[];
|
|
878
|
+
}
|
|
813
879
|
export interface Session {
|
|
814
880
|
/** Logged user's session URL. */
|
|
815
881
|
url: string;
|
|
@@ -170,7 +170,7 @@ class API extends api.API {
|
|
|
170
170
|
),
|
|
171
171
|
headers: jsonContentHeaders,
|
|
172
172
|
method: "POST",
|
|
173
|
-
path: `/webhosting/
|
|
173
|
+
path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/check-ownership`
|
|
174
174
|
},
|
|
175
175
|
marshalling_gen.unmarshalCheckUserOwnsDomainResponse
|
|
176
176
|
);
|
|
@@ -168,7 +168,7 @@ class API extends API$1 {
|
|
|
168
168
|
),
|
|
169
169
|
headers: jsonContentHeaders,
|
|
170
170
|
method: "POST",
|
|
171
|
-
path: `/webhosting/
|
|
171
|
+
path: `/webhosting/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam("domain", request.domain)}/check-ownership`
|
|
172
172
|
},
|
|
173
173
|
unmarshalCheckUserOwnsDomainResponse
|
|
174
174
|
);
|
|
@@ -28,10 +28,10 @@ const assertValidSettings = (obj) => {
|
|
|
28
28
|
if (obj.defaultZone && !stringValidation.isZone(obj.defaultZone)) {
|
|
29
29
|
throw new Error(`Invalid default zone format '${obj.defaultZone}'`);
|
|
30
30
|
}
|
|
31
|
-
if (!stringValidation.isURL(obj.apiURL)) {
|
|
31
|
+
if (obj.apiURL && !stringValidation.isURL(obj.apiURL)) {
|
|
32
32
|
throw new Error(`Invalid URL ${obj.apiURL}`);
|
|
33
33
|
}
|
|
34
|
-
if (obj.apiURL
|
|
34
|
+
if (obj.apiURL?.endsWith("/")) {
|
|
35
35
|
throw new Error(
|
|
36
36
|
`Invalid URL ${obj.apiURL}: it should not have a trailing slash`
|
|
37
37
|
);
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type { NetworkInterceptors, RequestInterceptor, ResponseInterceptor } from '../internal/interceptors/types';
|
|
2
|
-
import type {
|
|
2
|
+
import type { Profile } from './client-ini-profile.js';
|
|
3
3
|
/**
|
|
4
4
|
* Holds default values of settings.
|
|
5
5
|
*
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
8
|
-
export type DefaultValues =
|
|
8
|
+
export type DefaultValues = Profile & {
|
|
9
9
|
/**
|
|
10
10
|
* The default number of results when requesting a paginated resource.
|
|
11
11
|
*/
|