@scaleway/sdk-webhosting 1.1.3 → 1.3.0

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

@@ -1,5 +1,8 @@
 import type { Money, Region as ScwRegion } from '@scaleway/sdk-client';
 import type { LanguageCode as StdLanguageCode } from '@scaleway/sdk-std';
+export type BackupItemType = 'unknown_backup_item_type' | 'full' | 'web' | 'mail' | 'db' | 'db_user' | 'ftp_user' | 'dns_zone' | 'cron_job' | 'ssl_certificate';
+export type BackupStatus = 'unknown_backup_status' | 'active' | 'locked' | 'disabled' | 'damaged' | 'restoring';
+export type CheckFreeDomainAvailabilityResponseUnavailableReason = 'unavailable_reason_unknown' | 'unavailable_reason_already_used' | 'unavailable_reason_too_short' | 'unavailable_reason_too_long' | 'unavailable_reason_invalid_characters' | 'unavailable_reason_starts_or_ends_with_hyphen' | 'unavailable_reason_contains_dots' | 'unavailable_reason_contains_reserved_keyword';
 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';
@@ -9,7 +12,8 @@ export type DomainAvailabilityStatus = 'unknown_status' | 'available' | 'not_ava
 export type DomainDnsAction = 'unknown_dns_action' | 'auto_config_all_records' | 'auto_config_web_records' | 'auto_config_mail_records' | 'auto_config_nameservers' | 'auto_config_none';
 export type DomainStatus = 'unknown_status' | 'valid' | 'invalid' | 'validating' | 'error';
 export type DomainZoneOwner = 'unknown_zone_owner' | 'external' | 'scaleway' | 'online' | 'webhosting';
-export type HostingStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating';
+export type HostingStatus = 'unknown_status' | 'delivering' | 'ready' | 'deleting' | 'error' | 'locked' | 'migrating' | 'updating';
+export type ListBackupsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
 export type ListDatabaseUsersRequestOrderBy = 'username_asc' | 'username_desc';
 export type ListDatabasesRequestOrderBy = 'database_name_asc' | 'database_name_desc';
 export type ListFtpAccountsRequestOrderBy = 'username_asc' | 'username_desc';
@@ -21,6 +25,29 @@ 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 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';
+export interface AutoConfigDomainDns {
+    /**
+     * Whether or not to synchronize domain nameservers.
+     */
+    nameservers: boolean;
+    /**
+     * Whether or not to synchronize web records.
+     */
+    webRecords: boolean;
+    /**
+     * Whether or not to synchronize mail records.
+     */
+    mailRecords: boolean;
+    /**
+     * Whether or not to synchronize all types of records. Takes priority over the other fields.
+     */
+    allRecords: boolean;
+    /**
+     * No automatic domain configuration. Users must configure their domain for the Web Hosting to work.
+     */
+    none: boolean;
+}
 export interface PlatformControlPanelUrls {
     /**
      * URL to connect to the hosting control panel dashboard.
@@ -31,6 +58,24 @@ export interface PlatformControlPanelUrls {
      */
     webmail: string;
 }
+export interface HostingDomainCustomDomain {
+    /**
+     * Custom domain linked to the hosting plan.
+     */
+    domain: string;
+    /**
+     * Status of the custom domain verification.
+     */
+    domainStatus: DomainStatus;
+    /**
+     * Status of the DNS configuration for the custom domain.
+     */
+    dnsStatus: DnsRecordsStatus;
+    /**
+     * Indicates whether to auto-configure DNS for this domain.
+     */
+    autoConfigDomainDns?: AutoConfigDomainDns;
+}
 export interface OfferOption {
     /**
      * Option ID.
@@ -75,31 +120,55 @@ export interface PlatformControlPanel {
      */
     urls?: PlatformControlPanelUrls;
 }
