@scaleway/sdk 2.42.0 → 2.44.0

package/dist/api/k8s/v1/marshalling.gen.js

@@ -145,6 +145,7 @@ const unmarshalCluster = (data) => {
     projectId: data.project_id,
     region: data.region,
     routedIpEnabled: data.routed_ip_enabled,
+    sbsCsiEnabled: data.sbs_csi_enabled,
     status: data.status,
     tags: data.tags,
     type: data.type,
@@ -212,6 +213,17 @@ const unmarshalExternalNode = (data) => {
     runcVersion: data.runc_version
   };
 };
+const unmarshalExternalNodeAuth = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ExternalNodeAuth' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    apiUrl: data.api_url,
+    nodeToken: data.node_token
+  };
+};
 const unmarshalClusterType = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -223,6 +235,7 @@ const unmarshalClusterType = (data) => {
     availability: data.availability,
     commitmentDelay: data.commitment_delay,
     dedicated: data.dedicated,
+    maxEtcdSize: data.max_etcd_size,
     maxNodes: data.max_nodes,
     memory: data.memory,
     name: data.name,
@@ -311,6 +324,44 @@ const unmarshalListVersionsResponse = (data) => {
     versions: unmarshalArrayOfObject(data.versions, unmarshalVersion)
   };
 };
