@scaleway/sdk-webhosting 1.3.0 → 2.1.1

package/dist/v1/marshalling.gen.d.ts

@@ -1,11 +1,12 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { Backup, BackupApiRestoreBackupItemsRequest, CheckFreeDomainAvailabilityResponse, CheckUserOwnsDomainResponse, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FreeDomainApiCheckFreeDomainAvailabilityRequest, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, Hosting, HostingApiAddCustomDomainRequest, HostingApiCreateHostingRequest, HostingApiRemoveCustomDomainRequest, HostingApiUpdateHostingRequest, HostingSummary, ListBackupItemsResponse, ListBackupsResponse, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFreeRootDomainsResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListRecentProgressesResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiRemoveMailAccountRequest, Progress, ResetHostingPasswordResponse, ResourceSummary, RestoreBackupItemsResponse, RestoreBackupResponse, SearchDomainsResponse, Session } from './types.gen.js';
+import type { Backup, BackupApiRestoreBackupItemsRequest, CheckFreeDomainAvailabilityResponse, CheckUserOwnsDomainResponse, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FreeDomainApiCheckFreeDomainAvailabilityRequest, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, Hosting, HostingApiAddCustomDomainRequest, HostingApiCreateHostingRequest, HostingApiMigrateControlPanelRequest, HostingApiRemoveCustomDomainRequest, HostingApiUpdateHostingRequest, HostingSummary, ListBackupItemsResponse, ListBackupsResponse, ListControlPanelsResponse, ListDatabasesResponse, ListDatabaseUsersResponse, ListFreeRootDomainsResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListRecentProgressesResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiRemoveMailAccountRequest, Progress, ResetHostingPasswordResponse, ResourceSummary, RestoreBackupItemsResponse, RestoreBackupResponse, SearchDomainsResponse, Session, Website, WebsiteApiCreateWebsiteRequest } from './types.gen.js';
 export declare const unmarshalBackup: (data: unknown) => Backup;
 export declare const unmarshalDatabaseUser: (data: unknown) => DatabaseUser;
 export declare const unmarshalDatabase: (data: unknown) => Database;
 export declare const unmarshalFtpAccount: (data: unknown) => FtpAccount;
 export declare const unmarshalHostingSummary: (data: unknown) => HostingSummary;
 export declare const unmarshalMailAccount: (data: unknown) => MailAccount;
+export declare const unmarshalWebsite: (data: unknown) => Website;
 export declare const unmarshalCheckFreeDomainAvailabilityResponse: (data: unknown) => CheckFreeDomainAvailabilityResponse;
 export declare const unmarshalCheckUserOwnsDomainResponse: (data: unknown) => CheckUserOwnsDomainResponse;
 export declare const unmarshalDnsRecords: (data: unknown) => DnsRecords;