-export interface CreateDatabaseRequestUser {
-    username: string;
-    password: string;
-}
-export interface AutoConfigDomainDns {
+export interface BackupItem {
     /**
-     * Whether or not to synchronize domain nameservers.
+     * ID of the item.
      */
-    nameservers: boolean;
+    id: string;
     /**
-     * Whether or not to synchronize web records.
+     * Name of the item (e.g., `database name`, `email address`).
      */
-    webRecords: boolean;
+    name: string;
     /**
-     * Whether or not to synchronize mail records.
+     * Type of the item (e.g., email, database, FTP).
      */
-    mailRecords: boolean;
+    type: BackupItemType;
     /**
-     * Whether or not to synchronize all types of records. Takes priority over the other fields.
+     * Size of the item in bytes.
      */
-    allRecords: boolean;
+    size: number;
     /**
-     * No automatic domain configuration. Users must configure their domain for the Web Hosting to work.
+     * Status of the item. Available values are `active`, `damaged`, and `restoring`.
      */
-    none: boolean;
+    status: BackupStatus;
+    /**
+     * Date and time at which this item was backed up.
+     */
+    createdAt?: Date;
+}
+export interface HostingDomain {
+    /**
+     * Optional free subdomain linked to the Web Hosting plan.
+     */
+    subdomain: string;
+    /**
+     * Optional custom domain linked to the Web Hosting plan.
+     */
+    customDomain?: HostingDomainCustomDomain;
+}
+export interface FreeDomain {
+    /**
+     * Custom prefix used for the free domain.
+     */
+    slug: string;
+    /**
+     * Free root domain provided by Web Hosting, selected from the list returned by `ListFreeRootDomains`.
+     */
+    rootDomain: string;
+}
+export interface CreateDatabaseRequestUser {
+    username: string;
+    password: string;
 }
 export interface CreateHostingRequestDomainConfiguration {
     updateNameservers: boolean;
@@ -220,6 +289,10 @@ export interface Offer {
      * Defines a warning if the maximum value for an option in the offer is exceeded.
      */
     quotaWarning: OfferOptionWarning;
+    /**
+     * Region where the offer is hosted.
+     */
+    region: ScwRegion;
 }
 export interface Platform {
     /**
@@ -247,6 +320,38 @@ export interface Platform {
      */
     controlPanel?: PlatformControlPanel;
 }
+export interface BackupItemGroup {
+    /**
+     * Type of items (e.g., email, database, FTP).
+     */
+    type: BackupItemType;
+    /**
+     * List of individual backup items of this type.
+     */
+    items: BackupItem[];
+}
+export interface Backup {
+    /**
+     * ID of the backup.
+     */
+    id: string;
+    /**
+     * Total size of the backup in bytes.
+     */
+    size: number;
+    /**
+     * Creation date of the backup.
+     */
+    createdAt?: Date;
+    /**
+     * Status of the backup. Available values are `active`, `locked`, and `restoring`.
+     */
+    status: BackupStatus;
+    /**
+     * Total number of restorable items in the backup.
+     */
+    totalItems: number;
+}
 export interface ControlPanel {
     /**
      * Control panel name.
@@ -317,9 +422,9 @@ export interface HostingSummary {
      */
     status: HostingStatus;
     /**
-     * Main domain associated with the Web Hosting plan.
+     * @deprecated Main domain associated with the Web Hosting plan (deprecated, use domain_info).
      */
-    domain: string;
+    domain?: string;
     /**
      * Whether the hosting is protected or not.
      */
@@ -333,13 +438,17 @@ export interface HostingSummary {
      */
     offerName: string;
     /**
-     * Main domain status of the Web Hosting plan.
+     * @deprecated Main domain status of the Web Hosting plan.
      */
-    domainStatus: DomainStatus;
+    domainStatus?: DomainStatus;
     /**
      * Region where the Web Hosting plan is hosted.
      */
     region: ScwRegion;
+    /**
+     * Domain configuration block (subdomain, optional custom domain, and DNS settings).
+     */
+    domainInfo?: HostingDomain;
 }
 export interface MailAccount {
     /**
@@ -351,6 +460,24 @@ export interface MailAccount {
      */
     username: string;
 }
+export interface ProgressSummary {
+    /**
+     * ID of the progress.
+     */
+    id: string;
+    /**
+     * Total number of backup items included in the progress.
+     */
+    backupItemsCount: number;
+    /**
+     * Completion percentage of the progress.
+     */
+    percentage: number;
+    /**
+     * Current status of the progress operation.
+     */
+    status: ProgressStatus;
+}
 export interface Website {
     /**
      * The domain of the website.
@@ -391,6 +518,122 @@ export interface DomainAvailability {
      */
     price?: Money;
 }
+export type BackupApiGetBackupRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the hosting account.
+     */
+    hostingId: string;
+    /**
+     * ID of the backup to retrieve.
+     */
+    backupId: string;
+};
+export type BackupApiGetProgressRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * ID of the hosting associated with the progress.
+     */
+    hostingId: string;
+    /**
+     * ID of the progress to retrieve.
+     */
+    progressId: string;
+};
+export type BackupApiListBackupItemsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the hosting account.
+     */
+    hostingId: string;
+    /**
+     * ID of the backup to list items from.
+     */
+    backupId: string;
+};
+export type BackupApiListBackupsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the hosting account.
+     */
+    hostingId: string;
+    /**
+     * Page number to retrieve.
+     */
+    page?: number;
+    /**
+     * Number of backups to return per page.
+     */
+    pageSize?: number;
+    /**
+     * Order in which to return the list of backups.
+     */
+    orderBy?: ListBackupsRequestOrderBy;
+};
+export type BackupApiListRecentProgressesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * ID of the hosting linked to the progress.
+     */
+    hostingId: string;
+};
+export type BackupApiRestoreBackupItemsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the hosting account.
+     */
+    hostingId: string;
+    /**
+     * List of backup item IDs to restore individually.
+     */
+    itemIds?: string[];
+};
+export type BackupApiRestoreBackupRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the hosting account.
+     */
+    hostingId: string;
+    /**
+     * ID of the backup to fully restore.
+     */
+    backupId: string;
+};
+export interface CheckFreeDomainAvailabilityResponse {
+    /**
+     * The free domain that was checked.
+     */
+    freeDomain?: FreeDomain;
+    /**
+     * Whether the free domain is available.
+     */
+    isAvailable: boolean;
+    /**
+     * Reason the domain is unavailable, if applicable.
+     */
+    reason?: CheckFreeDomainAvailabilityResponseUnavailableReason;
+}
 export interface CheckUserOwnsDomainResponse {
     /**
      * Indicates whether the specified project owns the domain.
@@ -730,6 +973,10 @@ export interface Domain {
      * Zone owner of the domain.
      */
     owner: DomainZoneOwner;
+    /**
+     * Main domain for this zone.
+     */
+    zoneDomainName: string;
     /**
      * A list of actions that can be performed on the domain.
      */
@@ -743,6 +990,34 @@ export interface Domain {
      */
     autoConfigDomainDns?: AutoConfigDomainDns;
 }
+export type FreeDomainApiCheckFreeDomainAvailabilityRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Custom prefix used for the free domain.
+     */
+    slug: string;
+    /**
+     * Free root domain provided by Web Hosting, selected from the list returned by `ListFreeRootDomains`.
+     */
+    rootDomain: string;
+};
+export type FreeDomainApiListFreeRootDomainsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Page number to return, from the paginated results (must be a positive integer).
+     */
+    page?: number;
+    /**
+     * Number of free root domains to return (must be a positive integer lower or equal to 100).
+     */
+    pageSize?: number;
+};
 export type FtpAccountApiChangeFtpAccountPasswordRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.
