@scaleway/sdk-webhosting 1.2.0 → 1.4.0

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

@@ -2,6 +2,7 @@ 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';
@@ -24,6 +25,7 @@ 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.
@@ -154,6 +156,16 @@ export interface HostingDomain {
      */
     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;
@@ -277,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 {
     /**
@@ -444,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.
@@ -498,6 +532,20 @@ export type BackupApiGetBackupRequest = {
      */
     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.
@@ -534,6 +582,16 @@ export type BackupApiListBackupsRequest = {
      */
     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.
@@ -562,6 +620,20 @@ export type BackupApiRestoreBackupRequest = {
      */
     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.
@@ -918,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.
@@ -1223,6 +1323,10 @@ export type HostingApiRemoveCustomDomainRequest = {
      * 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 = {
     /**
@@ -1314,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.
@@ -1354,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.
@@ -1478,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).
@@ -1507,8 +1645,16 @@ 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 {
     /**
@@ -1522,6 +1668,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/dist/v1/validation-rules.gen.cjs

@@ -36,6 +36,15 @@ const DatabaseApiListDatabasesRequest = {
     lessThanOrEqual: 100
   }
 };
+const FreeDomainApiListFreeRootDomainsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
 const FtpAccountApiListFtpAccountsRequest = {
   page: {
     greaterThan: 0
@@ -85,6 +94,7 @@ 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

@@ -34,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;

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

@@ -34,6 +34,15 @@ const DatabaseApiListDatabasesRequest = {
     lessThanOrEqual: 100
   }
 };
+const FreeDomainApiListFreeRootDomainsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
 const FtpAccountApiListFtpAccountsRequest = {
   page: {
     greaterThan: 0
@@ -84,6 +93,7 @@ export {
   ControlPanelApiListControlPanelsRequest,
   DatabaseApiListDatabaseUsersRequest,
   DatabaseApiListDatabasesRequest,
+  FreeDomainApiListFreeRootDomainsRequest,
   FtpAccountApiListFtpAccountsRequest,
   HostingApiListHostingsRequest,
   MailAccountApiListMailAccountsRequest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-webhosting",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Scaleway SDK webhosting",
   "license": "Apache-2.0",
   "files": [
@@ -30,13 +30,13 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.2",
-    "@scaleway/sdk-std": "1.0.6"
+    "@scaleway/sdk-std": "1.2.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.3.1"
+    "@scaleway/sdk-client": "^1.3.3"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.3.1"
+    "@scaleway/sdk-client": "^1.3.3"
   },
   "scripts": {
     "package:check": "pnpm publint",