@scaleway/sdk 2.57.0 → 2.59.0

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

@@ -0,0 +1,450 @@
+import type { Zone } from '../../../bridge';
+export type GatewayNetworkStatus = 'unknown_status' | 'created' | 'attaching' | 'configuring' | 'ready' | 'detaching';
+export type GatewayStatus = 'unknown_status' | 'stopped' | 'allocating' | 'configuring' | 'running' | 'stopping' | 'failed' | 'deleting' | 'locked';
+export type ListGatewayNetworksRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'status_asc' | 'status_desc';
+export type ListGatewaysRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'type_asc' | 'type_desc' | 'status_asc' | 'status_desc';
+export type ListIPsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'address_asc' | 'address_desc' | 'reverse_asc' | 'reverse_desc';
+export type ListPatRulesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'public_port_asc' | 'public_port_desc';
+export type PatRuleProtocol = 'unknown_protocol' | 'both' | 'tcp' | 'udp';
+export interface GatewayNetwork {
+    /** ID of the Public Gateway-Private Network connection. */
+    id: string;
+    /** Connection creation date. */
+    createdAt?: Date;
+    /** Connection last modification date. */
+    updatedAt?: Date;
+    /** ID of the connected Public Gateway. */
+    gatewayId: string;
+    /** ID of the connected Private Network. */
+    privateNetworkId: string;
+    /**
+     * MAC address of the gateway in the Private Network (if the gateway is up and
+     * running).
+     */
+    macAddress?: string;
+    /**
+     * Defines whether the gateway masquerades traffic for this Private Network
+     * (Dynamic NAT).
+     */
+    masqueradeEnabled: boolean;
+    /** Current status of the Public Gateway's connection to the Private Network. */
+    status: GatewayNetworkStatus;
+    /** Enabling the default route also enables masquerading. */
+    pushDefaultRoute: boolean;
+    /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */
+    ipamIpId: string;
+    /** Zone of the GatewayNetwork connection. */
+    zone: Zone;
+}
+export interface IP {
+    /** IP address ID. */
+    id: string;
+    /** Owning Organization. */
+    organizationId: string;
+    /** Owning Project. */
+    projectId: string;
+    /** IP address creation date. */
+    createdAt?: Date;
+    /** IP address last modification date. */
+    updatedAt?: Date;
+    /** Tags associated with the IP address. */
+    tags: string[];
+    /** The IP address itself. */
+    address: string;
+    /** Reverse domain name for the IP address. */
+    reverse?: string;
+    /** Public Gateway associated with the IP address. */
+    gatewayId?: string;
+    /** Zone of the IP address. */
+    zone: Zone;
+}
+export interface GatewayType {
+    /** Public Gateway type name. */
+    name: string;
+    /**
+     * Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to
+     * the outer Internet, and the internal bandwidth to each connected Private
+     * Networks.
+     */
+    bandwidth: number;
+    /** Zone the Public Gateway type is available in. */
+    zone: Zone;
+}
+export interface Gateway {
+    /** ID of the gateway. */
+    id: string;
+    /** Owning Organization. */
+    organizationId: string;
+    /** Owning Project. */
+    projectId: string;
+    /** Gateway creation date. */
+    createdAt?: Date;
+    /** Gateway last modification date. */
+    updatedAt?: Date;
+    /** Gateway type name (commercial offer). */
+    type: string;
+    /** Bandwidth available of the gateway. */
+    bandwidth: number;
+    /** Current status of the gateway. */
+    status: GatewayStatus;
+    /** Name of the gateway. */
+    name: string;
+    /** Tags associated with the gateway. */
+    tags: string[];
+    /** Public IPv4 address of the gateway. */
+    ipv4?: IP;
+    /**
+     * GatewayNetwork objects attached to the gateway (each one represents a
+     * connection to a Private Network).
+     */
+    gatewayNetworks: GatewayNetwork[];
+    /** Version of the running gateway software. */
+    version?: string;
+    /** Newly available gateway software version that can be updated to. */
+    canUpgradeTo?: string;
+    /** Defines whether SSH bastion is enabled on the gateway. */
+    bastionEnabled: boolean;
+    /** Port of the SSH bastion. */
+    bastionPort: number;
+    /** Defines whether SMTP traffic is allowed to pass through the gateway. */
+    smtpEnabled: boolean;
+    /** Defines whether the gateway uses non-IPAM IP configurations. */
+    isLegacy: boolean;
+    /** Zone of the gateway. */
+    zone: Zone;
+}
+export interface PatRule {
+    /** PAT rule ID. */
+    id: string;
+    /** Gateway the PAT rule applies to. */
+    gatewayId: string;
+    /** PAT rule creation date. */
+    createdAt?: Date;
+    /** PAT rule last modification date. */
+    updatedAt?: Date;
+    /** Public port to listen on. */
+    publicPort: number;
+    /** Private IP address to forward data to. */
+    privateIp: string;
+    /** Private port to translate to. */
+    privatePort: number;
+    /** Protocol the rule applies to. */
+    protocol: PatRuleProtocol;
+    /** Zone of the PAT rule. */
+    zone: Zone;
+}
+export interface SetPatRulesRequestRule {
+    /**
+     * Public port to listen on. Uniquely identifies the rule, and a matching rule
+     * will be updated with the new parameters.
+     */
+    publicPort: number;
+    /** Private IP to forward data to. */
+    privateIp: string;
+    /** Private port to translate to. */
+    privatePort: number;
+    /** Protocol the rule should apply to. */
+    protocol: PatRuleProtocol;
+}
+export type CreateGatewayNetworkRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Public Gateway to connect. */
+    gatewayId: string;
+    /** Private Network to connect. */
+    privateNetworkId: string;
+    /** Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. */
+    enableMasquerade: boolean;
+    /** Enabling the default route also enables masquerading. */
+    pushDefaultRoute: boolean;
+    /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */
+    ipamIpId?: string;
+};
+export type CreateGatewayRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Scaleway Project to create the gateway in. */
+    projectId?: string;
+    /** Name for the gateway. */
+    name?: string;
+    /** Tags for the gateway. */
+    tags?: string[];
+    /** Gateway type (commercial offer type). */
+    type: string;
+    /** Existing IP address to attach to the gateway. */
+    ipId?: string;
+    /** Defines whether SMTP traffic should be allowed pass through the gateway. */
+    enableSmtp: boolean;
+    /** Defines whether SSH bastion should be enabled the gateway. */
+    enableBastion: boolean;
+    /** Port of the SSH bastion. */
+    bastionPort?: number;
+};
+export type CreateIPRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Project to create the IP address in. */
+    projectId?: string;
+    /** Tags to give to the IP address. */
+    tags?: string[];
+};
+export type CreatePatRuleRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the Gateway on which to create the rule. */
+    gatewayId: string;
+    /** Public port to listen on. */
+    publicPort: number;
+    /** Private IP to forward data to. */
+    privateIp: string;
+    /** Private port to translate to. */
+    privatePort: number;
+    /** Protocol the rule should apply to. */
+    protocol?: PatRuleProtocol;
+};
+export type DeleteGatewayNetworkRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the GatewayNetwork to delete. */
+    gatewayNetworkId: string;
+};
+export type DeleteGatewayRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the gateway to delete. */
+    gatewayId: string;
+};
+export type DeleteIPRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the IP address to delete. */
+    ipId: string;
+};
+export type DeletePatRuleRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the PAT rule to delete. */
+    patRuleId: string;
+};
+export type GetGatewayNetworkRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the GatewayNetwork to fetch. */
+    gatewayNetworkId: string;
+};
+export type GetGatewayRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the gateway to fetch. */
+    gatewayId: string;
+};
+export type GetIPRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the IP address to get. */
+    ipId: string;
+};
+export type GetPatRuleRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the PAT rule to get. */
+    patRuleId: string;
+};
+export type ListGatewayNetworksRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Order in which to return results. */
+    orderBy?: ListGatewayNetworksRequestOrderBy;
+    /** Page number. */
+    page?: number;
+    /** GatewayNetworks per page. */
+    pageSize?: number;
+    /**
+     * Filter for GatewayNetworks with these status. Use `unknown` to include all
+     * statuses.
+     */
+    status?: GatewayNetworkStatus[];
+    /** Filter for GatewayNetworks connected to these gateways. */
+    gatewayIds?: string[];
+    /** Filter for GatewayNetworks connected to these Private Networks. */
+    privateNetworkIds?: string[];
+    /** Filter for GatewayNetworks with this `enable_masquerade` setting. */
+    masqueradeEnabled?: boolean;
+};
+export interface ListGatewayNetworksResponse {
+    /** GatewayNetworks on this page. */
+    gatewayNetworks: GatewayNetwork[];
+    /** Total GatewayNetworks count matching the filter. */
+    totalCount: number;
+}
+export type ListGatewayTypesRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+};
+export interface ListGatewayTypesResponse {
+    /** Available types of Public Gateway. */
+    types: GatewayType[];
+}
+export type ListGatewaysRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Order in which to return results. */
+    orderBy?: ListGatewaysRequestOrderBy;
+    /** Page number to return. */
+    page?: number;
+    /** Gateways per page. */
+    pageSize?: number;
+    /** Include only gateways in this Organization. */
+    organizationId?: string;
+    /** Include only gateways in this Project. */
+    projectId?: string;
+    /** Filter for gateways which have this search term in their name. */
+    name?: string;
+    /** Filter for gateways with these tags. */
+    tags?: string[];
+    /** Filter for gateways of these types. */
+    types?: string[];
+    /**
+     * Filter for gateways with these status. Use `unknown` to include all
+     * statuses.
+     */
+    status?: GatewayStatus[];
+    /** Filter for gateways attached to these Private Networks. */
+    privateNetworkIds?: string[];
+    /** Include also legacy gateways. */
+    includeLegacy?: boolean;
+};
+export interface ListGatewaysResponse {
+    /** Gateways on this page. */
+    gateways: Gateway[];
+    /** Total count of gateways matching the filter. */
+    totalCount: number;
+}
+export type ListIPsRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Order in which to return results. */
+    orderBy?: ListIPsRequestOrderBy;
+    /** Page number. */
+    page?: number;
+    /** IP addresses per page. */
+    pageSize?: number;
+    /** Include only gateways in this Organization. */
+    organizationId?: string;
+    /** Filter for IP addresses in this Project. */
+    projectId?: string;
+    /** Filter for IP addresses with these tags. */
+    tags?: string[];
+    /** Filter for IP addresses that have a reverse containing this string. */
+    reverse?: string;
+    /** Filter based on whether the IP is attached to a gateway or not. */
+    isFree?: boolean;
+};
+export interface ListIPsResponse {
+    /** IP addresses on this page. */
+    ips: IP[];
+    /** Total count of IP addresses matching the filter. */
+    totalCount: number;
+}
+export type ListPatRulesRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** Order in which to return results. */
+    orderBy?: ListPatRulesRequestOrderBy;
+    /** Page number. */
+    page?: number;
+    /** PAT rules per page. */
+    pageSize?: number;
+    /** Filter for PAT rules on these gateways. */
+    gatewayIds?: string[];
+    /** Filter for PAT rules targeting these private ips. */
+    privateIps?: string[];
+    /** Filter for PAT rules with this protocol. */
+    protocol?: PatRuleProtocol;
+};
+export interface ListPatRulesResponse {
+    /** Array of PAT rules matching the filter. */
+    patRules: PatRule[];
+    /** Total count of PAT rules matching the filter. */
+    totalCount: number;
+}
+export type RefreshSSHKeysRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the gateway to refresh SSH keys on. */
+    gatewayId: string;
+};
+export type SetPatRulesRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the gateway on which to set the PAT rules. */
+    gatewayId: string;
+    /** New list of PAT rules. */
+    patRules: SetPatRulesRequestRule[];
+};
+export interface SetPatRulesResponse {
+    /** List of PAT rules. */
+    patRules: PatRule[];
+}
+export type UpdateGatewayNetworkRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the GatewayNetwork to update. */
+    gatewayNetworkId: string;
+    /** Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. */
+    enableMasquerade?: boolean;
+    /** Enabling the default route also enables masquerading. */
+    pushDefaultRoute?: boolean;
+    /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */
+    ipamIpId?: string;
+};
+export type UpdateGatewayRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the gateway to update. */
+    gatewayId: string;
+    /** Name for the gateway. */
+    name?: string;
+    /** Tags for the gateway. */
+    tags?: string[];
+    /** Defines whether SSH bastion should be enabled the gateway. */
+    enableBastion?: boolean;
+    /** Port of the SSH bastion. */
+    bastionPort?: number;
+    /** Defines whether SMTP traffic should be allowed to pass through the gateway. */
+    enableSmtp?: boolean;
+};
+export type UpdateIPRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the IP address to update. */
+    ipId: string;
+    /** Tags to give to the IP address. */
+    tags?: string[];
+    /** Reverse to set on the address. Empty string to unset. */
+    reverse?: string;
+    /** Gateway to attach the IP address to. Empty string to detach. */
+    gatewayId?: string;
+};
+export type UpdatePatRuleRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the PAT rule to update. */
+    patRuleId: string;
+    /** Public port to listen on. */
+    publicPort?: number;
+    /** Private IP to forward data to. */
+    privateIp?: string;
+    /** Private port to translate to. */
+    privatePort?: number;
+    /** Protocol the rule should apply to. */
+    protocol?: PatRuleProtocol;
+};
+export type UpgradeGatewayRequest = {
+    /** Zone to target. If none is passed will use default zone from the config. */
+    zone?: Zone;
+    /** ID of the gateway to upgrade. */
+    gatewayId: string;
+    /** Gateway type (commercial offer). */
+    type?: string;
+};

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