@@ -43,8 +44,10 @@ export declare const marshalFtpAccountApiChangeFtpAccountPasswordRequest: (reque
 export declare const marshalFtpAccountApiCreateFtpAccountRequest: (request: FtpAccountApiCreateFtpAccountRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalHostingApiAddCustomDomainRequest: (request: HostingApiAddCustomDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalHostingApiCreateHostingRequest: (request: HostingApiCreateHostingRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalHostingApiMigrateControlPanelRequest: (request: HostingApiMigrateControlPanelRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalHostingApiRemoveCustomDomainRequest: (request: HostingApiRemoveCustomDomainRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalHostingApiUpdateHostingRequest: (request: HostingApiUpdateHostingRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalMailAccountApiChangeMailAccountPasswordRequest: (request: MailAccountApiChangeMailAccountPasswordRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalMailAccountApiCreateMailAccountRequest: (request: MailAccountApiCreateMailAccountRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalMailAccountApiRemoveMailAccountRequest: (request: MailAccountApiRemoveMailAccountRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalWebsiteApiCreateWebsiteRequest: (request: WebsiteApiCreateWebsiteRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/v1/marshalling.gen.js

@@ -116,6 +116,18 @@ const unmarshalMailAccount = (data) => {
     username: data.username
   };
 };
+const unmarshalWebsite = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Website' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    domain: data.domain,
+    path: data.path,
+    sslStatus: data.ssl_status
+  };
+};
 const unmarshalFreeDomain = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -218,6 +230,19 @@ const unmarshalPlatformControlPanelUrls = (data) => {
     webmail: data.webmail
   };
 };
+const unmarshalControlPanel = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ControlPanel' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    available: data.available,
+    availableLanguages: data.available_languages,
+    logoUrl: data.logo_url,
+    name: data.name
+  };
+};
 const unmarshalOfferOption = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -269,6 +294,7 @@ const unmarshalOffer = (data) => {
     available: data.available,
     billingOperationPath: data.billing_operation_path,
     controlPanelName: data.control_panel_name,
+    controlPanels: unmarshalArrayOfObject(data.control_panels, unmarshalControlPanel),
     endOfLife: data.end_of_life,
     id: data.id,
     name: data.name,
@@ -366,19 +392,6 @@ const unmarshalListBackupsResponse = (data) => {
     totalCount: data.total_count
   };
 };
-const unmarshalControlPanel = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ControlPanel' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    available: data.available,
-    availableLanguages: data.available_languages,
-    logoUrl: data.logo_url,
-    name: data.name
-  };
-};
 const unmarshalListControlPanelsResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -386,10 +399,7 @@ const unmarshalListControlPanelsResponse = (data) => {
     );
   }
   return {
-    controlPanels: unmarshalArrayOfObject(
-      data.control_panels,
-      unmarshalControlPanel
-    ),
+    controlPanels: unmarshalArrayOfObject(data.control_panels, unmarshalControlPanel),
     totalCount: data.total_count
   };
 };
@@ -455,10 +465,7 @@ const unmarshalListMailAccountsResponse = (data) => {
     );
   }
   return {
-    mailAccounts: unmarshalArrayOfObject(
-      data.mail_accounts,
-      unmarshalMailAccount
-    ),
+    mailAccounts: unmarshalArrayOfObject(data.mail_accounts, unmarshalMailAccount),
     totalCount: data.total_count
   };
 };