+const unmarshalNodeMetadataCoreV1Taint = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'NodeMetadataCoreV1Taint' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    effect: data.effect,
+    key: data.key,
+    value: data.value
+  };
+};
+const unmarshalNodeMetadata = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'NodeMetadata' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    clusterCa: data.cluster_ca,
+    clusterUrl: data.cluster_url,
+    credentialProviderConfig: data.credential_provider_config,
+    externalIp: data.external_ip,
+    fullIsolation: data.full_isolation,
+    hasGpu: data.has_gpu,
+    id: data.id,
+    kapsuleIfaceMac: data.kapsule_iface_mac,
+    kubeletConfig: data.kubelet_config,
+    name: data.name,
+    nodeLabels: data.node_labels,
+    nodeTaints: unmarshalArrayOfObject(
+      data.node_taints,
+      unmarshalNodeMetadataCoreV1Taint
+    ),
+    poolVersion: data.pool_version,
+    privateNetworkMode: data.private_network_mode
+  };
+};
 const marshalMaintenanceWindow = (request, defaults) => ({
   day: request.day,
   start_hour: request.startHour
@@ -494,6 +545,7 @@ export {
   marshalUpgradePoolRequest,
   unmarshalCluster,
   unmarshalExternalNode,
+  unmarshalExternalNodeAuth,
   unmarshalListClusterAvailableTypesResponse,
   unmarshalListClusterAvailableVersionsResponse,
   unmarshalListClusterTypesResponse,
@@ -502,6 +554,7 @@ export {
   unmarshalListPoolsResponse,
   unmarshalListVersionsResponse,
   unmarshalNode,
+  unmarshalNodeMetadata,
   unmarshalPool,
   unmarshalVersion
 };

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

@@ -364,6 +364,8 @@ export interface ClusterType {
      * note that audit logs are sent to Cockpit.
      */
     auditLogsSupported: boolean;
+    /** Maximum amount of data that can be stored in etcd for the offer. */
+    maxEtcdSize: number;
 }
 export interface Version {
     /** Name of the Kubernetes version. */
@@ -443,6 +445,11 @@ export interface Cluster {
      *   cluster.
      */
     routedIpEnabled?: boolean;
+    /**
+     * @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is
+     *   installed on the cluster.
+     */
+    sbsCsiEnabled?: boolean;
 }
 export interface Node {
     /** Node ID. */
@@ -479,6 +486,11 @@ export interface Node {
     /** Date on which the node was last updated. */
     updatedAt?: Date;
 }
+export interface NodeMetadataCoreV1Taint {
+    key: string;
+    value: string;
+    effect: string;
+}
 export interface UpdateClusterRequestAutoUpgrade {
     /** Defines whether auto upgrade is enabled for the cluster. */
     enable?: boolean;
@@ -566,6 +578,15 @@ export interface UpdatePoolRequestUpgradePolicy {
     maxUnavailable?: number;
     maxSurge?: number;
 }
+export type AuthExternalNodeRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Pool the node will be attached to. */
+    poolId: string;
+};
 export type CreateClusterRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -768,6 +789,10 @@ export interface ExternalNode {
     nodeLabels: Record<string, string>;
     nodeTaints: ExternalNodeCoreV1Taint[];
 }
+export interface ExternalNodeAuth {
+    nodeToken: string;
+    apiUrl: string;
+}
 export type GetClusterKubeConfigRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -788,6 +813,13 @@ export type GetClusterRequest = {
     /** ID of the requested cluster. */
     clusterId: string;
 };
+export type GetNodeMetadataRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+};
 export type GetNodeRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -974,6 +1006,22 @@ export type MigrateClusterToRoutedIPsRequest = {
     region?: Region;
     clusterId: string;
 };
+export interface NodeMetadata {
+    id: string;
+    name: string;
+    clusterUrl: string;
+    clusterCa: string;
+    credentialProviderConfig: string;
+    poolVersion: string;
+    kubeletConfig: string;
+    nodeLabels: Record<string, string>;
+    nodeTaints: NodeMetadataCoreV1Taint[];
+    privateNetworkMode: string;
+    kapsuleIfaceMac: string;
+    fullIsolation: boolean;
+    hasGpu: boolean;
+    externalIp: string;
+}
 export type RebootNodeRequest = {
     /**
      * Region to target. If none is passed will use default region from the

package/dist/api/key_manager/v1alpha1/types.gen.d.ts

@@ -14,7 +14,8 @@ export interface KeyRotationPolicy {
 }
 export interface KeyUsage {
     /**
-     * Algorithms used to encrypt and decrypt arbitrary payloads.
+     * See the `Key.Algorithm.SymmetricEncryption` enum for a description of
+     * values.
      *
      * One-of ('usage'): at most one of 'symmetricEncryption' could be set.
      */
@@ -33,11 +34,7 @@ export interface Key {
      * AES-256-GCM.
      */
     usage?: KeyUsage;
-    /**
-     * Current state of the key. Values include: `unknown_state`: key is in an
-     * unknown state. `enabled`: key can be used for cryptographic operations.
-     * `disabled`: key cannot be used for cryptographic operations.
-     */
+    /** See the `Key.State` enum for a description of values. */
     state: KeyState;
     /** The rotation count tracks the amount of times that the key was rotated. */
     rotationCount: number;
@@ -184,7 +181,10 @@ export type GenerateDataKeyRequest = {
     region?: Region;
     /** ID of the key. */
     keyId: string;
-    /** Encryption algorithm of the data encryption key. */
+    /**
+     * See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of
+     * values.
+     */
     algorithm?: DataKeyAlgorithmSymmetricEncryption;
     /**
      * Default value is `false`, meaning that the plaintext is returned. Set it to

package/dist/api/secret/v1beta1/marshalling.gen.cjs

@@ -65,6 +65,7 @@ const unmarshalSecret = (data) => {
     tags: data.tags,
     type: data.type,
     updatedAt: marshalling.unmarshalDate(data.updated_at),
+    usedBy: data.used_by,
     versionCount: data.version_count
   };
 };

package/dist/api/secret/v1beta1/marshalling.gen.js

@@ -63,6 +63,7 @@ const unmarshalSecret = (data) => {
     tags: data.tags,
     type: data.type,
     updatedAt: unmarshalDate(data.updated_at),
+    usedBy: data.used_by,
     versionCount: data.version_count
   };
 };

package/dist/api/secret/v1beta1/types.gen.d.ts

@@ -113,6 +113,8 @@ export interface Secret {
      * default, the policy is applied to all the secret's versions.
      */
     ephemeralPolicy?: EphemeralPolicy;
+    /** List of Scaleway resources that can access and manage the secret. */
+    usedBy: Product[];
     /** Region of the secret. */
     region: Region;
 }

package/dist/api/serverless_sqldb/v1alpha1/marshalling.gen.cjs

@@ -12,6 +12,7 @@ const unmarshalDatabaseBackup = (data) => {
   return {
     createdAt: marshalling.unmarshalDate(data.created_at),
     databaseId: data.database_id,
+    dbSize: data.db_size,
     downloadUrl: data.download_url,
     downloadUrlExpiresAt: marshalling.unmarshalDate(data.download_url_expires_at),
     expiresAt: marshalling.unmarshalDate(data.expires_at),

package/dist/api/serverless_sqldb/v1alpha1/marshalling.gen.js

@@ -10,6 +10,7 @@ const unmarshalDatabaseBackup = (data) => {
   return {
     createdAt: unmarshalDate(data.created_at),
     databaseId: data.database_id,
+    dbSize: data.db_size,
     downloadUrl: data.download_url,
     downloadUrlExpiresAt: unmarshalDate(data.download_url_expires_at),
     expiresAt: unmarshalDate(data.expires_at),

package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts

@@ -21,8 +21,10 @@ export interface DatabaseBackup {
     createdAt?: Date;
     /** Expiration date. */
     expiresAt?: Date;
-    /** Size of the database backup. */
+    /** Size (in bytes) of the database backup file. */
     size?: number;
+    /** Size (in bytes) of the database when backup has been done. */
+    dbSize?: number;
     /** Download URL of the exported database backup. */
     downloadUrl?: string;
     /** Expiration date of the download URL. */

package/dist/api/tem/v1alpha1/marshalling.gen.cjs

@@ -95,6 +95,7 @@ const unmarshalDomain = (data) => {
     );
   }
   return {
+    autoconfig: data.autoconfig,
     createdAt: marshalling.unmarshalDate(data.created_at),
     dkimConfig: data.dkim_config,
     id: data.id,
@@ -275,6 +276,7 @@ const unmarshalStatistics = (data) => {
 };
 const marshalCreateDomainRequest = (request, defaults) => ({
   accept_tos: request.acceptTos,
+  autoconfig: request.autoconfig,
   domain_name: request.domainName,
   project_id: request.projectId ?? defaults.defaultProjectId
 });

package/dist/api/tem/v1alpha1/marshalling.gen.js

@@ -93,6 +93,7 @@ const unmarshalDomain = (data) => {
     );
   }
   return {
+    autoconfig: data.autoconfig,
     createdAt: unmarshalDate(data.created_at),
     dkimConfig: data.dkim_config,
     id: data.id,
@@ -273,6 +274,7 @@ const unmarshalStatistics = (data) => {
 };
 const marshalCreateDomainRequest = (request, defaults) => ({
   accept_tos: request.acceptTos,
+  autoconfig: request.autoconfig,
   domain_name: request.domainName,
   project_id: request.projectId ?? defaults.defaultProjectId
 });

package/dist/api/tem/v1alpha1/types.gen.d.ts

@@ -171,6 +171,8 @@ export interface Domain {
     reputation?: DomainReputation;
     /** List of records to configure to validate a domain. */
     records?: DomainRecords;
+    /** Status of auto-configuration for the domain's DNS zone. */
+    autoconfig: boolean;
     /**
      * Region to target. If none is passed will use default region from the
      * config.
@@ -251,6 +253,8 @@ export type CreateDomainRequest = {
     domainName: string;
     /** Accept Scaleway's Terms of Service. */
     acceptTos: boolean;
+    /** Activate auto-configuration of the domain's DNS zone. */
+    autoconfig: boolean;
 };
 export type CreateEmailRequest = {
     /**

package/dist/api/vpcgw/v1/api.gen.cjs

@@ -131,17 +131,20 @@ class API extends api.API {
     urlParams: marshalling.urlParams(["cleanup_dhcp", request.cleanupDhcp])
   });
   /**
-   * Upgrade a Public Gateway to the latest version. Upgrade a given Public
-   * Gateway to the newest software version. This applies the latest bugfixes
-   * and features to your Public Gateway, but its service will be interrupted
-   * during the update.
+   * Upgrade a Public Gateway to the latest version and/or to a different
+   * commercial offer type. Upgrade a given Public Gateway to the newest
+   * software version or to a different commercial offer type. This applies the
+   * latest bugfixes and features to your Public Gateway. Note that gateway
+   * service will be interrupted during the update.
    *
    * @param request - The request {@link UpgradeGatewayRequest}
    * @returns A Promise of Gateway
    */
   upgradeGateway = (request) => this.client.fetch(
     {
-      body: "{}",
+      body: JSON.stringify(
+        marshalling_gen.marshalUpgradeGatewayRequest(request, this.client.settings)
+      ),
       headers: jsonContentHeaders,
       method: "POST",
       path: `/vpc-gw/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${marshalling.validatePathParam("gatewayId", request.gatewayId)}/upgrade`

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

@@ -65,10 +65,11 @@ export declare class API extends ParentAPI {
      */
     deleteGateway: (request: Readonly<DeleteGatewayRequest>) => Promise<void>;
     /**
-     * Upgrade a Public Gateway to the latest version. Upgrade a given Public
-     * Gateway to the newest software version. This applies the latest bugfixes
-     * and features to your Public Gateway, but its service will be interrupted
-     * during the update.
+     * Upgrade a Public Gateway to the latest version and/or to a different
+     * commercial offer type. Upgrade a given Public Gateway to the newest
+     * software version or to a different commercial offer type. This applies the
+     * latest bugfixes and features to your Public Gateway. Note that gateway
+     * service will be interrupted during the update.
      *
      * @param request - The request {@link UpgradeGatewayRequest}
      * @returns A Promise of Gateway

package/dist/api/vpcgw/v1/api.gen.js

@@ -4,7 +4,7 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
 import "../../../vendor/base64/index.js";
 import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
 import { GATEWAY_TRANSIENT_STATUSES, GATEWAY_NETWORK_TRANSIENT_STATUSES } from "./content.gen.js";
-import { unmarshalListGatewaysResponse, unmarshalGateway, marshalCreateGatewayRequest, marshalUpdateGatewayRequest, unmarshalListGatewayNetworksResponse, unmarshalGatewayNetwork, marshalCreateGatewayNetworkRequest, marshalUpdateGatewayNetworkRequest, unmarshalListDHCPsResponse, unmarshalDHCP, marshalCreateDHCPRequest, marshalUpdateDHCPRequest, unmarshalListDHCPEntriesResponse, unmarshalDHCPEntry, marshalCreateDHCPEntryRequest, marshalUpdateDHCPEntryRequest, marshalSetDHCPEntriesRequest, unmarshalSetDHCPEntriesResponse, unmarshalListPATRulesResponse, unmarshalPATRule, marshalCreatePATRuleRequest, marshalUpdatePATRuleRequest, marshalSetPATRulesRequest, unmarshalSetPATRulesResponse, unmarshalListGatewayTypesResponse, unmarshalListIPsResponse, unmarshalIP, marshalCreateIPRequest, marshalUpdateIPRequest } from "./marshalling.gen.js";
+import { unmarshalListGatewaysResponse, unmarshalGateway, marshalCreateGatewayRequest, marshalUpdateGatewayRequest, marshalUpgradeGatewayRequest, unmarshalListGatewayNetworksResponse, unmarshalGatewayNetwork, marshalCreateGatewayNetworkRequest, marshalUpdateGatewayNetworkRequest, unmarshalListDHCPsResponse, unmarshalDHCP, marshalCreateDHCPRequest, marshalUpdateDHCPRequest, unmarshalListDHCPEntriesResponse, unmarshalDHCPEntry, marshalCreateDHCPEntryRequest, marshalUpdateDHCPEntryRequest, marshalSetDHCPEntriesRequest, unmarshalSetDHCPEntriesResponse, unmarshalListPATRulesResponse, unmarshalPATRule, marshalCreatePATRuleRequest, marshalUpdatePATRuleRequest, marshalSetPATRulesRequest, unmarshalSetPATRulesResponse, unmarshalListGatewayTypesResponse, unmarshalListIPsResponse, unmarshalIP, marshalCreateIPRequest, marshalUpdateIPRequest } from "./marshalling.gen.js";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
@@ -129,17 +129,20 @@ class API extends API$1 {
     urlParams: urlParams(["cleanup_dhcp", request.cleanupDhcp])
   });
   /**
-   * Upgrade a Public Gateway to the latest version. Upgrade a given Public
-   * Gateway to the newest software version. This applies the latest bugfixes
-   * and features to your Public Gateway, but its service will be interrupted
-   * during the update.
+   * Upgrade a Public Gateway to the latest version and/or to a different
+   * commercial offer type. Upgrade a given Public Gateway to the newest
+   * software version or to a different commercial offer type. This applies the
+   * latest bugfixes and features to your Public Gateway. Note that gateway
+   * service will be interrupted during the update.
    *
    * @param request - The request {@link UpgradeGatewayRequest}
    * @returns A Promise of Gateway
    */
   upgradeGateway = (request) => this.client.fetch(
     {
-      body: "{}",
+      body: JSON.stringify(
+        marshalUpgradeGatewayRequest(request, this.client.settings)
+      ),
       headers: jsonContentHeaders,
       method: "POST",
       path: `/vpc-gw/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam("gatewayId", request.gatewayId)}/upgrade`

package/dist/api/vpcgw/v1/marshalling.gen.cjs

@@ -407,6 +407,9 @@ const marshalUpdatePATRuleRequest = (request, defaults) => ({
   protocol: request.protocol,
   public_port: request.publicPort
 });
+const marshalUpgradeGatewayRequest = (request, defaults) => ({
+  type: request.type
+});
 exports.marshalCreateDHCPEntryRequest = marshalCreateDHCPEntryRequest;
 exports.marshalCreateDHCPRequest = marshalCreateDHCPRequest;
 exports.marshalCreateGatewayNetworkRequest = marshalCreateGatewayNetworkRequest;
@@ -421,6 +424,7 @@ exports.marshalUpdateGatewayNetworkRequest = marshalUpdateGatewayNetworkRequest;
 exports.marshalUpdateGatewayRequest = marshalUpdateGatewayRequest;
 exports.marshalUpdateIPRequest = marshalUpdateIPRequest;
 exports.marshalUpdatePATRuleRequest = marshalUpdatePATRuleRequest;
+exports.marshalUpgradeGatewayRequest = marshalUpgradeGatewayRequest;
 exports.unmarshalDHCP = unmarshalDHCP;
 exports.unmarshalDHCPEntry = unmarshalDHCPEntry;
 exports.unmarshalGateway = unmarshalGateway;

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

@@ -1,5 +1,5 @@
 import type { DefaultValues } from '../../../bridge';
-import type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, Gateway, GatewayNetwork, IP, ListDHCPEntriesResponse, ListDHCPsResponse, ListGatewayNetworksResponse, ListGatewayTypesResponse, ListGatewaysResponse, ListIPsResponse, ListPATRulesResponse, PATRule, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest } from './types.gen';
+import type { CreateDHCPEntryRequest, CreateDHCPRequest, CreateGatewayNetworkRequest, CreateGatewayRequest, CreateIPRequest, CreatePATRuleRequest, DHCP, DHCPEntry, Gateway, GatewayNetwork, IP, ListDHCPEntriesResponse, ListDHCPsResponse, ListGatewayNetworksResponse, ListGatewayTypesResponse, ListGatewaysResponse, ListIPsResponse, ListPATRulesResponse, PATRule, SetDHCPEntriesRequest, SetDHCPEntriesResponse, SetPATRulesRequest, SetPATRulesResponse, UpdateDHCPEntryRequest, UpdateDHCPRequest, UpdateGatewayNetworkRequest, UpdateGatewayRequest, UpdateIPRequest, UpdatePATRuleRequest, UpgradeGatewayRequest } from './types.gen';
 export declare const unmarshalDHCP: (data: unknown) => DHCP;
 export declare const unmarshalGatewayNetwork: (data: unknown) => GatewayNetwork;
 export declare const unmarshalIP: (data: unknown) => IP;
@@ -29,3 +29,4 @@ export declare const marshalUpdateGatewayNetworkRequest: (request: UpdateGateway
 export declare const marshalUpdateGatewayRequest: (request: UpdateGatewayRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalUpdateIPRequest: (request: UpdateIPRequest, defaults: DefaultValues) => Record<string, unknown>;
 export declare const marshalUpdatePATRuleRequest: (request: UpdatePATRuleRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpgradeGatewayRequest: (request: UpgradeGatewayRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/api/vpcgw/v1/marshalling.gen.js

@@ -405,6 +405,9 @@ const marshalUpdatePATRuleRequest = (request, defaults) => ({
   protocol: request.protocol,
   public_port: request.publicPort
 });
+const marshalUpgradeGatewayRequest = (request, defaults) => ({
+  type: request.type
+});
 export {
   marshalCreateDHCPEntryRequest,
   marshalCreateDHCPRequest,
@@ -420,6 +423,7 @@ export {
   marshalUpdateGatewayRequest,
   marshalUpdateIPRequest,
   marshalUpdatePATRuleRequest,
+  marshalUpgradeGatewayRequest,
   unmarshalDHCP,
   unmarshalDHCPEntry,
   unmarshalGateway,

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

@@ -898,4 +898,6 @@ export type UpgradeGatewayRequest = {
     zone?: Zone;
     /** ID of the gateway to upgrade. */
     gatewayId: string;
+    /** Gateway type (commercial offer). */
+    type?: string;
 };

package/dist/api/webhosting/v1alpha1/api.gen.cjs

@@ -241,4 +241,95 @@ class API extends api.API {
     marshalling_gen.unmarshalResetHostingPasswordResponse
   );
 }
+class ClassicMailAPI extends api.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  /**
+   * Create a new mailbox within your hosting plan.. Create a new mailbox within
+   * your hosting plan.
+   *
+   * @param request - The request {@link ClassicMailApiCreateMailboxRequest}
+   * @returns A Promise of Mailbox
+   */
+  createMailbox = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalClassicMailApiCreateMailboxRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes`
+    },
+    marshalling_gen.unmarshalMailbox
+  );
+  /**
+   * Get a mailbox by id within your hosting plan.. Get a mailbox by id within
+   * your hosting plan.
+   *
+   * @param request - The request {@link ClassicMailApiGetMailboxRequest}
+   * @returns A Promise of Mailbox
+   */
+  getMailbox = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes/${marshalling.validatePathParam("mailboxId", request.mailboxId)}`
+    },
+    marshalling_gen.unmarshalMailbox
+  );
+  pageOfListMailboxes = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes`,
+      urlParams: marshalling.urlParams(
+        ["domain", request.domain],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListMailboxesResponse
+  );
+  /**
+   * List all mailboxes within your hosting plan.. List all mailboxes within
+   * your hosting plan.
+   *
+   * @param request - The request {@link ClassicMailApiListMailboxesRequest}
+   * @returns A Promise of ListMailboxesResponse
+   */
+  listMailboxes = (request) => resourcePaginator.enrichForPagination("mailboxes", this.pageOfListMailboxes, request);
+  deleteMailbox = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes/${marshalling.validatePathParam("mailboxId", request.mailboxId)}`
+    },
+    marshalling_gen.unmarshalMailbox
+  );
+  /**
+   * Update the mailbox within your hosting plan.. Update the mailbox within
+   * your hosting plan.
+   *
+   * @param request - The request {@link ClassicMailApiUpdateMailboxRequest}
+   * @returns A Promise of Mailbox
+   */
+  updateMailbox = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalClassicMailApiUpdateMailboxRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/webhosting/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/classic-hostings/${marshalling.validatePathParam("onlineId", request.onlineId)}/mailboxes/${marshalling.validatePathParam("mailboxId", request.mailboxId)}`
+    },
+    marshalling_gen.unmarshalMailbox
+  );
+}
 exports.API = API;
+exports.ClassicMailAPI = ClassicMailAPI;

package/dist/api/webhosting/v1alpha1/api.gen.d.ts

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
-import type { CheckUserOwnsDomainRequest, CheckUserOwnsDomainResponse, CreateHostingRequest, CreateSessionRequest, DeleteHostingRequest, DnsRecords, GetDomainDnsRecordsRequest, GetHostingRequest, Hosting, ListControlPanelsRequest, ListControlPanelsResponse, ListHostingsRequest, ListHostingsResponse, ListOffersRequest, ListOffersResponse, ResetHostingPasswordRequest, ResetHostingPasswordResponse, RestoreHostingRequest, Session, UpdateHostingRequest } from './types.gen';
+import type { CheckUserOwnsDomainRequest, CheckUserOwnsDomainResponse, ClassicMailApiCreateMailboxRequest, ClassicMailApiDeleteMailboxRequest, ClassicMailApiGetMailboxRequest, ClassicMailApiListMailboxesRequest, ClassicMailApiUpdateMailboxRequest, CreateHostingRequest, CreateSessionRequest, DeleteHostingRequest, DnsRecords, GetDomainDnsRecordsRequest, GetHostingRequest, Hosting, ListControlPanelsRequest, ListControlPanelsResponse, ListHostingsRequest, ListHostingsResponse, ListMailboxesResponse, ListOffersRequest, ListOffersResponse, Mailbox, ResetHostingPasswordRequest, ResetHostingPasswordResponse, RestoreHostingRequest, Session, UpdateHostingRequest } from './types.gen';
 /**
  * Web Hosting API.
  *
@@ -120,3 +120,49 @@ export declare class API extends ParentAPI {
     createSession: (request: Readonly<CreateSessionRequest>) => Promise<Session>;
     resetHostingPassword: (request: Readonly<ResetHostingPasswordRequest>) => Promise<ResetHostingPasswordResponse>;
 }
+/**
+ * Web Hosting Classic Mailbox API.
+ *
+ * This API allows you to manage your mailboxes for your Web Hosting services.
+ */
+export declare class ClassicMailAPI extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: Region[];
+    /**
+     * Create a new mailbox within your hosting plan.. Create a new mailbox within
+     * your hosting plan.
+     *
+     * @param request - The request {@link ClassicMailApiCreateMailboxRequest}
+     * @returns A Promise of Mailbox
+     */
+    createMailbox: (request: Readonly<ClassicMailApiCreateMailboxRequest>) => Promise<Mailbox>;
+    /**
+     * Get a mailbox by id within your hosting plan.. Get a mailbox by id within
+     * your hosting plan.
+     *
+     * @param request - The request {@link ClassicMailApiGetMailboxRequest}
+     * @returns A Promise of Mailbox
+     */
+    getMailbox: (request: Readonly<ClassicMailApiGetMailboxRequest>) => Promise<Mailbox>;
+    protected pageOfListMailboxes: (request: Readonly<ClassicMailApiListMailboxesRequest>) => Promise<ListMailboxesResponse>;
+    /**
+     * List all mailboxes within your hosting plan.. List all mailboxes within
+     * your hosting plan.
+     *
+     * @param request - The request {@link ClassicMailApiListMailboxesRequest}
+     * @returns A Promise of ListMailboxesResponse
+     */
+    listMailboxes: (request: Readonly<ClassicMailApiListMailboxesRequest>) => Promise<ListMailboxesResponse> & {
+        all: () => Promise<Mailbox[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Mailbox[], void, void>;
+    };
+    deleteMailbox: (request: Readonly<ClassicMailApiDeleteMailboxRequest>) => Promise<Mailbox>;
+    /**
+     * Update the mailbox within your hosting plan.. Update the mailbox within
+     * your hosting plan.
+     *
+     * @param request - The request {@link ClassicMailApiUpdateMailboxRequest}
+     * @returns A Promise of Mailbox
+     */
+    updateMailbox: (request: Readonly<ClassicMailApiUpdateMailboxRequest>) => Promise<Mailbox>;
+}