@scaleway/sdk 1.31.0 → 1.32.0

package/dist/index.cjs

@@ -497,10 +497,12 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v1.30.0';
+const version = 'v1.31.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
-const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
+const isBrowser = () =>
+// eslint-disable-next-line @typescript-eslint/prefer-optional-chain
+typeof window !== 'undefined' && typeof window.document !== 'undefined';
 
 /**
  * Composes request interceptors.
@@ -3834,6 +3836,18 @@ const unmarshalCockpitMetrics = data => {
     timeseries: unmarshalArrayOfObject(data.timeseries, unmarshalTimeSeries)
   };
 };
+const unmarshalDatasource = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Datasource' failed as data isn't a dictionary.`);
+  }
+  return {
+    id: data.id,
+    name: data.name,
+    projectId: data.project_id,
+    type: data.type,
+    url: data.url
+  };
+};
 const unmarshalListContactPointsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListContactPointsResponse' failed as data isn't a dictionary.`);
@@ -3905,6 +3919,11 @@ const marshalCreateContactPointRequest = (request, defaults) => ({
   contact_point: request.contactPoint ? marshalContactPoint(request.contactPoint) : undefined,
   project_id: request.projectId ?? defaults.defaultProjectId
 });
+const marshalCreateDatasourceRequest = (request, defaults) => ({
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  type: request.type ?? 'unknown_datasource_type'
+});
 const marshalCreateGrafanaUserRequest = (request, defaults) => ({
   login: request.login,
   project_id: request.projectId ?? defaults.defaultProjectId,
@@ -3954,13 +3973,13 @@ const jsonContentHeaders$l = {
 /**
  * Cockpit API.
  *
- * Cockpit API. 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.
+ * 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. Cockpit API.
  */
 let API$n = class API extends API$s {
   /**
-   * Activate a Cockpit. Activate the Cockpit of the specified Project ID.
+   * Activate the Cockpit of the specified Project ID.
    *
    * @param request - The request {@link ActivateCockpitRequest}
    * @returns A Promise of Cockpit
@@ -3973,7 +3992,7 @@ let API$n = class API extends API$s {
   }, unmarshalCockpit);
 
   /**
-   * Get a Cockpit. Retrieve the Cockpit of the specified Project ID.
+   * Retrieve the Cockpit of the specified Project ID.
    *
    * @param request - The request {@link GetCockpitRequest}
    * @returns A Promise of Cockpit
@@ -3994,8 +4013,7 @@ let API$n = class API extends API$s {
   waitForCockpit = (request = {}, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), this.getCockpit, request, options);
 
   /**
-   * Get Cockpit metrics. Get metrics from your Cockpit with the specified
-   * Project ID.
+   * Get metrics from your Cockpit with the specified Project ID.
    *
    * @param request - The request {@link GetCockpitMetricsRequest}
    * @returns A Promise of CockpitMetrics
@@ -4007,7 +4025,7 @@ let API$n = class API extends API$s {
   }, unmarshalCockpitMetrics);
 
   /**
-   * Deactivate a Cockpit. Deactivate the Cockpit of the specified Project ID.
+   * Deactivate the Cockpit of the specified Project ID.
    *
    * @param request - The request {@link DeactivateCockpitRequest}
    * @returns A Promise of Cockpit
@@ -4020,8 +4038,7 @@ let API$n = class API extends API$s {
   }, unmarshalCockpit);
 
   /**
-   * Reset a Grafana. Reset your Cockpit's Grafana associated with the specified
-   * Project ID.
+   * Reset your Cockpit's Grafana associated with the specified Project ID.
    *
    * @param request - The request {@link ResetCockpitGrafanaRequest}
    * @returns A Promise of Cockpit
@@ -4034,7 +4051,20 @@ let API$n = class API extends API$s {
   }, unmarshalCockpit);
 
   /**
-   * Create a token. Create a token associated with the specified Project ID.
+   * Create a datasource for the specified Project ID and the given type.
+   *
+   * @param request - The request {@link CreateDatasourceRequest}
+   * @returns A Promise of Datasource
+   */
+  createDatasource = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateDatasourceRequest(request, this.client.settings)),
+    headers: jsonContentHeaders$l,
+    method: 'POST',
+    path: `/cockpit/v1beta1/datasources`
+  }, unmarshalDatasource);
+
+  /**
+   * Create a token associated with the specified Project ID.
    *
    * @param request - The request {@link CreateTokenRequest}
    * @returns A Promise of Token
@@ -4052,7 +4082,7 @@ let API$n = class API extends API$s {
   }, unmarshalListTokensResponse$2);
 
   /**
-   * List tokens. Get a list of tokens associated with the specified Project ID.
+   * Get a list of tokens associated with the specified Project ID.
    *
    * @param request - The request {@link ListTokensRequest}
    * @returns A Promise of ListTokensResponse
@@ -4060,7 +4090,7 @@ let API$n = class API extends API$s {
   listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
 
   /**
-   * Get a token. Retrieve the token associated with the specified token ID.
+   * Retrieve the token associated with the specified token ID.
    *
    * @param request - The request {@link GetTokenRequest}
    * @returns A Promise of Token
@@ -4071,7 +4101,7 @@ let API$n = class API extends API$s {
   }, unmarshalToken$2);
 
   /**
-   * Delete a token. Delete the token associated with the specified token ID.
+   * Delete the token associated with the specified token ID.
    *
    * @param request - The request {@link DeleteTokenRequest}
    */
