@scaleway/sdk-webhosting 1.1.2 → 1.2.0

package/dist/v1/api.gen.cjs

@@ -6,13 +6,122 @@ const marshalling_gen = require("./marshalling.gen.cjs");
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
+class BackupAPI extends sdkClient.API {
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
+  pageOfListBackups = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/backups`,
+      urlParams: sdkClient.urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListBackupsResponse
+  );
+  /**
+   * List all available backups for a hosting account.. List all available backups for a hosting account.
+   *
+   * @param request - The request {@link BackupApiListBackupsRequest}
+   * @returns A Promise of ListBackupsResponse
+   */
+  listBackups = (request) => sdkClient.enrichForPagination("backups", this.pageOfListBackups, request);
+  /**
+   * Get info about a backup specified by the backup ID.. Get info about a backup specified by the backup ID.
+   *
+   * @param request - The request {@link BackupApiGetBackupRequest}
+   * @returns A Promise of Backup
+   */
+  getBackup = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/backups/${sdkClient.validatePathParam("backupId", request.backupId)}`
+    },
+    marshalling_gen.unmarshalBackup
+  );
+  /**
+   * Waits for {@link Backup} to be in a final state.
+   *
+   * @param request - The request {@link BackupApiGetBackupRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Backup
+   */
+  waitForBackup = (request, options) => sdkClient.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(
+      !content_gen.BACKUP_TRANSIENT_STATUSES.includes(res.status)
+    )),
+    this.getBackup,
+    request,
+    options
+  );
+  /**
+   * Restore an entire backup to your hosting environment.. Restore an entire backup to your hosting environment.
+   *
+   * @param request - The request {@link BackupApiRestoreBackupRequest}
+   * @returns A Promise of RestoreBackupResponse
+   */
+  restoreBackup = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/backups/${sdkClient.validatePathParam("backupId", request.backupId)}/restore`
+    },
+    marshalling_gen.unmarshalRestoreBackupResponse
+  );
+  /**
+   * List items within a specific backup, grouped by type.. List items within a specific backup, grouped by type.
+   *
+   * @param request - The request {@link BackupApiListBackupItemsRequest}
+   * @returns A Promise of ListBackupItemsResponse
+   */
+  listBackupItems = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/backup-items`,
+      urlParams: sdkClient.urlParams(["backup_id", request.backupId])
+    },
+    marshalling_gen.unmarshalListBackupItemsResponse
+  );
+  /**
+   * Restore specific items from a backup (e.g., a database or mailbox).. Restore specific items from a backup (e.g., a database or mailbox).
+   *
+   * @param request - The request {@link BackupApiRestoreBackupItemsRequest}
+   * @returns A Promise of RestoreBackupItemsResponse
+   */
+  restoreBackupItems = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalBackupApiRestoreBackupItemsRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/restore-backup-items`
+    },
+    marshalling_gen.unmarshalRestoreBackupItemsResponse
+  );
+}
 class ControlPanelAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListControlPanels = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -36,12 +145,13 @@ class ControlPanelAPI extends sdkClient.API {
   listControlPanels = (request = {}) => sdkClient.enrichForPagination("controlPanels", this.pageOfListControlPanels, request);
 }
 class DatabaseAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * "Create a new database within your hosting plan".
    *
@@ -240,12 +350,13 @@ class DatabaseAPI extends sdkClient.API {
   );
 }
 class DnsAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain.
    *
@@ -262,6 +373,7 @@ class DnsAPI extends sdkClient.API {
   /**
    * Check whether you own this domain or not.. Check whether you own this domain or not.
    *
+   * @deprecated
    * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
    * @returns A Promise of CheckUserOwnsDomainResponse
    */
@@ -353,12 +465,13 @@ class DnsAPI extends sdkClient.API {
   );
 }
 class OfferAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListOffers = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -385,12 +498,13 @@ class OfferAPI extends sdkClient.API {
   listOffers = (request = {}) => sdkClient.enrichForPagination("offers", this.pageOfListOffers, request);
 }
 class HostingAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the `offer_id` parameter.
    *
@@ -424,6 +538,7 @@ class HostingAPI extends sdkClient.API {
         ],
         ["project_id", request.projectId],
         ["statuses", request.statuses],
+        ["subdomain", request.subdomain],
         ["tags", request.tags]
       )
     },
@@ -537,14 +652,50 @@ class HostingAPI extends sdkClient.API {
     },
     marshalling_gen.unmarshalResourceSummary
   );
+  /**
+   * Attach a custom domain to a webhosting.
+   *
+   * @param request - The request {@link HostingApiAddCustomDomainRequest}
+   * @returns A Promise of HostingSummary
+   */
+  addCustomDomain = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalHostingApiAddCustomDomainRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/add-custom-domain`
+    },
+    marshalling_gen.unmarshalHostingSummary
+  );
+  /**
+   * Detach a custom domain from a webhosting.
+   *
+   * @param request - The request {@link HostingApiRemoveCustomDomainRequest}
+   * @returns A Promise of HostingSummary
+   */
+  removeCustomDomain = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/hostings/${sdkClient.validatePathParam("hostingId", request.hostingId)}/remove-custom-domain`
+    },
+    marshalling_gen.unmarshalHostingSummary
+  );
 }
 class FtpAccountAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan.
    *
@@ -617,12 +768,13 @@ class FtpAccountAPI extends sdkClient.API {
   );
 }
 class MailAccountAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.
    *
@@ -708,12 +860,13 @@ class MailAccountAPI extends sdkClient.API {
   );
 }
 class WebsiteAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListWebsites = (request) => this.client.fetch(
     {
       method: "GET",
@@ -737,6 +890,7 @@ class WebsiteAPI extends sdkClient.API {
    */
   listWebsites = (request) => sdkClient.enrichForPagination("websites", this.pageOfListWebsites, request);
 }
+exports.BackupAPI = BackupAPI;
 exports.ControlPanelAPI = ControlPanelAPI;
 exports.DatabaseAPI = DatabaseAPI;
 exports.DnsAPI = DnsAPI;

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

@@ -1,14 +1,76 @@
+import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
-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';
+import type { Backup, BackupApiGetBackupRequest, BackupApiListBackupItemsRequest, BackupApiListBackupsRequest, BackupApiRestoreBackupItemsRequest, BackupApiRestoreBackupRequest, CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabasesRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiAddCustomDomainRequest, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiRemoveCustomDomainRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingSummary, ListBackupItemsResponse, ListBackupsResponse, ListControlPanelsResponse, ListDatabasesResponse, ListDatabaseUsersResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, ResetHostingPasswordResponse, ResourceSummary, RestoreBackupItemsResponse, RestoreBackupResponse, SearchDomainsResponse, Session, WebsiteApiListWebsitesRequest } from './types.gen';
+/**
+ * Web Hosting backup API.
+
+This API allows you to list and restore backups for your cPanel and WordPress Web Hosting service.
+ */
+export declare class BackupAPI extends ParentAPI {
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
+    protected pageOfListBackups: (request: Readonly<BackupApiListBackupsRequest>) => Promise<ListBackupsResponse>;
+    /**
+     * List all available backups for a hosting account.. List all available backups for a hosting account.
+     *
+     * @param request - The request {@link BackupApiListBackupsRequest}
+     * @returns A Promise of ListBackupsResponse
+     */
+    listBackups: (request: Readonly<BackupApiListBackupsRequest>) => Promise<ListBackupsResponse> & {
+        all: () => Promise<Backup[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Backup[], void, void>;
+    };
+    /**
+     * Get info about a backup specified by the backup ID.. Get info about a backup specified by the backup ID.
+     *
+     * @param request - The request {@link BackupApiGetBackupRequest}
+     * @returns A Promise of Backup
+     */
+    getBackup: (request: Readonly<BackupApiGetBackupRequest>) => Promise<Backup>;
+    /**
+     * Waits for {@link Backup} to be in a final state.
+     *
+     * @param request - The request {@link BackupApiGetBackupRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Backup
+     */
+    waitForBackup: (request: Readonly<BackupApiGetBackupRequest>, options?: Readonly<WaitForOptions<Backup>>) => Promise<Backup>;
+    /**
+     * Restore an entire backup to your hosting environment.. Restore an entire backup to your hosting environment.
+     *
+     * @param request - The request {@link BackupApiRestoreBackupRequest}
+     * @returns A Promise of RestoreBackupResponse
+     */
+    restoreBackup: (request: Readonly<BackupApiRestoreBackupRequest>) => Promise<RestoreBackupResponse>;
+    /**
+     * List items within a specific backup, grouped by type.. List items within a specific backup, grouped by type.
+     *
+     * @param request - The request {@link BackupApiListBackupItemsRequest}
+     * @returns A Promise of ListBackupItemsResponse
+     */
+    listBackupItems: (request: Readonly<BackupApiListBackupItemsRequest>) => Promise<ListBackupItemsResponse>;
+    /**
+     * Restore specific items from a backup (e.g., a database or mailbox).. Restore specific items from a backup (e.g., a database or mailbox).
+     *
+     * @param request - The request {@link BackupApiRestoreBackupItemsRequest}
+     * @returns A Promise of RestoreBackupItemsResponse
+     */
+    restoreBackupItems: (request: Readonly<BackupApiRestoreBackupItemsRequest>) => Promise<RestoreBackupItemsResponse>;
+}
 /**
  * Web Hosting Control Panel API.
 
 This API allows you to manage your Web Hosting services.
  */
 export declare class ControlPanelAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     protected pageOfListControlPanels: (request?: Readonly<ControlPanelApiListControlPanelsRequest>) => Promise<ListControlPanelsResponse>;
     /**
      * "List the control panels type: cpanel or plesk.".
@@ -27,8 +89,11 @@ export declare class ControlPanelAPI extends ParentAPI {
 This API allows you to manage your databases and database users for your Web Hosting services.
  */
 export declare class DatabaseAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * "Create a new database within your hosting plan".
      *
@@ -121,8 +186,11 @@ export declare class DatabaseAPI extends ParentAPI {
 This API allows you to manage your Web Hosting services.
  */
 export declare class DnsAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain.
      *
@@ -133,6 +201,7 @@ export declare class DnsAPI extends ParentAPI {
     /**
      * Check whether you own this domain or not.. Check whether you own this domain or not.
      *
+     * @deprecated
      * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
      * @returns A Promise of CheckUserOwnsDomainResponse
      */
@@ -173,8 +242,11 @@ export declare class DnsAPI extends ParentAPI {
 This API allows you to manage your offer for your Web Hosting services.
  */
 export declare class OfferAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     protected pageOfListOffers: (request?: Readonly<OfferApiListOffersRequest>) => Promise<ListOffersResponse>;
     /**
      * List all available hosting offers along with their specific options.. List all available hosting offers along with their specific options.
@@ -193,8 +265,11 @@ export declare class OfferAPI extends ParentAPI {
 This API allows you to manage your Web Hosting services.
  */
 export declare class HostingAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the `offer_id` parameter.
      *
@@ -210,8 +285,8 @@ export declare class HostingAPI extends ParentAPI {
      * @returns A Promise of ListHostingsResponse
      */
     listHostings: (request?: Readonly<HostingApiListHostingsRequest>) => Promise<ListHostingsResponse> & {
-        all: () => Promise<import("./types.gen").HostingSummary[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").HostingSummary[], void, void>;
+        all: () => Promise<HostingSummary[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<HostingSummary[], void, void>;
     };
     /**
      * Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its `hosting_id`.
@@ -263,6 +338,20 @@ export declare class HostingAPI extends ParentAPI {
      * @returns A Promise of ResourceSummary
      */
     getResourceSummary: (request: Readonly<HostingApiGetResourceSummaryRequest>) => Promise<ResourceSummary>;
+    /**
+     * Attach a custom domain to a webhosting.
+     *
+     * @param request - The request {@link HostingApiAddCustomDomainRequest}
+     * @returns A Promise of HostingSummary
+     */
+    addCustomDomain: (request: Readonly<HostingApiAddCustomDomainRequest>) => Promise<HostingSummary>;
+    /**
+     * Detach a custom domain from a webhosting.
+     *
+     * @param request - The request {@link HostingApiRemoveCustomDomainRequest}
+     * @returns A Promise of HostingSummary
+     */
+    removeCustomDomain: (request: Readonly<HostingApiRemoveCustomDomainRequest>) => Promise<HostingSummary>;
 }
 /**
  * Web Hosting FTP Account API.
@@ -270,8 +359,11 @@ export declare class HostingAPI extends ParentAPI {
 This API allows you to manage your FTP accounts for your Web Hosting services.
  */
 export declare class FtpAccountAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan.
      *
@@ -305,8 +397,11 @@ export declare class FtpAccountAPI extends ParentAPI {
 This API allows you to manage your mail accounts for your Web Hosting services.
  */
 export declare class MailAccountAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.
      *
@@ -346,8 +441,11 @@ export declare class MailAccountAPI extends ParentAPI {
 This API allows you to manage your websites for your Web Hosting services.
  */
 export declare class WebsiteAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     protected pageOfListWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse>;
     /**
      * List all websites for a specific hosting.. List all websites for a specific hosting.