@@ -845,9 +1120,9 @@ export interface Hosting {
      */
     status: HostingStatus;
     /**
-     * Main domain associated with the Web Hosting plan.
+     * @deprecated Main domain associated with the Web Hosting plan (deprecated, use domain_info).
      */
-    domain: string;
+    domain?: string;
     /**
      * Details of the Web Hosting plan offer and options.
      */
@@ -861,7 +1136,7 @@ export interface Hosting {
      */
     tags: string[];
     /**
-     * @deprecated DNS status of the Web Hosting plan.
+     * @deprecated DNS status of the Web Hosting plan (deprecated, use domain_info).
      */
     dnsStatus?: DnsRecordsStatus;
     /**
@@ -877,14 +1152,32 @@ export interface Hosting {
      */
     user?: HostingUser;
     /**
-     * Main domain status of the Web Hosting plan.
+     * @deprecated Main domain status of the Web Hosting plan (deprecated, use domain_info).
      */
-    domainStatus: DomainStatus;
+    domainStatus?: DomainStatus;
     /**
      * Region where the Web Hosting plan is hosted.
      */
     region: ScwRegion;
+    /**
+     * Domain configuration block (subdomain, optional custom domain, and DNS settings).
+     */
+    domainInfo?: HostingDomain;
 }
+export type HostingApiAddCustomDomainRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Hosting ID to which the custom domain is attached to.
+     */
+    hostingId: string;
+    /**
+     * The custom domain name to attach to the hosting.
+     */
+    domainName: string;
+};
 export type HostingApiCreateHostingRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.
@@ -910,6 +1203,10 @@ export type HostingApiCreateHostingRequest = {
      * Domain name to link to the Web Hosting plan. You must already own this domain name, and have completed the DNS validation process beforehand.
      */
     domain: string;
+    /**
+     * The name prefix to use as a free subdomain (for example, `mysite`) assigned to the Web Hosting plan. The full domain will be automatically created by adding it to the fixed base domain (e.g. `mysite.scw.site`). You do not need to include the base domain yourself.
+     */
+    subdomain?: string;
     /**
      * List of the Web Hosting plan options IDs with their quantities.
      */
@@ -1012,6 +1309,24 @@ export type HostingApiListHostingsRequest = {
      * Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned.
      */
     controlPanels?: string[];
+    /**
+     * Optional free subdomain linked to the Web Hosting plan.
+     */
+    subdomain?: string;
+};
+export type HostingApiRemoveCustomDomainRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Hosting ID to which the custom domain is detached from.
+     */
+    hostingId: string;
+    /**
+     * The custom domain name to detach from the hosting.
+     */
+    domainName: string;
 };
 export type HostingApiResetHostingPasswordRequest = {
     /**
@@ -1053,6 +1368,26 @@ export type HostingApiUpdateHostingRequest = {
      */
     protected?: boolean;
 };