@@ -493,22 +500,7 @@ const unmarshalListRecentProgressesResponse = (data) => {
     );
   }
   return {
-    progresses: unmarshalArrayOfObject(
-      data.progresses,
-      unmarshalProgressSummary
-    )
-  };
-};
-const unmarshalWebsite = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Website' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    domain: data.domain,
-    path: data.path,
-    sslStatus: data.ssl_status
+    progresses: unmarshalArrayOfObject(data.progresses, unmarshalProgressSummary)
   };
 };
 const unmarshalListWebsitesResponse = (data) => {
@@ -529,10 +521,7 @@ const unmarshalProgress = (data) => {
     );
   }
   return {
-    backupItemGroups: unmarshalArrayOfObject(
-      data.backup_item_groups,
-      unmarshalBackupItemGroup
-    ),
+    backupItemGroups: unmarshalArrayOfObject(data.backup_item_groups, unmarshalBackupItemGroup),
     id: data.id,
     percentage: data.percentage,
     status: data.status
@@ -604,10 +593,7 @@ const unmarshalSearchDomainsResponse = (data) => {
     );
   }
   return {
-    domainsAvailable: unmarshalArrayOfObject(
-      data.domains_available,
-      unmarshalDomainAvailability
-    )
+    domainsAvailable: unmarshalArrayOfObject(data.domains_available, unmarshalDomainAvailability)
   };
 };
 const unmarshalSession = (data) => {
@@ -640,7 +626,10 @@ const marshalDatabaseApiCreateDatabaseRequest = (request, defaults) => ({
       param: "new_user",
       value: request.newUser !== void 0 ? marshalCreateDatabaseRequestUser(request.newUser) : void 0
     },
-    { param: "existing_username", value: request.existingUsername }
+    {
+      param: "existing_username",
+      value: request.existingUsername
+    }
   ])
 });
 const marshalDatabaseApiCreateDatabaseUserRequest = (request, defaults) => ({
@@ -666,9 +655,7 @@ const marshalSyncDomainDnsRecordsRequestRecord = (request, defaults) => ({
 });
 const marshalDnsApiSyncDomainDnsRecordsRequest = (request, defaults) => ({
   auto_config_domain_dns: request.autoConfigDomainDns !== void 0 ? marshalAutoConfigDomainDns(request.autoConfigDomainDns) : void 0,
-  custom_records: request.customRecords !== void 0 ? request.customRecords.map(
-    (elt) => marshalSyncDomainDnsRecordsRequestRecord(elt)
-  ) : void 0,
+  custom_records: request.customRecords !== void 0 ? request.customRecords.map((elt) => marshalSyncDomainDnsRecordsRequestRecord(elt)) : void 0,
   update_all_records: request.updateAllRecords,
   update_mail_records: request.updateMailRecords,
   update_nameservers: request.updateNameservers,
@@ -702,29 +689,27 @@ const marshalOfferOptionRequest = (request, defaults) => ({
 const marshalHostingApiCreateHostingRequest = (request, defaults) => ({
   auto_config_domain_dns: request.autoConfigDomainDns !== void 0 ? marshalAutoConfigDomainDns(request.autoConfigDomainDns) : void 0,
   domain: request.domain,
-  domain_configuration: request.domainConfiguration !== void 0 ? marshalCreateHostingRequestDomainConfiguration(
-    request.domainConfiguration
-  ) : void 0,
+  domain_configuration: request.domainConfiguration !== void 0 ? marshalCreateHostingRequestDomainConfiguration(request.domainConfiguration) : void 0,
   email: request.email,
   language: request.language,
   offer_id: request.offerId,
-  offer_options: request.offerOptions !== void 0 ? request.offerOptions.map(
-    (elt) => marshalOfferOptionRequest(elt)
-  ) : void 0,
+  offer_options: request.offerOptions !== void 0 ? request.offerOptions.map((elt) => marshalOfferOptionRequest(elt)) : void 0,
   project_id: request.projectId ?? defaults.defaultProjectId,
   skip_welcome_email: request.skipWelcomeEmail,
   subdomain: request.subdomain,
   tags: request.tags
 });
+const marshalHostingApiMigrateControlPanelRequest = (request, defaults) => ({
+  control_panel_name: request.controlPanelName,
+  offer_id: request.offerId
+});
 const marshalHostingApiRemoveCustomDomainRequest = (request, defaults) => ({
   domain_name: request.domainName
 });
 const marshalHostingApiUpdateHostingRequest = (request, defaults) => ({
   email: request.email,
   offer_id: request.offerId,
-  offer_options: request.offerOptions !== void 0 ? request.offerOptions.map(
-    (elt) => marshalOfferOptionRequest(elt)
-  ) : void 0,
+  offer_options: request.offerOptions !== void 0 ? request.offerOptions.map((elt) => marshalOfferOptionRequest(elt)) : void 0,
   protected: request.protected,
   tags: request.tags
 });
@@ -742,6 +727,9 @@ const marshalMailAccountApiRemoveMailAccountRequest = (request, defaults) => ({
   domain: request.domain,
   username: request.username
 });
+const marshalWebsiteApiCreateWebsiteRequest = (request, defaults) => ({
+  domain_name: request.domainName
+});
 export {
   marshalBackupApiRestoreBackupItemsRequest,
   marshalDatabaseApiAssignDatabaseUserRequest,
@@ -756,11 +744,13 @@ export {
   marshalFtpAccountApiCreateFtpAccountRequest,
   marshalHostingApiAddCustomDomainRequest,
   marshalHostingApiCreateHostingRequest,
+  marshalHostingApiMigrateControlPanelRequest,
   marshalHostingApiRemoveCustomDomainRequest,
   marshalHostingApiUpdateHostingRequest,
   marshalMailAccountApiChangeMailAccountPasswordRequest,
   marshalMailAccountApiCreateMailAccountRequest,
   marshalMailAccountApiRemoveMailAccountRequest,
+  marshalWebsiteApiCreateWebsiteRequest,
   unmarshalBackup,
   unmarshalCheckFreeDomainAvailabilityResponse,
   unmarshalCheckUserOwnsDomainResponse,
@@ -790,5 +780,6 @@ export {
   unmarshalRestoreBackupItemsResponse,
   unmarshalRestoreBackupResponse,
   unmarshalSearchDomainsResponse,
-  unmarshalSession
+  unmarshalSession,
+  unmarshalWebsite
 };

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

@@ -22,7 +22,7 @@ export type ListMailAccountsRequestOrderBy = 'username_asc' | 'username_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' | 'email_storage_gb' | 'database_count' | 'support';
+export type OfferOptionName = 'unknown_name' | 'domain_count' | 'email_count' | 'storage_gb' | 'vcpu_count' | 'ram_gb' | 'backup' | 'dedicated_ip' | 'email_storage_gb' | 'database_count' | 'support' | 'additional_email';
 export type OfferOptionWarning = 'unknown_warning' | 'quota_exceeded_warning' | 'usage_low_warning';
 export type PlatformPlatformGroup = 'unknown_group' | 'default' | 'premium';
 export type ProgressStatus = 'unknown_status' | 'pending' | 'processing' | 'completed' | 'partially_completed' | 'failed' | 'aborted' | 'never_finished';
@@ -76,6 +76,24 @@ export interface HostingDomainCustomDomain {
      */
     autoConfigDomainDns?: AutoConfigDomainDns;
 }
+export interface ControlPanel {
+    /**
+     * Control panel name.
+     */
+    name: string;
+    /**
+     * Define if the control panel type is available to order.
+     */
+    available: boolean;
+    /**
+     * URL of the control panel's logo.
+     */
+    logoUrl: string;
+    /**
+     * List of available languages for the control panel.
+     */
+    availableLanguages: StdLanguageCode[];
+}
 export interface OfferOption {
     /**
      * Option ID.
@@ -289,6 +307,10 @@ export interface Offer {
      * Defines a warning if the maximum value for an option in the offer is exceeded.
      */
     quotaWarning: OfferOptionWarning;
+    /**
+     * Lists available control panels for the specified offer.
+     */
+    controlPanels: ControlPanel[];
     /**
      * Region where the offer is hosted.
      */
@@ -352,24 +374,6 @@ export interface Backup {
      */
     totalItems: number;
 }
-export interface ControlPanel {
-    /**
-     * Control panel name.
-     */
-    name: string;
-    /**
-     * Define if the control panel type is available to order.
-     */
-    available: boolean;
-    /**
-     * URL of the control panel's logo.
-     */
-    logoUrl: string;
-    /**
-     * List of available languages for the control panel.
-     */
-    availableLanguages: StdLanguageCode[];
-}
 export interface DatabaseUser {
     /**
      * Name of the database user.
@@ -1314,6 +1318,24 @@ export type HostingApiListHostingsRequest = {
      */
     subdomain?: string;
 };
+export type HostingApiMigrateControlPanelRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Hosting ID to migrate to a new control panel.
+     */
+    hostingId: string;
+    /**
+     * Control panel will migrate the hosting to a new server.
+     */
+    controlPanelName: string;
+    /**
+     * Migration.
+     */
+    offerId: string;
+};
 export type HostingApiRemoveCustomDomainRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.
@@ -1668,6 +1690,34 @@ export interface Session {
      */
     url: string;
 }
+export type WebsiteApiCreateWebsiteRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Hosting ID to which the website is attached to.
+     */
+    hostingId: string;
+    /**
+     * The new domain name or subdomain to use for the website.
+     */
+    domainName: string;
+};
+export type WebsiteApiDeleteWebsiteRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Hosting ID to which the website is detached from.
+     */
+    hostingId: string;
+    /**
+     * The new domain name or subdomain attached to the website.
+     */
+    domainName: string;
+};
 export type WebsiteApiListWebsitesRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-webhosting",
-  "version": "1.3.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK webhosting",
   "license": "Apache-2.0",
   "files": [
+    "README.md",
     "dist"
   ],
   "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.gen.d.ts",
-      "import": "./dist/index.gen.js",
-      "require": "./dist/index.gen.cjs",
       "default": "./dist/index.gen.js"
     },
     "./*": {
       "types": "./dist/*/index.gen.d.ts",
-      "import": "./dist/*/index.gen.js",
-      "require": "./dist/*/index.gen.cjs",
       "default": "./dist/*/index.gen.js"
     }
   },
@@ -26,17 +23,17 @@
     "directory": "packages_generated/webhosting"
   },
   "engines": {
-    "node": ">=20.19.4"
+    "node": ">=20.19.6"
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.1.0"
+    "@scaleway/sdk-std": "2.1.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.2"
+    "@scaleway/sdk-client": "^2.1.0"
   },
   "scripts": {
     "package:check": "pnpm publint",

package/dist/index.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1/index.gen.cjs");
-exports.Webhostingv1 = index_gen;