@scaleway/sdk 2.57.0 → 2.58.0

package/dist/api/webhosting/v1/marshalling.gen.js

@@ -1,6 +1,6 @@
 import { isJSONObject } from "../../../helpers/json.js";
 import { unmarshalMoney } from "../../../scw/custom-marshalling.js";
-import { unmarshalDate, unmarshalArrayOfObject } from "../../../helpers/marshalling.js";
+import { unmarshalArrayOfObject, unmarshalDate } from "../../../helpers/marshalling.js";
 const unmarshalDatabaseUser = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -45,10 +45,59 @@ const unmarshalMailAccount = (data) => {
     username: data.username
   };
 };
-const unmarshalHostingCpanelUrls = (data) => {
+const unmarshalCheckUserOwnsDomainResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
-      `Unmarshalling the type 'HostingCpanelUrls' failed as data isn't a dictionary.`
+      `Unmarshalling the type 'CheckUserOwnsDomainResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    ownsDomain: data.owns_domain
+  };
+};
+const unmarshalDnsRecord = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DnsRecord' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name,
+    priority: data.priority,
+    status: data.status,
+    ttl: data.ttl,
+    type: data.type,
+    value: data.value
+  };
+};
+const unmarshalNameserver = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Nameserver' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    hostname: data.hostname,
+    isDefault: data.is_default,
+    status: data.status
+  };
+};
+const unmarshalDnsRecords = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DnsRecords' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    nameServers: unmarshalArrayOfObject(data.name_servers, unmarshalNameserver),
+    records: unmarshalArrayOfObject(data.records, unmarshalDnsRecord),
+    status: data.status
+  };
+};
+const unmarshalPlatformControlPanelUrls = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'PlatformControlPanelUrls' failed as data isn't a dictionary.`
     );
   }
   return {
@@ -56,49 +105,98 @@ const unmarshalHostingCpanelUrls = (data) => {
     webmail: data.webmail
   };
 };
-const unmarshalHostingOption = (data) => {
+const unmarshalOfferOption = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
-      `Unmarshalling the type 'HostingOption' failed as data isn't a dictionary.`
+      `Unmarshalling the type 'OfferOption' failed as data isn't a dictionary.`
     );
   }
   return {
+    billingOperationPath: data.billing_operation_path,
+    currentValue: data.current_value,
     id: data.id,
+    maxValue: data.max_value,
+    minValue: data.min_value,
     name: data.name,
-    quantity: data.quantity
+    price: data.price ? unmarshalMoney(data.price) : void 0,
+    quotaWarning: data.quota_warning
   };
 };
-const unmarshalHosting = (data) => {
+const unmarshalPlatformControlPanel = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
-      `Unmarshalling the type 'Hosting' failed as data isn't a dictionary.`
+      `Unmarshalling the type 'PlatformControlPanel' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    name: data.name,
+    urls: data.urls ? unmarshalPlatformControlPanelUrls(data.urls) : void 0
+  };
+};
+const unmarshalHostingUser = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'HostingUser' failed as data isn't a dictionary.`
     );
   }
   return {
     contactEmail: data.contact_email,
+    oneTimePassword: data.one_time_password,
+    username: data.username
+  };
+};
+const unmarshalOffer = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Offer' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    available: data.available,
+    billingOperationPath: data.billing_operation_path,
     controlPanelName: data.control_panel_name,
