@scaleway/sdk 1.5.0 → 1.7.0

package/dist/api/applesilicon/v1alpha1/api.gen.js

@@ -154,7 +154,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Server
      */
-    this.waitForServer = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
+    this.waitForServer = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
     /**
      * Update a server. Update the parameters of an existing Apple silicon server,
      * specified by its server ID.
@@ -209,8 +209,8 @@ class API extends API$1 {
       path: `/apple-silicon/v1alpha1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/reinstall`
     }, unmarshalServer);
   }
+  /** Lists the available zones of the API. */
 }
-/** Lists the available zones of the API. */
 API.LOCALITIES = ['fr-par-3'];
 
 export { API };

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

@@ -61,7 +61,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Server
      */
-    this.waitForServer = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
+    this.waitForServer = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!SERVER_TRANSIENT_STATUSES.includes(res.status))), this.getServer, request, options);
     /**
      * Create an Elastic Metal server. Create a new Elastic Metal server. Once the
      * server is created, proceed with the [installation of an OS](#post-3e949e).
@@ -389,10 +389,10 @@ class API extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/os/${validatePathParam('osId', request.osId)}`
     }, unmarshalOS);
   }
+  /** Lists the available zones of the API. */
 }
 
 /** Elastic Metal Private Network API. */
-/** Lists the available zones of the API. */
 API.LOCALITIES = ['fr-par-1', 'fr-par-2', 'nl-ams-1'];
 class PrivateNetworkAPI extends API$1 {
   constructor() {
@@ -459,8 +459,8 @@ class PrivateNetworkAPI extends API$1 {
       path: `/baremetal/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers/${validatePathParam('serverId', request.serverId)}/private-networks/${validatePathParam('privateNetworkId', request.privateNetworkId)}`
     });
   }
+  /** Lists the available zones of the API. */
 }
-/** Lists the available zones of the API. */
 PrivateNetworkAPI.LOCALITIES = ['fr-par-2'];
 
 export { API, PrivateNetworkAPI };

package/dist/api/baremetal/v1/api.utils.js

@@ -23,7 +23,7 @@ class BaremetalV1UtilsAPI extends API {
         done: !SERVER_INSTALL_TRANSIENT_STATUSES.includes(value.status),
         value
       };
-    }, createExponentialBackoffStrategy((options == null ? void 0 : options.minDelay) ?? 1, (options == null ? void 0 : options.maxDelay) ?? 30), options == null ? void 0 : options.timeout);
+    }, createExponentialBackoffStrategy(options?.minDelay ?? 1, options?.maxDelay ?? 30), options?.timeout);
   }
 }
 

package/dist/api/cockpit/v1beta1/api.gen.js

@@ -3,7 +3,7 @@ import { API as API$1 } from '../../../scw/api.js';
 import { urlParams, validatePathParam } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 import { COCKPIT_TRANSIENT_STATUSES } from './content.gen.js';