@@ -4081,8 +4111,7 @@ let API$n = class API extends API$s {
   });
 
   /**
-   * Create a contact point. Create a contact point to receive alerts for the
-   * default receiver.
+   * Create a contact point to receive alerts for the default receiver.
    *
    * @param request - The request {@link CreateContactPointRequest}
    * @returns A Promise of ContactPoint
@@ -4100,8 +4129,8 @@ let API$n = class API extends API$s {
   }, unmarshalListContactPointsResponse);
 
   /**
-   * List contact points. Get a list of contact points for the Cockpit
-   * associated with the specified Project ID.
+   * 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
@@ -4109,8 +4138,7 @@ let API$n = class API extends API$s {
   listContactPoints = (request = {}) => enrichForPagination('contactPoints', this.pageOfListContactPoints, request);
 
   /**
-   * Delete an alert contact point. Delete a contact point for the default
-   * receiver.
+   * Delete a contact point for the default receiver.
    *
    * @param request - The request {@link DeleteContactPointRequest}
    */
@@ -4122,8 +4150,7 @@ let API$n = class API extends API$s {
   });
 
   /**
-   * Enable managed alerts. Enable the sending of managed alerts for the
-   * specified Project's Cockpit.
+   * Enable the sending of managed alerts for the specified Project's Cockpit.
    *
    * @param request - The request {@link EnableManagedAlertsRequest}
    */
@@ -4135,8 +4162,7 @@ let API$n = class API extends API$s {
   });
 
   /**
-   * Disable managed alerts. Disable the sending of managed alerts for the
-   * specified Project's Cockpit.
+   * Disable the sending of managed alerts for the specified Project's Cockpit.
    *
    * @param request - The request {@link DisableManagedAlertsRequest}
    */
@@ -4148,8 +4174,7 @@ let API$n = class API extends API$s {
   });
 
   /**
-   * Trigger a test alert. Trigger a test alert to all of the Cockpit's
-   * receivers.
+   * Trigger a test alert to all of the Cockpit's receivers.
    *
    * @param request - The request {@link TriggerTestAlertRequest}
    */
@@ -4161,9 +4186,8 @@ let API$n = class API extends API$s {
   });
 
   /**
-   * 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.
+   * 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
@@ -4181,8 +4205,8 @@ let API$n = class API extends API$s {
   }, unmarshalListGrafanaUsersResponse);
 
   /**
-   * List Grafana users. Get a list of Grafana users who are able to connect to
-   * the Cockpit's Grafana instance.
+   * 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
@@ -4190,8 +4214,8 @@ let API$n = class API extends API$s {
   listGrafanaUsers = (request = {}) => enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request);
 
   /**
-   * Delete a Grafana user. Delete a Grafana user from a Grafana instance,
-   * specified by the Cockpit's Project ID and the Grafana user ID.
+   * 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}
    */
