@scaleway/sdk 1.29.0 → 1.31.0

package/dist/index.cjs

@@ -497,7 +497,7 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v1.28.0';
+const version = 'v1.30.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -3745,11 +3745,13 @@ const unmarshalTokenScopes = data => {
   return {
     queryLogs: data.query_logs,
     queryMetrics: data.query_metrics,
+    queryTraces: data.query_traces,
     setupAlerts: data.setup_alerts,
     setupLogsRules: data.setup_logs_rules,
     setupMetricsRules: data.setup_metrics_rules,
     writeLogs: data.write_logs,
-    writeMetrics: data.write_metrics
+    writeMetrics: data.write_metrics,
+    writeTraces: data.write_traces
   };
 };
 const unmarshalCockpitEndpoints = data => {
@@ -3888,11 +3890,13 @@ const marshalContactPoint = (request, defaults) => ({
 const marshalTokenScopes = (request, defaults) => ({
   query_logs: request.queryLogs,
   query_metrics: request.queryMetrics,
+  query_traces: request.queryTraces,
   setup_alerts: request.setupAlerts,
   setup_logs_rules: request.setupLogsRules,
   setup_metrics_rules: request.setupMetricsRules,
   write_logs: request.writeLogs,
-  write_metrics: request.writeMetrics
+  write_metrics: request.writeMetrics,
+  write_traces: request.writeTraces
 });
 const marshalActivateCockpitRequest = (request, defaults) => ({
   project_id: request.projectId ?? defaults.defaultProjectId
@@ -10315,6 +10319,16 @@ const unmarshalListVolumesTypesResponse = data => {
     volumes: unmarshalMapOfObject(data.volumes, unmarshalVolumeType)
   };
 };
+const unmarshalMigrationPlan = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'MigrationPlan' failed as data isn't a dictionary.`);
+  }
+  return {
+    snapshots: unmarshalArrayOfObject(data.snapshots, unmarshalSnapshot$1),
+    validationKey: data.validation_key,
+    volume: data.volume ? unmarshalVolume$2(data.volume) : undefined
+  };
+};
 const unmarshalServerActionResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ServerActionResponse' failed as data isn't a dictionary.`);
@@ -10579,6 +10593,16 @@ const marshalVolumeTemplate = (request, defaults) => ({
     value: request.organization
   }])
 });
+const marshalApplyBlockMigrationRequest = (request, defaults) => ({
+  validation_key: request.validationKey,
+  ...resolveOneOf([{
+    param: 'volume_id',
+    value: request.volumeId
+  }, {
+    param: 'snapshot_id',
+    value: request.snapshotId
+  }])
+});
 const marshalCreateImageRequest = (request, defaults) => ({
   arch: request.arch,
   default_bootscript: request.defaultBootscript,
@@ -10743,6 +10767,15 @@ const marshalExportSnapshotRequest = (request, defaults) => ({
   bucket: request.bucket,
   key: request.key
 });
+const marshalPlanBlockMigrationRequest = (request, defaults) => ({
+  ...resolveOneOf([{
+    param: 'volume_id',
+    value: request.volumeId
+  }, {
+    param: 'snapshot_id',
+    value: request.snapshotId
+  }])
+});
 const marshalServerActionRequest = (request, defaults) => ({
   action: request.action ?? 'poweron',
   name: request.name,
@@ -10950,7 +10983,7 @@ let API$h = class API extends API$s {
   pageOfListServers = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/servers`,
-    urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['private_networks', request.privateNetworks && request.privateNetworks.length > 0 ? request.privateNetworks.join(',') : undefined], ['project', request.project], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
+    urlParams: urlParams(['commercial_type', request.commercialType], ['name', request.name], ['order', request.order], ['organization', request.organization], ['page', request.page], ['per_page', request.perPage ?? this.client.settings.defaultPageSize], ['private_ip', request.privateIp], ['private_network', request.privateNetwork], ['private_networks', request.privateNetworks && request.privateNetworks.length > 0 ? request.privateNetworks.join(',') : undefined], ['private_nic_mac_address', request.privateNicMacAddress], ['project', request.project], ['state', request.state], ['tags', request.tags && request.tags.length > 0 ? request.tags.join(',') : undefined], ['without_ip', request.withoutIp])
   }, unmarshalListServersResponse);
 
   /**
@@ -11502,7 +11535,7 @@ let API$h = class API extends API$s {
   pageOfListIps = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/ips`,
-    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 && request.tags.length > 0 ? request.tags.join(',') : undefined])
+    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 && request.tags.length > 0 ? request.tags.join(',') : undefined], ['type', request.type])
   }, unmarshalListIpsResponse$1);
 
   /**
@@ -11653,6 +11686,40 @@ let API$h = class API extends API$s {
     path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/dashboard`,
     urlParams: urlParams(['organization', request.organization], ['project', request.project])
   }, unmarshalGetDashboardResponse);
+
+  /**
+   * Get a volume or snapshot's migration plan. Given a volume or snapshot,
+   * returns the migration plan for a call to the RPC ApplyBlockMigration. This
+   * plan will include zero or one volume, and zero or more snapshots, which
+   * will need to be migrated together. This RPC does not perform the actual
+   * migration itself, ApplyBlockMigration must be used. The validation_key
+   * value returned by this call must be provided to the ApplyBlockMigration
+   * call to confirm that all resources listed in the plan should be migrated.
+   *
+   * @param request - The request {@link PlanBlockMigrationRequest}
+   * @returns A Promise of MigrationPlan
+   */
+  planBlockMigration = (request = {}) => this.client.fetch({
+    body: JSON.stringify(marshalPlanBlockMigrationRequest(request, this.client.settings)),
+    headers: jsonContentHeaders$f,
+    method: 'POST',
+    path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/block-migration/plan`
+  }, unmarshalMigrationPlan);
+
+  /**
+   * Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be
+   * used, this RPC must be preceded by a call to PlanBlockMigration. To migrate
+   * all resources mentioned in the MigrationPlan, the validation_key returned
+   * in the MigrationPlan must be provided.
+   *
+   * @param request - The request {@link ApplyBlockMigrationRequest}
+   */
+  applyBlockMigration = request => this.client.fetch({
+    body: JSON.stringify(marshalApplyBlockMigrationRequest(request, this.client.settings)),
+    headers: jsonContentHeaders$f,
+    method: 'POST',
+    path: `/instance/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/block-migration/apply`
+  });
 };
 
 // This file was automatically generated. DO NOT EDIT.
@@ -13125,7 +13192,6 @@ const unmarshalName = data => {
     throw new TypeError(`Unmarshalling the type 'Name' failed as data isn't a dictionary.`);
   }
   return {
-    cid: data.cid,
     createdAt: unmarshalDate(data.created_at),
     key: data.key,
     name: data.name,
@@ -13133,7 +13199,8 @@ const unmarshalName = data => {
     projectId: data.project_id,
     status: data.status,
     tags: data.tags,
-    updatedAt: unmarshalDate(data.updated_at)
+    updatedAt: unmarshalDate(data.updated_at),
+    value: data.value
   };
 };
 const unmarshalPin = data => {
@@ -13218,9 +13285,9 @@ const marshalPinOptions = (request, defaults) => ({
   required_zones: request.requiredZones
 });
 const marshalCreateNameRequest = (request, defaults) => ({
-  cid: request.cid,
   name: request.name,
-  project_id: request.projectId ?? defaults.defaultProjectId
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  value: request.value
 });
 const marshalCreatePinByCIDRequest = (request, defaults) => ({
   cid: request.cid,
@@ -13242,7 +13309,8 @@ const marshalCreateVolumeRequest = (request, defaults) => ({
 const marshalImportKeyNameRequest = (request, defaults) => ({
   name: request.name,
   private_key: request.privateKey,
-  project_id: request.projectId ?? defaults.defaultProjectId
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  value: request.value
 });
 const marshalReplacePinRequest = (request, defaults) => ({
   cid: request.cid,
@@ -13252,9 +13320,9 @@ const marshalReplacePinRequest = (request, defaults) => ({
   volume_id: request.volumeId
 });
 const marshalUpdateNameRequest = (request, defaults) => ({
-  cid: request.cid,
   name: request.name,
-  tags: request.tags
+  tags: request.tags,
+  value: request.value
 });
 const marshalUpdateVolumeRequest = (request, defaults) => ({
   name: request.name,
@@ -13412,7 +13480,7 @@ let API$f = class API extends API$s {
   }, unmarshalListPinsResponse);
 
   /**
-   * List all pins within a volume. Retrieve information about all pins into a
+   * List all pins within a volume. Retrieve information about all pins within a
    * volume.
    *
    * @param request - The request {@link ListPinsRequest}
@@ -13432,12 +13500,27 @@ 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)}`
@@ -13451,6 +13534,12 @@ let API$f = class API extends API$s {
    * @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)}`
@@ -13460,17 +13549,46 @@ let API$f = class API extends API$s {
     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,
@@ -22957,6 +23075,7 @@ const unmarshalOfferProduct = data => {
     emailAccountsQuota: data.email_accounts_quota,
     emailStorageQuota: data.email_storage_quota,
     hostingStorageQuota: data.hosting_storage_quota,
+    maxAddonDomains: data.max_addon_domains,
     name: data.name,
     option: data.option,
     ram: data.ram,