-import { marshalActivateCockpitRequest, unmarshalCockpit, marshalDeactivateCockpitRequest, marshalResetCockpitGrafanaRequest, marshalCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, marshalCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalDeleteContactPointRequest, marshalEnableManagedAlertsRequest, marshalDisableManagedAlertsRequest, marshalTriggerTestAlertRequest, marshalCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalDeleteGrafanaUserRequest, marshalResetGrafanaUserPasswordRequest } from './marshalling.gen.js';
+import { marshalActivateCockpitRequest, unmarshalCockpit, unmarshalCockpitMetrics, marshalDeactivateCockpitRequest, marshalResetCockpitGrafanaRequest, marshalCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, marshalCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalDeleteContactPointRequest, marshalEnableManagedAlertsRequest, marshalDisableManagedAlertsRequest, marshalTriggerTestAlertRequest, marshalCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalDeleteGrafanaUserRequest, marshalResetGrafanaUserPasswordRequest, unmarshalListPlansResponse, marshalSelectPlanRequest, unmarshalSelectPlanResponse } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 const jsonContentHeaders = {
@@ -11,9 +11,12 @@ const jsonContentHeaders = {
 };
 
 /**
- * Cockpit API.
+ * Cockpit API documentation.
  *
- * This API allows to manage Cockpits. Cockpit API.
+ * Cockpit's API allows you to monitor your applications and their
+ * infrastructure. Cockpit's API allows you to activate your Cockpit on your
+ * Projects. Scaleway's Cockpit stores metrics and logs and provides a dedicated
+ * Grafana for dashboarding to visualize them.
  */
 class API extends API$1 {
   constructor() {
@@ -21,8 +24,7 @@ class API extends API$1 {
     super(...arguments);
     _this = this;
     /**
-     * Activate a cockpit. Activate a cockpit associated with the given project
-     * ID.
+     * Activate a Cockpit. Activate the Cockpit of the specified Project ID.
      *
      * @param request - The request {@link ActivateCockpitRequest}
      * @returns A Promise of Cockpit
@@ -39,7 +41,7 @@ class API extends API$1 {
       }, unmarshalCockpit);
     };
     /**
-     * Get cockpit. Get the cockpit associated with the given project ID.
+     * Get a Cockpit. Retrieve the Cockpit of the specified Project ID.
      *
      * @param request - The request {@link GetCockpitRequest}
      * @returns A Promise of Cockpit
@@ -65,11 +67,27 @@ class API extends API$1 {
       if (request === void 0) {
         request = {};
       }
-      return waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), _this.getCockpit, request, options);
+      return waitForResource(options?.stop ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), _this.getCockpit, request, options);
     };
     /**
-     * Deactivate a cockpit. Deactivate a cockpit associated with the given
-     * project ID.
+     * Get Cockpit metrics. Get metrics from your Cockpit with the specified
+     * Project ID.
+     *
+     * @param request - The request {@link GetCockpitMetricsRequest}
+     * @returns A Promise of CockpitMetrics
+     */
+    this.getCockpitMetrics = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/cockpit/v1beta1/cockpit/metrics`,
+        urlParams: urlParams(['end_date', request.endDate], ['metric_name', request.metricName], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['start_date', request.startDate])
+      }, unmarshalCockpitMetrics);
+    };
+    /**
+     * Deactivate a Cockpit. Deactivate the Cockpit of the specified Project ID.
      *
      * @param request - The request {@link DeactivateCockpitRequest}
      * @returns A Promise of Cockpit
@@ -86,8 +104,8 @@ class API extends API$1 {
       }, unmarshalCockpit);
     };
     /**
-     * Reset Grafana. Reset the Grafana of your cockpit associated with the given
-     * project ID.
+     * Reset a Grafana. Reset your Cockpit's Grafana associated with the specified
+     * Project ID.
      *
      * @param request - The request {@link ResetCockpitGrafanaRequest}
      * @returns A Promise of Cockpit
@@ -104,7 +122,7 @@ class API extends API$1 {
       }, unmarshalCockpit);
     };
     /**
-     * Create a token. Create a token associated with the given project ID.
+     * Create a token. Create a token associated with the specified Project ID.
      *
      * @param request - The request {@link CreateTokenRequest}
      * @returns A Promise of Token
@@ -131,7 +149,7 @@ class API extends API$1 {
       }, unmarshalListTokensResponse);
     };
     /**
-     * List tokens. List tokens associated with the given project ID.
+     * List tokens. Get a list of tokens associated with the specified Project ID.
      *
      * @param request - The request {@link ListTokensRequest}
      * @returns A Promise of ListTokensResponse
@@ -143,7 +161,7 @@ class API extends API$1 {
       return enrichForPagination('tokens', _this.pageOfListTokens, request);
     };
     /**
-     * Get token. Get the token associated with the given ID.
+     * Get a token. Retrieve the token associated with the specified token ID.
      *
      * @param request - The request {@link GetTokenRequest}
      * @returns A Promise of Token
@@ -153,7 +171,7 @@ class API extends API$1 {
       path: `/cockpit/v1beta1/tokens/${validatePathParam('tokenId', request.tokenId)}`
     }, unmarshalToken);
     /**
-     * Delete token. Delete the token associated with the given ID.
+     * Delete a token. Delete the token associated with the specified token ID.
      *
      * @param request - The request {@link DeleteTokenRequest}
      */
@@ -162,7 +180,7 @@ class API extends API$1 {
       path: `/cockpit/v1beta1/tokens/${validatePathParam('tokenId', request.tokenId)}`
     });
     /**
-     * Create an alert contact point. Create an alert contact point for the
+     * Create a contact point. Create a contact point to receive alerts for the
      * default receiver.
      *
      * @param request - The request {@link CreateContactPointRequest}
@@ -190,8 +208,8 @@ class API extends API$1 {
       }, unmarshalListContactPointsResponse);
     };
     /**
-     * List alert contact points. List alert contact points associated with the
-     * given cockpit ID.
+     * List contact points. Get a list of contact points for the Cockpit
+     * associated with the specified Project ID.
      *
      * @param request - The request {@link ListContactPointsRequest}
      * @returns A Promise of ListContactPointsResponse
@@ -203,8 +221,8 @@ class API extends API$1 {
       return enrichForPagination('contactPoints', _this.pageOfListContactPoints, request);
     };
     /**
-     * Delete an alert contact point. Delete an alert contact point for the
-     * default receiver.
+     * Delete an alert contact point. Delete a contact point for the default
+     * receiver.
      *
      * @param request - The request {@link DeleteContactPointRequest}
      */
@@ -220,7 +238,8 @@ class API extends API$1 {
       });
     };
     /**
-     * Enable managed alerts.
+     * Enable managed alerts. Enable the sending of managed alerts for the
+     * specified Project's Cockpit.
      *
      * @param request - The request {@link EnableManagedAlertsRequest}
      */
@@ -236,7 +255,8 @@ class API extends API$1 {
       });
     };
     /**
-     * Disable managed alerts.
+     * Disable managed alerts. Disable the sending of managed alerts for the
+     * specified Project's Cockpit.
      *
      * @param request - The request {@link DisableManagedAlertsRequest}
      */
@@ -252,7 +272,8 @@ class API extends API$1 {
       });
     };
     /**
-     * Trigger a test alert. Trigger a test alert to all receivers.
+     * Trigger a test alert. Trigger a test alert to all of the Cockpit's
+     * receivers.
      *
      * @param request - The request {@link TriggerTestAlertRequest}
      */
@@ -268,7 +289,9 @@ class API extends API$1 {
       });
     };
     /**
-     * Create a grafana user. Create a grafana user for your grafana instance.
+     * Create a Grafana user. Create a Grafana user for your Cockpit's Grafana
+     * instance. Make sure you save the automatically-generated password and the
+     * Grafana user ID.
      *
      * @param request - The request {@link CreateGrafanaUserRequest}
      * @returns A Promise of GrafanaUser
@@ -290,8 +313,8 @@ class API extends API$1 {
       }, unmarshalListGrafanaUsersResponse);
     };
     /**
-     * List grafana users. List grafana users who are able to connect to your
-     * grafana instance.
+     * List Grafana users. Get a list of Grafana users who are able to connect to
+     * the Cockpit's Grafana instance.
      *
      * @param request - The request {@link ListGrafanaUsersRequest}
      * @returns A Promise of ListGrafanaUsersResponse
@@ -303,7 +326,8 @@ class API extends API$1 {
       return enrichForPagination('grafanaUsers', _this.pageOfListGrafanaUsers, request);
     };
     /**
-     * Delete a grafana user. Delete a grafana user from your grafana instance.
+     * Delete a Grafana user. Delete a Grafana user from a Grafana instance,
+     * specified by the Cockpit's Project ID and the Grafana user ID.
      *
      * @param request - The request {@link DeleteGrafanaUserRequest}
      */
@@ -314,8 +338,8 @@ class API extends API$1 {
       path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/delete`
     });
     /**
-     * Reset Grafana user password. Reset the Grafana user password from your
-     * grafana instance.
+     * Reset a Grafana user's password. Reset a Grafana user's password specified
+     * by the Cockpit's Project ID and the Grafana user ID.
      *
      * @param request - The request {@link ResetGrafanaUserPasswordRequest}
      * @returns A Promise of GrafanaUser
@@ -326,6 +350,42 @@ class API extends API$1 {
       method: 'POST',
       path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/reset-password`
     }, unmarshalGrafanaUser);
+    this.pageOfListPlans = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/cockpit/v1beta1/plans`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize])
+      }, unmarshalListPlansResponse);
+    };
+    /**
+     * List pricing plans. Get a list of all pricing plans available.
+     *
+     * @param request - The request {@link ListPlansRequest}
+     * @returns A Promise of ListPlansResponse
+     */
+    this.listPlans = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('plans', _this.pageOfListPlans, request);
+    };
+    /**
+     * Select pricing plan. Select your chosen pricing plan for your Cockpit,
+     * specifying the Cockpit's Project ID and the pricing plan's ID in the
+     * request.
+     *
+     * @param request - The request {@link SelectPlanRequest}
+     * @returns A Promise of SelectPlanResponse
+     */
+    this.selectPlan = request => this.client.fetch({
+      body: JSON.stringify(marshalSelectPlanRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/cockpit/v1beta1/select-plan`
+    }, unmarshalSelectPlanResponse);
   }
 }
 

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

@@ -1,5 +1,6 @@
 import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.1/node_modules/@scaleway/random-name/dist/index.js';
 import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalTimeSeries } from '../../../scw/custom-marshalling.js';
 import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../helpers/marshalling.js';
 
 // This file was automatically generated. DO NOT EDIT.
@@ -55,6 +56,20 @@ const unmarshalGrafanaUser = data => {
     role: data.role
   };
 };
+const unmarshalPlan = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Plan' failed as data isn't a dictionary.`);
+  }
+  return {
+    id: data.id,
+    logsIngestionPrice: data.logs_ingestion_price,
+    name: data.name,
+    retentionLogsInterval: data.retention_logs_interval,
+    retentionMetricsInterval: data.retention_metrics_interval,
+    retentionPrice: data.retention_price,
+    sampleIngestionPrice: data.sample_ingestion_price
+  };
+};
 const unmarshalToken = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Token' failed as data isn't a dictionary.`);
@@ -77,11 +92,20 @@ const unmarshalCockpit = data => {
     createdAt: unmarshalDate(data.created_at),
     endpoints: data.endpoints ? unmarshalCockpitEndpoints(data.endpoints) : undefined,
     managedAlertsEnabled: data.managed_alerts_enabled,
+    plan: data.plan ? unmarshalPlan(data.plan) : undefined,
     projectId: data.project_id,
     status: data.status,
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
+const unmarshalCockpitMetrics = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'CockpitMetrics' failed as data isn't a dictionary.`);
+  }
+  return {
+    timeseries: unmarshalArrayOfObject(data.timeseries, unmarshalTimeSeries)
+  };
+};
 const unmarshalListContactPointsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListContactPointsResponse' failed as data isn't a dictionary.`);
@@ -102,6 +126,15 @@ const unmarshalListGrafanaUsersResponse = data => {
     totalCount: data.total_count
   };
 };
+const unmarshalListPlansResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListPlansResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    plans: unmarshalArrayOfObject(data.plans, unmarshalPlan),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListTokensResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListTokensResponse' failed as data isn't a dictionary.`);
@@ -111,6 +144,12 @@ const unmarshalListTokensResponse = data => {
     totalCount: data.total_count
   };
 };
