@scaleway/sdk-webhosting 1.3.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-webhosting
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-webhosting.svg)](https://www.npmjs.com/package/@scaleway/sdk-webhosting)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-webhosting.svg)](https://www.npmjs.com/package/@scaleway/sdk-webhosting)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-webhosting.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Webhosting API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-webhosting @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-webhosting @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-webhosting @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Webhosting } from '@scaleway/sdk-webhosting'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Webhosting.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Webhosting } from '@scaleway/sdk-webhosting'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Webhosting.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Webhosting API Documentation](https://www.scaleway.com/en/developers/api/webhosting/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,6 +1,6 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
-import type { Backup, BackupApiGetBackupRequest, BackupApiGetProgressRequest, BackupApiListBackupItemsRequest, BackupApiListBackupsRequest, BackupApiListRecentProgressesRequest, BackupApiRestoreBackupItemsRequest, BackupApiRestoreBackupRequest, CheckFreeDomainAvailabilityResponse, CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FreeDomainApiCheckFreeDomainAvailabilityRequest, FreeDomainApiListFreeRootDomainsRequest, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiAddCustomDomainRequest, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiRemoveCustomDomainRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingSummary, ListBackupItemsResponse, ListBackupsResponse, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFreeRootDomainsResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListRecentProgressesResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, Progress, ResetHostingPasswordResponse, ResourceSummary, RestoreBackupItemsResponse, RestoreBackupResponse, SearchDomainsResponse, Session, WebsiteApiListWebsitesRequest } from './types.gen.js';
+import { API as ParentAPI } from '@scaleway/sdk-client';
+import type { Backup, BackupApiGetBackupRequest, BackupApiGetProgressRequest, BackupApiListBackupItemsRequest, BackupApiListBackupsRequest, BackupApiListRecentProgressesRequest, BackupApiRestoreBackupItemsRequest, BackupApiRestoreBackupRequest, CheckFreeDomainAvailabilityResponse, CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabasesRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, FreeDomainApiCheckFreeDomainAvailabilityRequest, FreeDomainApiListFreeRootDomainsRequest, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiAddCustomDomainRequest, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiMigrateControlPanelRequest, HostingApiRemoveCustomDomainRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingSummary, ListBackupItemsResponse, ListBackupsResponse, ListControlPanelsResponse, ListDatabasesResponse, ListDatabaseUsersResponse, ListFreeRootDomainsResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListRecentProgressesResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, Progress, ResetHostingPasswordResponse, ResourceSummary, RestoreBackupItemsResponse, RestoreBackupResponse, SearchDomainsResponse, Session, Website, WebsiteApiCreateWebsiteRequest, WebsiteApiDeleteWebsiteRequest, WebsiteApiListWebsitesRequest } from './types.gen.js';
 /**
  * Web Hosting backup API.
 
@@ -353,7 +353,7 @@ export declare class HostingAPI extends ParentAPI {
      */
     getResourceSummary: (request: Readonly<HostingApiGetResourceSummaryRequest>) => Promise<ResourceSummary>;
     /**
-     * Attach a custom domain to a webhosting.
+     * Attach a custom domain to a webhosting as an alias to the main domain.
      *
      * @param request - The request {@link HostingApiAddCustomDomainRequest}
      * @returns A Promise of HostingSummary
@@ -366,6 +366,13 @@ export declare class HostingAPI extends ParentAPI {
      * @returns A Promise of HostingSummary
      */
     removeCustomDomain: (request: Readonly<HostingApiRemoveCustomDomainRequest>) => Promise<HostingSummary>;
+    /**
+     * Migrate a hosting to a new control panel.. Migrate a hosting to a new control panel.
+     *
+     * @param request - The request {@link HostingApiMigrateControlPanelRequest}
+     * @returns A Promise of HostingSummary
+     */
+    migrateControlPanel: (request: Readonly<HostingApiMigrateControlPanelRequest>) => Promise<HostingSummary>;
 }
 /**
  * Web Hosting free domain API.
@@ -498,7 +505,20 @@ export declare class WebsiteAPI extends ParentAPI {
      * @returns A Promise of ListWebsitesResponse
      */
     listWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse> & {
-        all: () => Promise<import("./types.gen.js").Website[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").Website[], void, void>;
+        all: () => Promise<Website[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Website[], void, void>;
     };
+    /**
+     * Create a new website and attach it to a webhosting.
+     *
+     * @param request - The request {@link WebsiteApiCreateWebsiteRequest}
+     * @returns A Promise of Website
+     */
+    createWebsite: (request: Readonly<WebsiteApiCreateWebsiteRequest>) => Promise<Website>;
+    /**
+     * Delete a website from a webhosting.
+     *
+     * @param request - The request {@link WebsiteApiDeleteWebsiteRequest}
+     */
+    deleteWebsite: (request: Readonly<WebsiteApiDeleteWebsiteRequest>) => Promise<void>;
 }