@@ -4203,8 +4227,8 @@ let API$n = class API extends API$s {
   });
 
   /**
-   * Reset a Grafana user's password. Reset a Grafana user's password specified
-   * by the Cockpit's Project ID and the Grafana user ID.
+   * 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
@@ -4222,7 +4246,7 @@ let API$n = class API extends API$s {
   }, unmarshalListPlansResponse);
 
   /**
-   * List pricing plans. Get a list of all pricing plans available.
+   * Get a list of all pricing plans available.
    *
    * @param request - The request {@link ListPlansRequest}
    * @returns A Promise of ListPlansResponse
@@ -4230,9 +4254,8 @@ let API$n = class API extends API$s {
   listPlans = (request = {}) => 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.
+   * 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
@@ -11149,7 +11172,7 @@ let API$h = class API extends API$s {
   pageOfListSnapshots = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/snapshots`,
-    urlParams: urlParams(['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['project', request.project], ['tags', request.tags])
+    urlParams: urlParams(['base_volume_id', request.baseVolumeId], ['name', request.name], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['project', request.project], ['tags', request.tags])
   }, unmarshalListSnapshotsResponse$1);
 
   /**
@@ -13148,9 +13171,6 @@ var index$g = /*#__PURE__*/Object.freeze({
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
 
-/** Lists transient statutes of the enum {@link NameStatus}. */
-const NAME_TRANSIENT_STATUSES = ['queued', 'publishing'];
-
 /** Lists transient statutes of the enum {@link PinStatus}. */
 const PIN_TRANSIENT_STATUSES = ['queued', 'pinning'];
 
@@ -13187,22 +13207,6 @@ const unmarshalPinInfo = data => {
     url: data.url
   };
 };
-const unmarshalName = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Name' failed as data isn't a dictionary.`);
-  }
-  return {
-    createdAt: unmarshalDate(data.created_at),
-    key: data.key,
-    name: data.name,
-    nameId: data.name_id,
-    projectId: data.project_id,
-    status: data.status,
-    tags: data.tags,
-    updatedAt: unmarshalDate(data.updated_at),
-    value: data.value
-  };
-};
 const unmarshalPin = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Pin' failed as data isn't a dictionary.`);
@@ -13232,28 +13236,6 @@ const unmarshalVolume$1 = data => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
-const unmarshalExportKeyNameResponse = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ExportKeyNameResponse' failed as data isn't a dictionary.`);
-  }
-  return {
-    createdAt: unmarshalDate(data.created_at),
-    nameId: data.name_id,
-    privateKey: data.private_key,
-    projectId: data.project_id,
-    publicKey: data.public_key,
-    updatedAt: unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalListNamesResponse = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ListNamesResponse' failed as data isn't a dictionary.`);
-  }
-  return {
-    names: unmarshalArrayOfObject(data.names, unmarshalName),
-    totalCount: data.total_count
-  };
-};
 const unmarshalListPinsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListPinsResponse' failed as data isn't a dictionary.`);
@@ -13284,11 +13266,6 @@ const marshalPinOptions = (request, defaults) => ({
   replication_count: request.replicationCount,
   required_zones: request.requiredZones
 });
-const marshalCreateNameRequest = (request, defaults) => ({
-  name: request.name,
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  value: request.value
-});
 const marshalCreatePinByCIDRequest = (request, defaults) => ({
   cid: request.cid,
   name: request.name,
@@ -13306,12 +13283,6 @@ const marshalCreateVolumeRequest = (request, defaults) => ({
   name: request.name,
   project_id: request.projectId ?? defaults.defaultProjectId
 });
-const marshalImportKeyNameRequest = (request, defaults) => ({
-  name: request.name,
-  private_key: request.privateKey,
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  value: request.value
-});
 const marshalReplacePinRequest = (request, defaults) => ({
   cid: request.cid,
   name: request.name,
@@ -13319,11 +13290,6 @@ const marshalReplacePinRequest = (request, defaults) => ({
   pin_options: request.pinOptions ? marshalPinOptions(request.pinOptions) : undefined,
   volume_id: request.volumeId
 });
-const marshalUpdateNameRequest = (request, defaults) => ({
-  name: request.name,
-  tags: request.tags,
-  value: request.value
-});
 const marshalUpdateVolumeRequest = (request, defaults) => ({
   name: request.name,
   tags: request.tags
@@ -13500,101 +13466,6 @@ let API$f = class API extends API$s {
     path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/pins/${validatePathParam('pinId', request.pinId)}`,
     urlParams: urlParams(['volume_id', request.volumeId])
   });