+const unmarshalSelectPlanResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'SelectPlanResponse' failed as data isn't a dictionary.`);
+  }
+  return {};
+};
 const marshalContactPointEmail = (request, defaults) => ({
   to: request.to
 });
@@ -168,8 +207,12 @@ const marshalResetCockpitGrafanaRequest = (request, defaults) => ({
 const marshalResetGrafanaUserPasswordRequest = (request, defaults) => ({
   project_id: request.projectId ?? defaults.defaultProjectId
 });
+const marshalSelectPlanRequest = (request, defaults) => ({
+  plan_id: request.planId,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
 const marshalTriggerTestAlertRequest = (request, defaults) => ({
   project_id: request.projectId ?? defaults.defaultProjectId
 });
 
-export { marshalActivateCockpitRequest, marshalCreateContactPointRequest, marshalCreateGrafanaUserRequest, marshalCreateTokenRequest, marshalDeactivateCockpitRequest, marshalDeleteContactPointRequest, marshalDeleteGrafanaUserRequest, marshalDisableManagedAlertsRequest, marshalEnableManagedAlertsRequest, marshalResetCockpitGrafanaRequest, marshalResetGrafanaUserPasswordRequest, marshalTriggerTestAlertRequest, unmarshalCockpit, unmarshalContactPoint, unmarshalGrafanaUser, unmarshalListContactPointsResponse, unmarshalListGrafanaUsersResponse, unmarshalListTokensResponse, unmarshalToken };
+export { marshalActivateCockpitRequest, marshalCreateContactPointRequest, marshalCreateGrafanaUserRequest, marshalCreateTokenRequest, marshalDeactivateCockpitRequest, marshalDeleteContactPointRequest, marshalDeleteGrafanaUserRequest, marshalDisableManagedAlertsRequest, marshalEnableManagedAlertsRequest, marshalResetCockpitGrafanaRequest, marshalResetGrafanaUserPasswordRequest, marshalSelectPlanRequest, marshalTriggerTestAlertRequest, unmarshalCockpit, unmarshalCockpitMetrics, unmarshalContactPoint, unmarshalGrafanaUser, unmarshalListContactPointsResponse, unmarshalListGrafanaUsersResponse, unmarshalListPlansResponse, unmarshalListTokensResponse, unmarshalSelectPlanResponse, unmarshalToken };

package/dist/api/container/v1beta1/api.gen.js

@@ -31,7 +31,7 @@ class API extends API$1 {
       }, unmarshalListNamespacesResponse);
     };
     /**
-     * List all your namespaces.
+     * List all your namespaces. List all namespaces in a specified region.
      *
      * @param request - The request {@link ListNamespacesRequest}
      * @returns A Promise of ListNamespacesResponse
@@ -43,7 +43,7 @@ class API extends API$1 {
       return enrichForPagination('namespaces', _this.pageOfListNamespaces, request);
     };
     /**
-     * Get a namespace. Get the namespace associated with the given id.
+     * Get a namespace. Get the namespace associated with the specified ID.
      *
      * @param request - The request {@link GetNamespaceRequest}
      * @returns A Promise of Namespace
@@ -59,9 +59,9 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Namespace
      */
-    this.waitForNamespace = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
+    this.waitForNamespace = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAMESPACE_TRANSIENT_STATUSES.includes(res.status))), this.getNamespace, request, options);
     /**
-     * Create a new namespace.
+     * Create a new namespace. Create a new namespace in a specified region.
      *
      * @param request - The request {@link CreateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -78,8 +78,8 @@ class API extends API$1 {
       }, unmarshalNamespace);
     };
     /**
-     * Update an existing namespace. Update the space associated with the given
-     * id.
+     * Update an existing namespace. Update the space associated with the
+     * specified ID.
      *
      * @param request - The request {@link UpdateNamespaceRequest}
      * @returns A Promise of Namespace
@@ -92,7 +92,7 @@ class API extends API$1 {
     }, unmarshalNamespace);
     /**
      * Delete an existing namespace. Delete the namespace associated with the
-     * given id.
+     * specified ID.
      *
      * @param request - The request {@link DeleteNamespaceRequest}
      * @returns A Promise of Namespace
@@ -107,14 +107,14 @@ class API extends API$1 {
       urlParams: urlParams(['name', request.name], ['namespace_id', request.namespaceId], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
     }, unmarshalListContainersResponse);
     /**
-     * List all your containers.
+     * List all your containers. List all containers for a specified region.
      *
      * @param request - The request {@link ListContainersRequest}
      * @returns A Promise of ListContainersResponse
      */
     this.listContainers = request => enrichForPagination('containers', this.pageOfListContainers, request);
     /**
-     * Get a container. Get the container associated with the given id.
+     * Get a container. Get the container associated with the specified ID.
      *
      * @param request - The request {@link GetContainerRequest}
      * @returns A Promise of Container
@@ -130,9 +130,9 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Container
      */
