@scaleway/sdk-webhosting 1.1.2 → 1.1.3

package/dist/v1/api.gen.cjs

@@ -7,12 +7,13 @@ const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
 class ControlPanelAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListControlPanels = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -36,12 +37,13 @@ class ControlPanelAPI extends sdkClient.API {
   listControlPanels = (request = {}) => sdkClient.enrichForPagination("controlPanels", this.pageOfListControlPanels, request);
 }
 class DatabaseAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * "Create a new database within your hosting plan".
    *
@@ -240,12 +242,13 @@ class DatabaseAPI extends sdkClient.API {
   );
 }
 class DnsAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["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.
    *
@@ -353,12 +356,13 @@ class DnsAPI extends sdkClient.API {
   );
 }
 class OfferAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListOffers = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -385,12 +389,13 @@ class OfferAPI extends sdkClient.API {
   listOffers = (request = {}) => sdkClient.enrichForPagination("offers", this.pageOfListOffers, request);
 }
 class HostingAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["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.
    *
@@ -539,12 +544,13 @@ class HostingAPI extends sdkClient.API {
   );
 }
 class FtpAccountAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan.
    *
@@ -617,12 +623,13 @@ class FtpAccountAPI extends sdkClient.API {
   );
 }
 class MailAccountAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.
    *