-
-  /**
-   * Create a new name. You can use the `ipfs key` command to list and generate
-   * more names and their respective keys.
-   *
-   * @param request - The request {@link CreateNameRequest}
-   * @returns A Promise of Name
-   */
-  createName = request => this.client.fetch({
-    body: JSON.stringify(marshalCreateNameRequest(request, this.client.settings)),
-    headers: jsonContentHeaders$d,
-    method: 'POST',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names`
-  }, unmarshalName);
-
-  /**
-   * Get information about a name. Retrieve information about a specific name.
-   *
-   * @param request - The request {@link GetNameRequest}
-   * @returns A Promise of Name
-   */
-  getName = request => this.client.fetch({
-    method: 'GET',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names/${validatePathParam('nameId', request.nameId)}`
-  }, unmarshalName);
-
-  /**
-   * Waits for {@link Name} to be in a final state.
-   *
-   * @param request - The request {@link GetNameRequest}
-   * @param options - The waiting options
-   * @returns A Promise of Name
-   */
-  waitForName = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!NAME_TRANSIENT_STATUSES.includes(res.status))), this.getName, request, options);
-
-  /**
-   * Delete an existing name. Delete a name by its ID.
-   *
-   * @param request - The request {@link DeleteNameRequest}
-   */
-  deleteName = request => this.client.fetch({
-    method: 'DELETE',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names/${validatePathParam('nameId', request.nameId)}`
-  });
-  pageOfListNames = (request = {}) => this.client.fetch({
-    method: 'GET',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names`,
-    urlParams: urlParams(['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])
-  }, unmarshalListNamesResponse);
-
-  /**
-   * List all names by a Project ID. Retrieve information about all names from a
-   * Project ID.
-   *
-   * @param request - The request {@link ListNamesRequest}
-   * @returns A Promise of ListNamesResponse
-   */
-  listNames = (request = {}) => enrichForPagination('names', this.pageOfListNames, request);
-
-  /**
-   * Update name information. Update name information (CID, tag, name...).
-   *
-   * @param request - The request {@link UpdateNameRequest}
-   * @returns A Promise of Name
-   */
-  updateName = request => this.client.fetch({
-    body: JSON.stringify(marshalUpdateNameRequest(request, this.client.settings)),
-    headers: jsonContentHeaders$d,
-    method: 'PATCH',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names/${validatePathParam('nameId', request.nameId)}`
-  }, unmarshalName);
-
-  /**
-   * Export your private key. Export a private key by its ID.
-   *
-   * @param request - The request {@link ExportKeyNameRequest}
-   * @returns A Promise of ExportKeyNameResponse
-   */
-  exportKeyName = request => this.client.fetch({
-    method: 'GET',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names/export-key/${validatePathParam('nameId', request.nameId)}`
-  }, unmarshalExportKeyNameResponse);
-
-  /**
-   * Import your private key. Import a private key.
-   *
-   * @param request - The request {@link ImportKeyNameRequest}
-   * @returns A Promise of Name
-   */
-  importKeyName = request => this.client.fetch({
-    body: JSON.stringify(marshalImportKeyNameRequest(request, this.client.settings)),
-    headers: jsonContentHeaders$d,
-    method: 'POST',
-    path: `/ipfs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/names/import-key`
-  }, unmarshalName);
 };
 
 // This file was automatically generated. DO NOT EDIT.
@@ -13603,7 +13474,6 @@ let API$f = class API extends API$s {
 var index_gen$d = /*#__PURE__*/Object.freeze({
   __proto__: null,
   API: API$f,
-  NAME_TRANSIENT_STATUSES: NAME_TRANSIENT_STATUSES,
   PIN_TRANSIENT_STATUSES: PIN_TRANSIENT_STATUSES
 });
 
@@ -14050,7 +13920,7 @@ let API$e = class API extends API$s {
   pageOfListClusters = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters`,
-    urlParams: urlParams(['name', request.name], ['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], ['status', request.status ?? 'unknown'], ['type', request.type])
+    urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['private_network_id', request.privateNetworkId], ['project_id', request.projectId], ['status', request.status ?? 'unknown'], ['type', request.type])
   }, unmarshalListClustersResponse$1);
 
   /**
@@ -14941,6 +14811,7 @@ const unmarshalPrivateNetwork$3 = data => {
     createdAt: unmarshalDate(data.created_at),
     dhcpConfig: data.dhcp_config ? unmarshalPrivateNetworkDHCPConfig(data.dhcp_config) : undefined,
     ipamConfig: data.ipam_config ? unmarshalPrivateNetworkIpamConfig(data.ipam_config) : undefined,
+    ipamIds: data.ipam_ids,
     lb: data.lb ? unmarshalLb(data.lb) : undefined,
     privateNetworkId: data.private_network_id,
     staticConfig: data.static_config ? unmarshalPrivateNetworkStaticConfig(data.static_config) : undefined,
@@ -20764,11 +20635,11 @@ let API$6 = class API extends API$s {
   pageOfListFolders = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/folders`,
-    urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['path', request.path], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
+    urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['path', request.path], ['project_id', request.projectId])
   }, unmarshalListFoldersResponse);
 
   /**
-   * List secrets. Retrieve the list of folders created within a Project.
+   * List folders. Retrieve the list of folders created within a Project.
    *
    * @param request - The request {@link ListFoldersRequest}
    * @returns A Promise of ListFoldersResponse