@scaleway/sdk 2.46.0 → 2.47.0

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

@@ -0,0 +1,391 @@
+import { isJSONObject } from "../../../helpers/json.js";
+import { unmarshalMoney } from "../../../scw/custom-marshalling.js";
+import { unmarshalDate, unmarshalArrayOfObject } from "../../../helpers/marshalling.js";
+const unmarshalDatabaseUser = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DatabaseUser' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    databases: data.databases,
+    username: data.username
+  };
+};
+const unmarshalDatabase = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Database' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    databaseName: data.database_name,
+    users: data.users
+  };
+};
+const unmarshalFtpAccount = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'FtpAccount' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    path: data.path,
+    username: data.username
+  };
+};
+const unmarshalMailAccount = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'MailAccount' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    domain: data.domain,
+    username: data.username
+  };
+};
+const unmarshalHostingCpanelUrls = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'HostingCpanelUrls' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    dashboard: data.dashboard,
+    webmail: data.webmail
+  };
+};
+const unmarshalHostingOption = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'HostingOption' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    id: data.id,
+    name: data.name,
+    quantity: data.quantity
+  };
+};
+const unmarshalHosting = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Hosting' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    contactEmail: data.contact_email,
+    controlPanelName: data.control_panel_name,
+    cpanelUrls: data.cpanel_urls ? unmarshalHostingCpanelUrls(data.cpanel_urls) : void 0,
+    createdAt: unmarshalDate(data.created_at),
+    dnsStatus: data.dns_status,
+    domain: data.domain,
+    id: data.id,
+    ipv4: data.ipv4,
+    ipv6: data.ipv6,
+    offerEndOfLife: data.offer_end_of_life,
+    offerId: data.offer_id,
+    offerName: data.offer_name,
+    oneTimePassword: data.one_time_password,
+    options: unmarshalArrayOfObject(data.options, unmarshalHostingOption),
+    platformGroup: data.platform_group,
+    platformHostname: data.platform_hostname,
+    platformNumber: data.platform_number,
+    projectId: data.project_id,
+    protected: data.protected,
+    region: data.region,
+    status: data.status,
+    tags: data.tags,
+    updatedAt: unmarshalDate(data.updated_at),
+    username: data.username
+  };
+};
+const unmarshalControlPanel = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ControlPanel' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    available: data.available,
+    availableLanguages: data.available_languages,
+    logoUrl: data.logo_url,
+    name: data.name
+  };
+};
+const unmarshalListControlPanelsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListControlPanelsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    controlPanels: unmarshalArrayOfObject(
+      data.control_panels,
+      unmarshalControlPanel
+    ),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListDatabaseUsersResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListDatabaseUsersResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    totalCount: data.total_count,
+    users: unmarshalArrayOfObject(data.users, unmarshalDatabaseUser)
+  };
+};
+const unmarshalListDatabasesResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListDatabasesResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    databases: unmarshalArrayOfObject(data.databases, unmarshalDatabase),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListFtpAccountsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListFtpAccountsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    ftpAccounts: unmarshalArrayOfObject(data.ftp_accounts, unmarshalFtpAccount),
+    totalCount: data.total_count
+  };
+};
+const unmarshalHostingSummary = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'HostingSummary' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    domain: data.domain,
+    id: data.id,
+    projectId: data.project_id,
+    protected: data.protected,
+    region: data.region,
+    status: data.status,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalListHostingsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListHostingsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    hostings: unmarshalArrayOfObject(data.hostings, unmarshalHostingSummary),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListMailAccountsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListMailAccountsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    mailAccounts: unmarshalArrayOfObject(
+      data.mail_accounts,
+      unmarshalMailAccount
+    ),
+    totalCount: data.total_count
+  };
+};
+const unmarshalOfferOption = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'OfferOption' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    billingOperationPath: data.billing_operation_path,
+    currentValue: data.current_value,
+    id: data.id,
+    maxValue: data.max_value,
+    minValue: data.min_value,
+    name: data.name,
+    quotaWarning: data.quota_warning
+  };
+};
+const unmarshalOffer = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Offer' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    available: data.available,
+    billingOperationPath: data.billing_operation_path,
+    controlPanelName: data.control_panel_name,
+    endOfLife: data.end_of_life,
+    id: data.id,
+    options: unmarshalArrayOfObject(data.options, unmarshalOfferOption),
+    price: data.price ? unmarshalMoney(data.price) : void 0
+  };
+};
+const unmarshalListOffersResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListOffersResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    offers: unmarshalArrayOfObject(data.offers, unmarshalOffer),
+    totalCount: data.total_count
+  };
+};
+const unmarshalWebsite = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Website' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    domain: data.domain,
+    path: data.path,
+    sslStatus: data.ssl_status
+  };
+};
+const unmarshalListWebsitesResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListWebsitesResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    totalCount: data.total_count,
+    websites: unmarshalArrayOfObject(data.websites, unmarshalWebsite)
+  };
+};
+const unmarshalResetHostingPasswordResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ResetHostingPasswordResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    oneTimePassword: data.one_time_password
+  };
+};
+const unmarshalSession = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Session' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    url: data.url
+  };
+};
+const marshalDatabaseApiAssignDatabaseUserRequest = (request, defaults) => ({
+  username: request.username
+});
+const marshalDatabaseApiChangeDatabaseUserPasswordRequest = (request, defaults) => ({
+  password: request.password
+});
+const marshalDatabaseApiCreateDatabaseRequest = (request, defaults) => ({
+  database_name: request.databaseName
+});
+const marshalDatabaseApiCreateDatabaseUserRequest = (request, defaults) => ({
+  password: request.password,
+  username: request.username
+});
+const marshalDatabaseApiUnassignDatabaseUserRequest = (request, defaults) => ({
+  username: request.username
+});
+const marshalFtpAccountApiChangeFtpAccountPasswordRequest = (request, defaults) => ({
+  password: request.password
+});
+const marshalFtpAccountApiCreateFtpAccountRequest = (request, defaults) => ({
+  password: request.password,
+  path: request.path,
+  username: request.username
+});
+const marshalCreateHostingRequestDomainConfiguration = (request, defaults) => ({
+  update_all_records: request.updateAllRecords,
+  update_mail_record: request.updateMailRecord,
+  update_nameservers: request.updateNameservers,
+  update_web_record: request.updateWebRecord
+});
+const marshalOfferOptionRequest = (request, defaults) => ({
+  id: request.id,
+  quantity: request.quantity
+});
+const marshalHostingApiCreateHostingRequest = (request, defaults) => ({
+  domain: request.domain,
+  domain_configuration: request.domainConfiguration !== void 0 ? marshalCreateHostingRequestDomainConfiguration(
+    request.domainConfiguration
+  ) : void 0,
+  email: request.email,
+  language: request.language,
+  offer_id: request.offerId,
+  offer_options: request.offerOptions !== void 0 ? request.offerOptions.map(
+    (elt) => marshalOfferOptionRequest(elt)
+  ) : void 0,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  skip_welcome_email: request.skipWelcomeEmail,
+  tags: request.tags
+});
+const marshalHostingApiUpdateHostingRequest = (request, defaults) => ({
+  email: request.email,
+  offer_id: request.offerId,
+  offer_options: request.offerOptions !== void 0 ? request.offerOptions.map(
+    (elt) => marshalOfferOptionRequest(elt)
+  ) : void 0,
+  protected: request.protected,
+  tags: request.tags
+});
+const marshalMailAccountApiChangeMailAccountPasswordRequest = (request, defaults) => ({
+  domain: request.domain,
+  password: request.password,
+  username: request.username
+});
+const marshalMailAccountApiCreateMailAccountRequest = (request, defaults) => ({
+  domain: request.domain,
+  password: request.password,
+  username: request.username
+});
+const marshalMailAccountApiRemoveMailAccountRequest = (request, defaults) => ({
+  domain: request.domain,
+  username: request.username
+});
+export {
+  marshalDatabaseApiAssignDatabaseUserRequest,
+  marshalDatabaseApiChangeDatabaseUserPasswordRequest,
+  marshalDatabaseApiCreateDatabaseRequest,
+  marshalDatabaseApiCreateDatabaseUserRequest,
+  marshalDatabaseApiUnassignDatabaseUserRequest,
+  marshalFtpAccountApiChangeFtpAccountPasswordRequest,
+  marshalFtpAccountApiCreateFtpAccountRequest,
+  marshalHostingApiCreateHostingRequest,
+  marshalHostingApiUpdateHostingRequest,
+  marshalMailAccountApiChangeMailAccountPasswordRequest,
+  marshalMailAccountApiCreateMailAccountRequest,
+  marshalMailAccountApiRemoveMailAccountRequest,
+  unmarshalDatabase,
+  unmarshalDatabaseUser,
+  unmarshalFtpAccount,
+  unmarshalHosting,
+  unmarshalListControlPanelsResponse,
+  unmarshalListDatabaseUsersResponse,
+  unmarshalListDatabasesResponse,
+  unmarshalListFtpAccountsResponse,
+  unmarshalListHostingsResponse,
+  unmarshalListMailAccountsResponse,
+  unmarshalListOffersResponse,
+  unmarshalListWebsitesResponse,
+  unmarshalMailAccount,
+  unmarshalResetHostingPasswordResponse,
+  unmarshalSession
+};

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