@@ -12,7 +12,7 @@ const jsonContentHeaders = {
 };
 class ControlPanelAPI extends api.API {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ["fr-par", "nl-ams"];
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
   pageOfListControlPanels = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -236,6 +236,44 @@ class DatabaseAPI extends api.API {
     marshalling_gen.unmarshalDatabaseUser
   );
 }
+class DnsAPI extends api.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["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.
+   *
+   * @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
+   * @returns A Promise of DnsRecords
+   */
+  getDomainDnsRecords = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/dns-records`
+    },
+    marshalling_gen.unmarshalDnsRecords
+  );
+  /**
+   * "Check whether you own this domain or not.".
+   *
+   * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
+   * @returns A Promise of CheckUserOwnsDomainResponse
+   */
+  checkUserOwnsDomain = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalDnsApiCheckUserOwnsDomainRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${marshalling.validatePathParam("domain", request.domain)}/check-ownership`
+    },
+    marshalling_gen.unmarshalCheckUserOwnsDomainResponse
+  );
+}
 class OfferAPI extends api.API {
   /** Lists the available regions of the API. */
   static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
@@ -267,7 +305,7 @@ class OfferAPI extends api.API {
 }
 class HostingAPI extends api.API {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ["fr-par", "nl-ams"];
+  static LOCALITIES = ["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.
@@ -621,6 +659,7 @@ class WebsiteAPI extends api.API {
 }
 exports.ControlPanelAPI = ControlPanelAPI;
 exports.DatabaseAPI = DatabaseAPI;
+exports.DnsAPI = DnsAPI;
 exports.FtpAccountAPI = FtpAccountAPI;
 exports.HostingAPI = HostingAPI;
 exports.MailAccountAPI = MailAccountAPI;

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

@@ -1,8 +1,8 @@
 import { API as ParentAPI } from '../../../bridge';
 import type { Region, WaitForOptions } from '../../../bridge';
-import type { ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, 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, Session, WebsiteApiListWebsitesRequest } from './types.gen';
+import type { CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsRecords, 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, Session, WebsiteApiListWebsitesRequest } from './types.gen';
 /**
- * Web Hosting API.
+ * Web Hosting Control Panel API.
  *
  * This API allows you to manage your Web Hosting services.
  */
@@ -117,6 +117,30 @@ export declare class DatabaseAPI extends ParentAPI {
      */
     unassignDatabaseUser: (request: Readonly<DatabaseApiUnassignDatabaseUserRequest>) => Promise<DatabaseUser>;
 }
+/**
+ * Web Hosting Dns API.
+ *
+ * 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: Region[];
+    /**
+     * Get DNS records. Get the set of DNS records of a specified domain
+     * associated with a Web Hosting plan's domain.
+     *
+     * @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
+     * @returns A Promise of DnsRecords
+     */
+    getDomainDnsRecords: (request: Readonly<DnsApiGetDomainDnsRecordsRequest>) => Promise<DnsRecords>;
+    /**
+     * "Check whether you own this domain or not.".
+     *
+     * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
+     * @returns A Promise of CheckUserOwnsDomainResponse
+     */
+    checkUserOwnsDomain: (request: Readonly<DnsApiCheckUserOwnsDomainRequest>) => Promise<CheckUserOwnsDomainResponse>;
+}
 /**
  * Web Hosting Offer API.
  *

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

@@ -4,13 +4,13 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
 import "../../../vendor/base64/index.js";
 import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
 import { HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
-import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalListOffersResponse, marshalHostingApiCreateHostingRequest, unmarshalHosting, unmarshalListHostingsResponse, marshalHostingApiUpdateHostingRequest, unmarshalSession, unmarshalResetHostingPasswordResponse, unmarshalResourceSummary, marshalFtpAccountApiCreateFtpAccountRequest, unmarshalFtpAccount, unmarshalListFtpAccountsResponse, marshalFtpAccountApiChangeFtpAccountPasswordRequest, marshalMailAccountApiCreateMailAccountRequest, unmarshalMailAccount, unmarshalListMailAccountsResponse, marshalMailAccountApiRemoveMailAccountRequest, marshalMailAccountApiChangeMailAccountPasswordRequest, unmarshalListWebsitesResponse } from "./marshalling.gen.js";
+import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalDnsRecords, marshalDnsApiCheckUserOwnsDomainRequest, unmarshalCheckUserOwnsDomainResponse, unmarshalListOffersResponse, marshalHostingApiCreateHostingRequest, unmarshalHosting, unmarshalListHostingsResponse, marshalHostingApiUpdateHostingRequest, unmarshalSession, unmarshalResetHostingPasswordResponse, unmarshalResourceSummary, marshalFtpAccountApiCreateFtpAccountRequest, unmarshalFtpAccount, unmarshalListFtpAccountsResponse, marshalFtpAccountApiChangeFtpAccountPasswordRequest, marshalMailAccountApiCreateMailAccountRequest, unmarshalMailAccount, unmarshalListMailAccountsResponse, marshalMailAccountApiRemoveMailAccountRequest, marshalMailAccountApiChangeMailAccountPasswordRequest, unmarshalListWebsitesResponse } from "./marshalling.gen.js";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
 class ControlPanelAPI extends API$1 {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ["fr-par", "nl-ams"];
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
   pageOfListControlPanels = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -234,6 +234,44 @@ class DatabaseAPI extends API$1 {
     unmarshalDatabaseUser
   );
 }
+class DnsAPI extends API$1 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["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.
+   *
+   * @param request - The request {@link DnsApiGetDomainDnsRecordsRequest}
+   * @returns A Promise of DnsRecords
+   */
+  getDomainDnsRecords = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/webhosting/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam("domain", request.domain)}/dns-records`
+    },
+    unmarshalDnsRecords
+  );
+  /**
+   * "Check whether you own this domain or not.".
+   *
+   * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest}
+   * @returns A Promise of CheckUserOwnsDomainResponse
+   */
+  checkUserOwnsDomain = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalDnsApiCheckUserOwnsDomainRequest(
+          request,
+          this.client.settings
+        )
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/webhosting/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam("domain", request.domain)}/check-ownership`
+    },
+    unmarshalCheckUserOwnsDomainResponse
+  );
+}
 class OfferAPI extends API$1 {
   /** Lists the available regions of the API. */
   static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
@@ -265,7 +303,7 @@ class OfferAPI extends API$1 {
 }
 class HostingAPI extends API$1 {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ["fr-par", "nl-ams"];
+  static LOCALITIES = ["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.
@@ -620,6 +658,7 @@ class WebsiteAPI extends API$1 {
 export {
   ControlPanelAPI,
   DatabaseAPI,
+  DnsAPI,
   FtpAccountAPI,
   HostingAPI,
   MailAccountAPI,

package/dist/api/webhosting/v1/index.gen.cjs

@@ -5,6 +5,7 @@ const content_gen = require("./content.gen.cjs");
 const validationRules_gen = require("./validation-rules.gen.cjs");
 exports.ControlPanelAPI = api_gen.ControlPanelAPI;
 exports.DatabaseAPI = api_gen.DatabaseAPI;
+exports.DnsAPI = api_gen.DnsAPI;
 exports.FtpAccountAPI = api_gen.FtpAccountAPI;
 exports.HostingAPI = api_gen.HostingAPI;
 exports.MailAccountAPI = api_gen.MailAccountAPI;

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

@@ -1,4 +1,4 @@
-export { ControlPanelAPI, DatabaseAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI, } from './api.gen';
+export { ControlPanelAPI, DatabaseAPI, DnsAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI, } from './api.gen';
 export * from './content.gen';
-export type { ControlPanel, ControlPanelApiListControlPanelsRequest, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingCpanelUrls, HostingDnsStatus, HostingOption, HostingStatus, HostingSummary, HostingSummaryStatus, ListControlPanelsResponse, ListDatabaseUsersRequestOrderBy, ListDatabaseUsersResponse, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListFtpAccountsRequestOrderBy, ListFtpAccountsResponse, ListHostingsRequestOrderBy, ListHostingsResponse, ListMailAccountsRequestOrderBy, ListMailAccountsResponse, ListOffersRequestOrderBy, ListOffersResponse, ListWebsitesRequestOrderBy, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, Offer, OfferApiListOffersRequest, OfferOption, OfferOptionName, OfferOptionRequest, OfferOptionWarning, ResetHostingPasswordResponse, ResourceSummary, Session, Website, WebsiteApiListWebsitesRequest, } from './types.gen';
+export type { CheckUserOwnsDomainResponse, ControlPanel, ControlPanelApiListControlPanelsRequest, CreateDatabaseRequestUser, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsRecord, DnsRecordStatus, DnsRecordType, DnsRecords, DnsRecordsStatus, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiGetResourceSummaryRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingStatus, HostingSummary, HostingSummaryStatus, HostingUser, ListControlPanelsResponse, ListDatabaseUsersRequestOrderBy, ListDatabaseUsersResponse, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListFtpAccountsRequestOrderBy, ListFtpAccountsResponse, ListHostingsRequestOrderBy, ListHostingsResponse, ListMailAccountsRequestOrderBy, ListMailAccountsResponse, ListOffersRequestOrderBy, ListOffersResponse, ListWebsitesRequestOrderBy, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, Nameserver, NameserverStatus, Offer, OfferApiListOffersRequest, OfferOption, OfferOptionName, OfferOptionRequest, OfferOptionWarning, Platform, PlatformControlPanel, PlatformControlPanelUrls, PlatformPlatformGroup, ResetHostingPasswordResponse, ResourceSummary, Session, Website, WebsiteApiListWebsitesRequest, } from './types.gen';
 export * as ValidationRules from './validation-rules.gen';

package/dist/api/webhosting/v1/index.gen.js

@@ -1,9 +1,10 @@
-import { ControlPanelAPI, DatabaseAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI } from "./api.gen.js";
+import { ControlPanelAPI, DatabaseAPI, DnsAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI } from "./api.gen.js";
 import { HOSTING_SUMMARY_TRANSIENT_STATUSES, HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
 import * as validationRules_gen from "./validation-rules.gen.js";
 export {
   ControlPanelAPI,
   DatabaseAPI,
+  DnsAPI,
   FtpAccountAPI,
   HOSTING_SUMMARY_TRANSIENT_STATUSES,
   HOSTING_TRANSIENT_STATUSES,