-    this.waitForContainer = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))), this.getContainer, request, options);
+    this.waitForContainer = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CONTAINER_TRANSIENT_STATUSES.includes(res.status))), this.getContainer, request, options);
     /**
-     * Create a new container.
+     * Create a new container. Create a new container in the specified region.
      *
      * @param request - The request {@link CreateContainerRequest}
      * @returns A Promise of Container
@@ -145,7 +145,7 @@ class API extends API$1 {
     }, unmarshalContainer);
     /**
      * Update an existing container. Update the container associated with the
-     * given id.
+     * specified ID.
      *
      * @param request - The request {@link UpdateContainerRequest}
      * @returns A Promise of Container
@@ -157,7 +157,7 @@ class API extends API$1 {
       path: `/containers/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/containers/${validatePathParam('containerId', request.containerId)}`
     }, unmarshalContainer);
     /**
-     * Delete a container. Delete the container associated with the given id.
+     * Delete a container. Delete the container associated with the specified ID.
      *
      * @param request - The request {@link DeleteContainerRequest}
      * @returns A Promise of Container
@@ -167,7 +167,7 @@ class API extends API$1 {
       path: `/containers/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/containers/${validatePathParam('containerId', request.containerId)}`
     }, unmarshalContainer);
     /**
-     * Deploy a container. Deploy a container associated with the given id.
+     * Deploy a container. Deploy a container associated with the specified ID.
      *
      * @param request - The request {@link DeployContainerRequest}
      * @returns A Promise of Container
@@ -191,7 +191,7 @@ class API extends API$1 {
      */
     this.listCrons = request => enrichForPagination('crons', this.pageOfListCrons, request);
     /**
-     * Get a cron. Get the cron associated with the given id.
+     * Get a cron. Get the cron associated with the specified ID.
      *
      * @param request - The request {@link GetCronRequest}
      * @returns A Promise of Cron
@@ -207,7 +207,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Cron
      */