@@ -429,6 +429,11 @@ export type HostingApiCreateHostingRequest = {
      * domains managed by Scaleway Elements.
      */
     domainConfiguration?: CreateHostingRequestDomainConfiguration;
+    /**
+     * Indicates whether to skip a welcome email to the contact email containing
+     * hosting info.
+     */
+    skipWelcomeEmail?: boolean;
 };
 export type HostingApiCreateSessionRequest = {
     /**

package/dist/api/webhosting/v1/validation-rules.gen.cjs

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ControlPanelApiListControlPanelsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const DatabaseApiListDatabaseUsersRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const DatabaseApiListDatabasesRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const FtpAccountApiListFtpAccountsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const HostingApiListHostingsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const MailAccountApiListMailAccountsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const OfferApiListOffersRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const WebsiteApiListWebsitesRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+exports.ControlPanelApiListControlPanelsRequest = ControlPanelApiListControlPanelsRequest;
+exports.DatabaseApiListDatabaseUsersRequest = DatabaseApiListDatabaseUsersRequest;
+exports.DatabaseApiListDatabasesRequest = DatabaseApiListDatabasesRequest;
+exports.FtpAccountApiListFtpAccountsRequest = FtpAccountApiListFtpAccountsRequest;
+exports.HostingApiListHostingsRequest = HostingApiListHostingsRequest;
+exports.MailAccountApiListMailAccountsRequest = MailAccountApiListMailAccountsRequest;
+exports.OfferApiListOffersRequest = OfferApiListOffersRequest;
+exports.WebsiteApiListWebsitesRequest = WebsiteApiListWebsitesRequest;

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

@@ -0,0 +1,82 @@
+const ControlPanelApiListControlPanelsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const DatabaseApiListDatabaseUsersRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const DatabaseApiListDatabasesRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const FtpAccountApiListFtpAccountsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const HostingApiListHostingsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const MailAccountApiListMailAccountsRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const OfferApiListOffersRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+const WebsiteApiListWebsitesRequest = {
+  page: {
+    greaterThan: 0
+  },
+  pageSize: {
+    greaterThan: 0,
+    lessThanOrEqual: 100
+  }
+};
+export {
+  ControlPanelApiListControlPanelsRequest,
+  DatabaseApiListDatabaseUsersRequest,
+  DatabaseApiListDatabasesRequest,
+  FtpAccountApiListFtpAccountsRequest,
+  HostingApiListHostingsRequest,
+  MailAccountApiListMailAccountsRequest,
+  OfferApiListOffersRequest,
+  WebsiteApiListWebsitesRequest
+};