+export interface ListBackupItemsResponse {
+    /**
+     * Total number of backup item groups.
+     */
+    totalCount: number;
+    /**
+     * List of backup item groups categorized by type.
+     */
+    groups: BackupItemGroup[];
+}
+export interface ListBackupsResponse {
+    /**
+     * Total number of available backups.
+     */
+    totalCount: number;
+    /**
+     * List of available backups.
+     */
+    backups: Backup[];
+}
 export interface ListControlPanelsResponse {
     /**
      * Number of control panels returned.
@@ -1083,6 +1418,16 @@ export interface ListDatabasesResponse {
      */
     databases: Database[];
 }
+export interface ListFreeRootDomainsResponse {
+    /**
+     * List of free root domains available for the Web Hosting.
+     */
+    rootDomains: string[];
+    /**
+     * Total number of free root domains available.
+     */
+    totalCount: number;
+}
 export interface ListFtpAccountsResponse {
     /**
      * Total number of FTP accounts.
@@ -1123,6 +1468,12 @@ export interface ListOffersResponse {
      */
     offers: Offer[];
 }
+export interface ListRecentProgressesResponse {
+    /**
+     * List of summarized progress entries.
+     */
+    progresses: ProgressSummary[];
+}
 export interface ListWebsitesResponse {
     /**
      * Total number of websites.
@@ -1247,6 +1598,24 @@ export type OfferApiListOffersRequest = {
      */
     controlPanels?: string[];
 };
+export interface Progress {
+    /**
+     * ID of the progress.
+     */
+    id: string;
+    /**
+     * Groups of backup items included in this progress.
+     */
+    backupItemGroups: BackupItemGroup[];
+    /**
+     * Completion percentage of the progress.
+     */
+    percentage: number;
+    /**
+     * Current status of the progress operation.
+     */
+    status: ProgressStatus;
+}
 export interface ResetHostingPasswordResponse {
     /**
      * @deprecated New temporary password (deprecated, use password_b64 instead).
@@ -1275,6 +1644,18 @@ export interface ResourceSummary {
      */
     websitesCount: number;
 }
+export interface RestoreBackupItemsResponse {
+    /**
+     * Identifier used to track the item restoration progress.
+     */
+    progressId: string;
+}
+export interface RestoreBackupResponse {
+    /**
+     * Identifier used to track the backup restoration progress.
+     */
+    progressId: string;
+}
 export interface SearchDomainsResponse {
     /**
      * List of domains availability.

package/dist/v1/validation-rules.gen.cjs

@@ -1,5 +1,14 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const BackupApiListBackupsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
 const ControlPanelApiListControlPanelsRequest = {
   page: {
     greaterThan: 0
@@ -27,6 +36,15 @@ const DatabaseApiListDatabasesRequest = {
     lessThanOrEqual: 100
   }
 };
+const FreeDomainApiListFreeRootDomainsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
 const FtpAccountApiListFtpAccountsRequest = {
   page: {
     greaterThan: 0
@@ -72,9 +90,11 @@ const WebsiteApiListWebsitesRequest = {
     lessThanOrEqual: 100
   }
 };
+exports.BackupApiListBackupsRequest = BackupApiListBackupsRequest;
 exports.ControlPanelApiListControlPanelsRequest = ControlPanelApiListControlPanelsRequest;
 exports.DatabaseApiListDatabaseUsersRequest = DatabaseApiListDatabaseUsersRequest;
 exports.DatabaseApiListDatabasesRequest = DatabaseApiListDatabasesRequest;
+exports.FreeDomainApiListFreeRootDomainsRequest = FreeDomainApiListFreeRootDomainsRequest;
 exports.FtpAccountApiListFtpAccountsRequest = FtpAccountApiListFtpAccountsRequest;
 exports.HostingApiListHostingsRequest = HostingApiListHostingsRequest;
 exports.MailAccountApiListMailAccountsRequest = MailAccountApiListMailAccountsRequest;

package/dist/v1/validation-rules.gen.d.ts

@@ -1,3 +1,12 @@
+export declare const BackupApiListBackupsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThan: number;
+        lessThanOrEqual: number;
+    };
+};
 export declare const ControlPanelApiListControlPanelsRequest: {
     page: {
         greaterThan: number;
@@ -25,6 +34,15 @@ export declare const DatabaseApiListDatabasesRequest: {
         lessThanOrEqual: number;
     };
 };
+export declare const FreeDomainApiListFreeRootDomainsRequest: {
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThan: number;
+        lessThanOrEqual: number;
+    };
+};
 export declare const FtpAccountApiListFtpAccountsRequest: {
     page: {
         greaterThan: number;