@@ -708,12 +715,13 @@ class MailAccountAPI extends sdkClient.API {
   );
 }
 class WebsiteAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListWebsites = (request) => this.client.fetch(
     {
       method: "GET",

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

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
+import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
 import type { CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, DnsApiCheckUserOwnsDomainRequest, DnsApiGetDomainDnsRecordsRequest, DnsApiGetDomainRequest, DnsApiSearchDomainsRequest, DnsApiSyncDomainDnsRecordsRequest, DnsRecords, Domain, 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, SearchDomainsResponse, Session, WebsiteApiListWebsitesRequest } from './types.gen';
 /**
  * Web Hosting Control Panel API.
@@ -7,8 +7,11 @@ import type { CheckUserOwnsDomainResponse, ControlPanelApiListControlPanelsReque
 This API allows you to manage your Web Hosting services.
  */
 export declare class ControlPanelAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     protected pageOfListControlPanels: (request?: Readonly<ControlPanelApiListControlPanelsRequest>) => Promise<ListControlPanelsResponse>;
     /**
      * "List the control panels type: cpanel or plesk.".
@@ -27,8 +30,11 @@ export declare class ControlPanelAPI extends ParentAPI {
 This API allows you to manage your databases and database users for your Web Hosting services.
  */
 export declare class DatabaseAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * "Create a new database within your hosting plan".
      *
@@ -121,8 +127,11 @@ export declare class DatabaseAPI extends ParentAPI {
 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: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain.
      *
@@ -173,8 +182,11 @@ export declare class DnsAPI extends ParentAPI {
 This API allows you to manage your offer for your Web Hosting services.
  */
 export declare class OfferAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     protected pageOfListOffers: (request?: Readonly<OfferApiListOffersRequest>) => Promise<ListOffersResponse>;
     /**
      * List all available hosting offers along with their specific options.. List all available hosting offers along with their specific options.
@@ -193,8 +205,11 @@ export declare class OfferAPI extends ParentAPI {
 This API allows you to manage your Web Hosting services.
  */
 export declare class HostingAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the `offer_id` parameter.
      *
@@ -270,8 +285,11 @@ export declare class HostingAPI extends ParentAPI {
 This API allows you to manage your FTP accounts for your Web Hosting services.
  */
 export declare class FtpAccountAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan.
      *
@@ -305,8 +323,11 @@ export declare class FtpAccountAPI extends ParentAPI {
 This API allows you to manage your mail accounts for your Web Hosting services.
  */
 export declare class MailAccountAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.
      *
@@ -346,8 +367,11 @@ export declare class MailAccountAPI extends ParentAPI {
 This API allows you to manage your websites for your Web Hosting services.
  */
 export declare class WebsiteAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     protected pageOfListWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse>;
     /**
      * List all websites for a specific hosting.. List all websites for a specific hosting.

package/dist/v1/api.gen.js

@@ -1,16 +1,17 @@
-import { API, urlParams, validatePathParam, enrichForPagination, waitForResource } from "@scaleway/sdk-client";
+import { API, toApiLocality, urlParams, validatePathParam, enrichForPagination, waitForResource } from "@scaleway/sdk-client";
 import { DOMAIN_TRANSIENT_STATUSES, HOSTING_TRANSIENT_STATUSES } from "./content.gen.js";
-import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalDnsRecords, marshalDnsApiCheckUserOwnsDomainRequest, unmarshalCheckUserOwnsDomainResponse, marshalDnsApiSyncDomainDnsRecordsRequest, unmarshalSearchDomainsResponse, unmarshalDomain, marshalFtpAccountApiCreateFtpAccountRequest, unmarshalFtpAccount, unmarshalListFtpAccountsResponse, marshalFtpAccountApiChangeFtpAccountPasswordRequest, marshalHostingApiCreateHostingRequest, unmarshalHosting, unmarshalListHostingsResponse, marshalHostingApiUpdateHostingRequest, unmarshalSession, unmarshalResetHostingPasswordResponse, unmarshalResourceSummary, marshalMailAccountApiCreateMailAccountRequest, unmarshalMailAccount, unmarshalListMailAccountsResponse, marshalMailAccountApiRemoveMailAccountRequest, marshalMailAccountApiChangeMailAccountPasswordRequest, unmarshalListOffersResponse, unmarshalListWebsitesResponse } from "./marshalling.gen.js";
+import { unmarshalListControlPanelsResponse, marshalDatabaseApiCreateDatabaseRequest, unmarshalDatabase, unmarshalListDatabasesResponse, marshalDatabaseApiCreateDatabaseUserRequest, unmarshalDatabaseUser, unmarshalListDatabaseUsersResponse, marshalDatabaseApiChangeDatabaseUserPasswordRequest, marshalDatabaseApiAssignDatabaseUserRequest, marshalDatabaseApiUnassignDatabaseUserRequest, unmarshalDnsRecords, marshalDnsApiCheckUserOwnsDomainRequest, unmarshalCheckUserOwnsDomainResponse, marshalDnsApiSyncDomainDnsRecordsRequest, unmarshalSearchDomainsResponse, unmarshalDomain, 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 {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListControlPanels = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -34,12 +35,13 @@ class ControlPanelAPI extends API {
   listControlPanels = (request = {}) => enrichForPagination("controlPanels", this.pageOfListControlPanels, request);
 }
 class DatabaseAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * "Create a new database within your hosting plan".
    *
@@ -238,12 +240,13 @@ class DatabaseAPI extends API {
   );
 }
 class DnsAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["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.
    *
@@ -351,12 +354,13 @@ class DnsAPI extends API {
   );
 }
 class OfferAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListOffers = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -383,12 +387,13 @@ class OfferAPI extends API {
   listOffers = (request = {}) => enrichForPagination("offers", this.pageOfListOffers, request);
 }
 class HostingAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["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.
    *
@@ -537,12 +542,13 @@ class HostingAPI extends API {
   );
 }
 class FtpAccountAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan.
    *
@@ -615,12 +621,13 @@ class FtpAccountAPI extends API {
   );
 }
 class MailAccountAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.
    *
@@ -706,12 +713,13 @@ class MailAccountAPI extends API {
   );
 }
 class WebsiteAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   pageOfListWebsites = (request) => this.client.fetch(
     {
       method: "GET",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-webhosting",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Scaleway SDK webhosting",
   "license": "Apache-2.0",
   "files": [
@@ -30,13 +30,13 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.4"
+    "@scaleway/sdk-std": "1.0.5"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.2.3"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.2.3"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "scripts": {
     "package:check": "pnpm publint",