-    this.waitForCron = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))), this.getCron, request, options);
+    this.waitForCron = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!CRON_TRANSIENT_STATUSES.includes(res.status))), this.getCron, request, options);
     /**
      * Create a new cron.
      *
@@ -221,7 +221,7 @@ class API extends API$1 {
       path: `/containers/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/crons`
     }, unmarshalCron);
     /**
-     * Update an existing cron. Update the cron associated with the given id.
+     * Update an existing cron. Update the cron associated with the specified ID.
      *
      * @param request - The request {@link UpdateCronRequest}
      * @returns A Promise of Cron
@@ -233,7 +233,7 @@ class API extends API$1 {
       path: `/containers/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/crons/${validatePathParam('cronId', request.cronId)}`
     }, unmarshalCron);
     /**
-     * Delete an existing cron. Delete the cron associated with the given id.
+     * Delete an existing cron. Delete the cron associated with the specified ID.
      *
      * @param request - The request {@link DeleteCronRequest}
      * @returns A Promise of Cron
@@ -248,7 +248,8 @@ class API extends API$1 {
       urlParams: urlParams(['order_by', request.orderBy ?? 'timestamp_desc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListLogsResponse);
     /**
-     * List your container logs.
+     * List your container logs. List the logs of the container with the specified
+     * ID.
      *
      * @param request - The request {@link ListLogsRequest}
      * @returns A Promise of ListLogsResponse
@@ -260,14 +261,16 @@ class API extends API$1 {
       urlParams: urlParams(['container_id', request.containerId], ['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDomainsResponse);
     /**
-     * List all domain name bindings.
+     * List all domain name bindings. List all domain name bindings in a specified
+     * region.
      *
      * @param request - The request {@link ListDomainsRequest}
      * @returns A Promise of ListDomainsResponse
      */
     this.listDomains = request => enrichForPagination('domains', this.pageOfListDomains, request);
     /**
-     * Get a domain name binding.
+     * Get a domain name binding. Get a domain name binding for the container with
+     * the specified ID.
      *
      * @param request - The request {@link GetDomainRequest}
      * @returns A Promise of Domain
@@ -283,9 +286,10 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Domain
      */