-    cpanelUrls: data.cpanel_urls ? unmarshalHostingCpanelUrls(data.cpanel_urls) : void 0,
+    endOfLife: data.end_of_life,
+    id: data.id,
+    options: unmarshalArrayOfObject(data.options, unmarshalOfferOption),
+    price: data.price ? unmarshalMoney(data.price) : void 0
+  };
+};
+const unmarshalPlatform = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Platform' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    controlPanel: data.control_panel ? unmarshalPlatformControlPanel(data.control_panel) : void 0,
+    groupName: data.group_name,
+    hostname: data.hostname,
+    ipv4: data.ipv4,
+    ipv6: data.ipv6,
+    number: data.number
+  };
+};
+const unmarshalHosting = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Hosting' failed as data isn't a dictionary.`
+    );
+  }
+  return {
     createdAt: unmarshalDate(data.created_at),
     dnsStatus: data.dns_status,
     domain: data.domain,
     id: data.id,
     ipv4: data.ipv4,
-    ipv6: data.ipv6,
-    offerEndOfLife: data.offer_end_of_life,
-    offerId: data.offer_id,
-    offerName: data.offer_name,
-    oneTimePassword: data.one_time_password,
-    options: unmarshalArrayOfObject(data.options, unmarshalHostingOption),
-    platformGroup: data.platform_group,
-    platformHostname: data.platform_hostname,
-    platformNumber: data.platform_number,
+    offer: data.offer ? unmarshalOffer(data.offer) : void 0,
+    platform: data.platform ? unmarshalPlatform(data.platform) : void 0,
     projectId: data.project_id,
     protected: data.protected,
     region: data.region,
     status: data.status,
     tags: data.tags,
     updatedAt: unmarshalDate(data.updated_at),
-    username: data.username
+    user: data.user ? unmarshalHostingUser(data.user) : void 0
   };
 };
 const unmarshalControlPanel = (data) => {
@@ -168,6 +266,7 @@ const unmarshalHostingSummary = (data) => {
     );
   }
   return {
+    createdAt: unmarshalDate(data.created_at),
     domain: data.domain,
     id: data.id,
     projectId: data.project_id,
@@ -202,38 +301,6 @@ const unmarshalListMailAccountsResponse = (data) => {
     totalCount: data.total_count
   };
 };
-const unmarshalOfferOption = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'OfferOption' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    billingOperationPath: data.billing_operation_path,
-    currentValue: data.current_value,
-    id: data.id,
-    maxValue: data.max_value,
-    minValue: data.min_value,
-    name: data.name,
-    quotaWarning: data.quota_warning
-  };
-};
-const unmarshalOffer = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Offer' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    available: data.available,
-    billingOperationPath: data.billing_operation_path,
-    controlPanelName: data.control_panel_name,
-    endOfLife: data.end_of_life,
-    id: data.id,
-    options: unmarshalArrayOfObject(data.options, unmarshalOfferOption),
-    price: data.price ? unmarshalMoney(data.price) : void 0
-  };
-};
 const unmarshalListOffersResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -317,6 +384,9 @@ const marshalDatabaseApiCreateDatabaseUserRequest = (request, defaults) => ({
 const marshalDatabaseApiUnassignDatabaseUserRequest = (request, defaults) => ({
   username: request.username
 });
+const marshalDnsApiCheckUserOwnsDomainRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
 const marshalFtpAccountApiChangeFtpAccountPasswordRequest = (request, defaults) => ({
   password: request.password
 });
@@ -379,6 +449,7 @@ export {
   marshalDatabaseApiCreateDatabaseRequest,
   marshalDatabaseApiCreateDatabaseUserRequest,
   marshalDatabaseApiUnassignDatabaseUserRequest,
+  marshalDnsApiCheckUserOwnsDomainRequest,
   marshalFtpAccountApiChangeFtpAccountPasswordRequest,
   marshalFtpAccountApiCreateFtpAccountRequest,
   marshalHostingApiCreateHostingRequest,
@@ -386,8 +457,10 @@ export {
   marshalMailAccountApiChangeMailAccountPasswordRequest,
   marshalMailAccountApiCreateMailAccountRequest,
   marshalMailAccountApiRemoveMailAccountRequest,
+  unmarshalCheckUserOwnsDomainResponse,
   unmarshalDatabase,
   unmarshalDatabaseUser,
+  unmarshalDnsRecords,
   unmarshalFtpAccount,
   unmarshalHosting,
   unmarshalListControlPanelsResponse,

package/dist/api/webhosting/v1/types.gen.d.ts

@@ -1,6 +1,8 @@
 import type { Money, Region } from '../../../bridge';
 import type { LanguageCode as StdLanguageCode } from '../../std/types.gen';
-export type HostingDnsStatus = 'unknown_dns_status' | 'valid' | 'invalid';
+export type DnsRecordStatus = 'unknown_status' | 'valid' | 'invalid';
+export type DnsRecordType = 'unknown_type' | 'a' | 'cname' | 'mx' | 'txt' | 'ns' | 'aaaa';
+export type DnsRecordsStatus = 'unknown_status' | 'valid' | 'invalid';
 export type HostingStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
 export type HostingSummaryStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
 export type ListDatabaseUsersRequestOrderBy = 'username_asc' | 'username_desc';
@@ -10,8 +12,16 @@ export type ListHostingsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
 export type ListMailAccountsRequestOrderBy = 'username_asc' | 'username_desc' | 'domain_asc' | 'domain_desc';
 export type ListOffersRequestOrderBy = 'price_asc';
 export type ListWebsitesRequestOrderBy = 'domain_asc' | 'domain_desc';
+export type NameserverStatus = 'unknown_status' | 'valid' | 'invalid';
 export type OfferOptionName = 'unknown_name' | 'domain_count' | 'email_count' | 'storage_gb' | 'vcpu_count' | 'ram_gb' | 'backup' | 'dedicated_ip';
 export type OfferOptionWarning = 'unknown_warning' | 'quota_exceeded_warning';
+export type PlatformPlatformGroup = 'unknown_group' | 'default' | 'premium';
+export interface PlatformControlPanelUrls {
+    /** URL to connect to the hosting control panel dashboard. */
+    dashboard: string;
+    /** URL to connect to the hosting Webmail interface. */
+    webmail: string;
+}
 export interface OfferOption {
     /** Option ID. */
     id: string;
@@ -30,6 +40,14 @@ export interface OfferOption {
     maxValue: number;
     /** Defines a warning if the maximum value for the option has been reached. */
     quotaWarning: OfferOptionWarning;
+    /** Price of the option for 1 value. */
+    price?: Money;
+}
+export interface PlatformControlPanel {
+    /** Name of the control panel. */
+    name: string;
+    /** URL to connect to cPanel dashboard and to Webmail interface. */
+    urls?: PlatformControlPanelUrls;
 }
 export interface CreateHostingRequestDomainConfiguration {
     updateNameservers: boolean;
@@ -43,17 +61,71 @@ export interface OfferOptionRequest {
     /** The option requested quantity to set for the Web Hosting plan. */
     quantity: number;
 }
-export interface HostingCpanelUrls {
-    dashboard: string;
-    webmail: string;
+export interface DnsRecord {
+    /** Record name. */
+    name: string;
+    /** Record type. */
+    type: DnsRecordType;
+    /** Record time-to-live. */
+    ttl: number;
+    /** Record value. */
+    value: string;
+    /** Record priority level. */
+    priority?: number;
+    /** Record status. */
+    status: DnsRecordStatus;
 }
-export interface HostingOption {
-    /** Option ID. */
+export interface Nameserver {
+    /** Hostname of the nameserver. */
+    hostname: string;
+    /** Status of the nameserver. */
+    status: NameserverStatus;
+    /** Defines whether the nameserver is the default one. */
+    isDefault: boolean;
+}
+export interface HostingUser {
+    /** Main Web Hosting cPanel username. */
+    username: string;
+    /**
+     * One-time-password used for the first login or reset password, empty after
+     * first use.
+     */
+    oneTimePassword?: string;
+    /** Contact email used for the hosting. */
+    contactEmail: string;
+}
+export interface Offer {
+    /** Offer ID. */
     id: string;
-    /** Option name. */
-    name: OfferOptionName;
-    /** Option quantity. */
-    quantity: number;
+    /** Unique identifier used for billing. */
+    billingOperationPath: string;
+    /** Options available for the offer. */
+    options: OfferOption[];
+    /** Price of the offer. */
+    price?: Money;
+    /**
+     * If a hosting_id was specified in the call, defines whether the offer is
+     * available for a specified hosting plan to migrate (update) to.
+     */
+    available: boolean;
+    /** Name of the control panel. */
+    controlPanelName: string;
+    /** Indicates if the offer has reached its end of life. */
+    endOfLife: boolean;
+}
+export interface Platform {
+    /** Hostname of the host platform. */
+    hostname: string;
+    /** Number of the host platform. */
+    number: number;
+    /** Group name of the hosting's host platform. */
+    groupName: PlatformPlatformGroup;
+    /** IPv4 address of the hosting's host platform. */
+    ipv4: string;
+    /** IPv6 address of the hosting's host platform. */
+    ipv6: string;
+    /** Details of the platform control panel. */
+    controlPanel?: PlatformControlPanel;
 }
 export interface ControlPanel {
     /** Control panel name. */
@@ -88,6 +160,8 @@ export interface HostingSummary {
     id: string;
     /** ID of the Scaleway Project the Web Hosting plan belongs to. */
     projectId: string;
+    /** Date on which the Web Hosting plan was created. */
+    createdAt?: Date;
     /** Date on which the Web Hosting plan was last updated. */
     updatedAt?: Date;
     /** Status of the Web Hosting plan. */
@@ -105,25 +179,6 @@ export interface MailAccount {
     /** Username part address of the mail account address. */
     username: string;
 }
-export interface Offer {
-    /** Offer ID. */
-    id: string;
-    /** Unique identifier used for billing. */
-    billingOperationPath: string;
-    /** Options available for the offer. */
-    options: OfferOption[];
-    /** Price of the offer. */
-    price?: Money;
-    /**
-     * If a hosting_id was specified in the call, defines whether the offer is
-     * available for a specified hosting plan to migrate (update) to.
-     */
-    available: boolean;
-    /** Name of the control panel. */
-    controlPanelName: string;
-    /** Indicates if the offer has reached its end of life. */
-    endOfLife: boolean;
-}
 export interface Website {
     /** The domain of the website. */
     domain: string;
@@ -132,6 +187,10 @@ export interface Website {
     /** The SSL status of the website. */
     sslStatus: boolean;
 }
+export interface CheckUserOwnsDomainResponse {
+    /** Indicates whether the specified project owns the domain. */
+    ownsDomain: boolean;
+}
 export type ControlPanelApiListControlPanelsRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -289,6 +348,34 @@ export type DatabaseApiUnassignDatabaseUserRequest = {
     /** Name of the user to unassign. */
     username: string;
 };
+export type DnsApiCheckUserOwnsDomainRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Domain for which ownership is to be verified. */
+    domain: string;
+    /** ID of the project currently in use. */
+    projectId?: string;
+};
+export type DnsApiGetDomainDnsRecordsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Domain associated with the DNS records. */
+    domain: string;
+};
+export interface DnsRecords {
+    /** List of DNS records. */
+    records: DnsRecord[];
+    /** List of nameservers. */
+    nameServers: Nameserver[];
+    /** Status of the records. */
+    status: DnsRecordsStatus;
+}
 export type FtpAccountApiChangeFtpAccountPasswordRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -359,45 +446,22 @@ export interface Hosting {
     createdAt?: Date;
     /** Status of the Web Hosting plan. */
     status: HostingStatus;
-    /** Hostname of the host platform. */
-    platformHostname: string;
-    /** Number of the host platform. */
-    platformNumber: number;
-    /** ID of the active offer for the Web Hosting plan. */
-    offerId: string;
-    /** Name of the active offer for the Web Hosting plan. */
-    offerName: string;
     /** Main domain associated with the Web Hosting plan. */
     domain: string;
+    /** Details of the Web Hosting plan offer and options. */
+    offer?: Offer;
+    /** Details of the hosting platform. */
+    platform?: Platform;
     /** List of tags associated with the Web Hosting plan. */
     tags: string[];
-    /** List of the Web Hosting plan options. */
-    options: HostingOption[];
     /** DNS status of the Web Hosting plan. */
-    dnsStatus: HostingDnsStatus;
-    /** URL to connect to cPanel dashboard and to Webmail interface. */
-    cpanelUrls?: HostingCpanelUrls;
-    /** Main Web Hosting cPanel username. */
-    username: string;
-    /** Indicates if the hosting offer has reached its end of life. */
-    offerEndOfLife: boolean;
-    /** Name of the control panel. */
-    controlPanelName: string;
-    /** Group of the hosting's host server/platform. */
-    platformGroup: string;
-    /** IPv4 address of the hosting's host server. */
+    dnsStatus: DnsRecordsStatus;
+    /** Current IPv4 address of the hosting. */
     ipv4: string;
-    /** IPv6 address of the hosting's host server. */
-    ipv6: string;
     /** Whether the hosting is protected or not. */
     protected: boolean;
-    /**
-     * One-time-password used for the first login or reset password, empty after
-     * first use.
-     */
-    oneTimePassword: string;
-    /** Contact email used for the hosting. */
-    contactEmail: string;
+    /** Details of the hosting user. */
+    user?: HostingUser;
     /** Region where the Web Hosting plan is hosted. */
     region: Region;
 }

package/dist/scw/constants.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const version = "v2.56.0";
+const version = "v2.57.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 exports.userAgent = userAgent;
 exports.version = version;

package/dist/scw/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const version = "v2.56.0";
-export declare const userAgent = "scaleway-sdk-js/v2.56.0";
+export declare const version = "v2.57.0";
+export declare const userAgent = "scaleway-sdk-js/v2.57.0";

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = "v2.56.0";
+const version = "v2.57.0";
 const userAgent = `scaleway-sdk-js/${version}`;
 export {
   userAgent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "2.57.0",
+  "version": "2.58.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -39,5 +39,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "f862c338853321a98d5d14686092625862ffdf5f"
+  "gitHead": "62bf1f104066d4ef19d4ce5adca02b3c5f4b937e"
 }