-    this.waitForDomain = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
+    this.waitForDomain = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!DOMAIN_TRANSIENT_STATUSES.includes(res.status))), this.getDomain, request, options);
     /**
-     * Create a domain name binding.
+     * Create a domain name binding. Create a domain name binding for the
+     * container with the specified ID.
      *
      * @param request - The request {@link CreateDomainRequest}
      * @returns A Promise of Domain
@@ -297,7 +301,8 @@ class API extends API$1 {
       path: `/containers/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains`
     }, unmarshalDomain);
     /**
-     * Delete a domain name binding.
+     * Delete a domain name binding. Delete the domain name binding with the
+     * specific ID.
      *
      * @param request - The request {@link DeleteDomainRequest}
      * @returns A Promise of Domain
@@ -345,7 +350,7 @@ class API extends API$1 {
       }, unmarshalToken);
     };
     /**
-     * Get a token.
+     * Get a token. Get a token with a specified ID.
      *
      * @param request - The request {@link GetTokenRequest}
      * @returns A Promise of Token
@@ -361,7 +366,7 @@ class API extends API$1 {
      * @param options - The waiting options
      * @returns A Promise of Token
      */
-    this.waitForToken = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!TOKEN_TRANSIENT_STATUSES.includes(res.status))), this.getToken, request, options);
+    this.waitForToken = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!TOKEN_TRANSIENT_STATUSES.includes(res.status))), this.getToken, request, options);
     this.pageOfListTokens = function (request) {
       if (request === void 0) {
         request = {};
@@ -373,7 +378,8 @@ class API extends API$1 {
       }, unmarshalListTokensResponse);
     };
     /**
-     * List all tokens.
+     * List all tokens. List all tokens belonging to a specified Organization or
+     * Project.
      *
      * @param request - The request {@link ListTokensRequest}
      * @returns A Promise of ListTokensResponse
@@ -385,7 +391,7 @@ class API extends API$1 {
       return enrichForPagination('tokens', _this.pageOfListTokens, request);
     };
     /**
-     * Delete a token.
+     * Delete a token. Delete a token with a specified ID.
      *
      * @param request - The request {@link DeleteTokenRequest}
      * @returns A Promise of Token
@@ -395,8 +401,8 @@ class API extends API$1 {
       path: `/containers/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/tokens/${validatePathParam('tokenId', request.tokenId)}`
     }, unmarshalToken);
   }
+  /** Lists the available regions of the API. */
 }
-/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
 
 export { API };

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

@@ -179,7 +179,7 @@ const marshalCreateContainerRequest = (request, defaults) => ({
   max_scale: request.maxScale,
   memory_limit: request.memoryLimit,
   min_scale: request.minScale,
-  name: request.name || randomName('ctnr'),
+  name: request.name,
   namespace_id: request.namespaceId,
   port: request.port,
   privacy: request.privacy ?? 'unknown_privacy',