@scaleway/sdk 2.11.0 → 2.12.0

package/dist/api/billing/v2beta1/api.gen.js

@@ -1,7 +1,7 @@
 import { API as API$1 } from '../../../scw/api.js';
 import { urlParams, resolveOneOf, validatePathParam } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
-import { unmarshalListConsumptionsResponse, unmarshalListTaxesResponse, unmarshalListInvoicesResponse, unmarshalInvoice } from './marshalling.gen.js';
+import { unmarshalListConsumptionsResponse, unmarshalListTaxesResponse, unmarshalListInvoicesResponse, unmarshalInvoice, unmarshalListDiscountsResponse } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
@@ -98,6 +98,12 @@ class API extends API$1 {
     urlParams: urlParams(['dl', 1], ['file_type', request.fileType]),
     responseType: 'blob'
   });
+  pageOfListDiscounts = (request = {}) => this.client.fetch({
+    method: 'GET',
+    path: `/billing/v2beta1/discounts`,
+    urlParams: urlParams(['order_by', request.orderBy], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
+  }, unmarshalListDiscountsResponse);
+  listDiscounts = (request = {}) => enrichForPagination('discounts', this.pageOfListDiscounts, request);
 }
 
 export { API };

package/dist/api/billing/v2beta1/marshalling.gen.js

@@ -10,7 +10,6 @@ const unmarshalInvoice = data => {
   }
   return {
     billingPeriod: unmarshalDate(data.billing_period),
-    customerName: data.customer_name,
     dueDate: unmarshalDate(data.due_date),
     id: data.id,
     issuedDate: unmarshalDate(data.issued_date),
@@ -34,11 +33,13 @@ const unmarshalListConsumptionsResponseConsumption = data => {
     throw new TypeError(`Unmarshalling the type 'ListConsumptionsResponseConsumption' failed as data isn't a dictionary.`);
   }
   return {
+    billedQuantity: data.billed_quantity,
     categoryName: data.category_name,
     productName: data.product_name,
     projectId: data.project_id,
     resourceName: data.resource_name,
     sku: data.sku,
+    unit: data.unit,
     value: data.value ? unmarshalMoney(data.value) : undefined
   };
 };
@@ -53,6 +54,51 @@ const unmarshalListConsumptionsResponse = data => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
+const unmarshalDiscountCoupon = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`);
+  }
+  return {
+    description: data.description
+  };
+};
+const unmarshalDiscountFilter = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`);
+  }
+  return {
+    type: data.type,
+    value: data.value
+  };
+};
+const unmarshalDiscount = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Discount' failed as data isn't a dictionary.`);
+  }
+  return {
+    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : undefined,
+    creationDate: unmarshalDate(data.creation_date),
+    description: data.description,
+    filters: unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
+    id: data.id,
+    mode: data.mode,
+    organizationId: data.organization_id,
+    startDate: unmarshalDate(data.start_date),
+    stopDate: unmarshalDate(data.stop_date),
+    value: data.value,
+    valueRemaining: data.value_remaining,
+    valueUsed: data.value_used
+  };
+};
+const unmarshalListDiscountsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListDiscountsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    discounts: unmarshalArrayOfObject(data.discounts, unmarshalDiscount),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListInvoicesResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListInvoicesResponse' failed as data isn't a dictionary.`);
@@ -84,4 +130,4 @@ const unmarshalListTaxesResponse = data => {
   };
 };
 
-export { unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse };
+export { unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse };

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

@@ -14,13 +14,13 @@ const jsonContentHeaders = {
 /**
  * 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.
+ * The Cockpit API allows you to activate your Cockpit to store metrics and
+ * logs. It also provides you with a dedicated Grafana for dashboarding to
+ * visualize your metrics and logs.
  */
 class API extends API$1 {
   /**
-   * Activate the Cockpit of the specified Project ID.
+   * Activate the Cockpit of a given Project specified by the Project ID.
    *
    * @param request - The request {@link ActivateCockpitRequest}
    * @returns A Promise of Cockpit
@@ -33,7 +33,7 @@ class API extends API$1 {
   }, unmarshalCockpit);
 
   /**
-   * Retrieve the Cockpit of the specified Project ID.
+   * Retrieve the Cockpit of a given Project specified by the Project ID.
    *
    * @param request - The request {@link GetCockpitRequest}
    * @returns A Promise of Cockpit
@@ -54,7 +54,8 @@ class API extends API$1 {
   waitForCockpit = (request = {}, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))), this.getCockpit, request, options);
 
   /**
-   * Get metrics from your Cockpit with the specified Project ID.
+   * Retrieve metrics from your Cockpit specified by the ID of the Project the
+   * Cockpit belongs to.
    *
    * @param request - The request {@link GetCockpitMetricsRequest}
    * @returns A Promise of CockpitMetrics
@@ -66,7 +67,7 @@ class API extends API$1 {
   }, unmarshalCockpitMetrics);
 
   /**
-   * Deactivate the Cockpit of the specified Project ID.
+   * Deactivate the Cockpit of a given Project specified by the Project ID.
    *
    * @param request - The request {@link DeactivateCockpitRequest}
    * @returns A Promise of Cockpit
@@ -79,7 +80,8 @@ class API extends API$1 {
   }, unmarshalCockpit);
 
   /**
-   * Create a datasource for the specified Project ID and the given type.
+   * Create a data source for a given Project specified by the Project ID and
+   * the data source type.
    *
    * @param request - The request {@link CreateDatasourceRequest}
    * @returns A Promise of Datasource
@@ -92,7 +94,7 @@ class API extends API$1 {
   }, unmarshalDatasource);
 
   /**
-   * Delete the datasource associated with the specified datasource ID.
+   * Delete a given data source specified by the data source ID.
    *
    * @param request - The request {@link DeleteDatasourceRequest}
    */
@@ -107,7 +109,7 @@ class API extends API$1 {
   }, unmarshalListDatasourcesResponse);
 
   /**
-   * Get a list of datasources for the specified Project ID.
+   * Get a list of data sources for the specified Project ID.
    *
    * @param request - The request {@link ListDatasourcesRequest}
    * @returns A Promise of ListDatasourcesResponse
@@ -115,7 +117,7 @@ class API extends API$1 {
   listDatasources = (request = {}) => enrichForPagination('datasources', this.pageOfListDatasources, request);
 
   /**
-   * Create a token associated with the specified Project ID.
+   * Create a token in a given Project specified by the Project ID.
    *
    * @param request - The request {@link CreateTokenRequest}
    * @returns A Promise of Token
@@ -133,7 +135,7 @@ class API extends API$1 {
   }, unmarshalListTokensResponse);
 
   /**
-   * Get a list of tokens associated with the specified Project ID.
+   * Get a list of tokens in a given Project specified by the Project ID.
    *
    * @param request - The request {@link ListTokensRequest}
    * @returns A Promise of ListTokensResponse
@@ -141,7 +143,7 @@ class API extends API$1 {
   listTokens = (request = {}) => enrichForPagination('tokens', this.pageOfListTokens, request);
 
   /**
-   * Retrieve the token associated with the specified token ID.
+   * Retrieve a given token specified by the token ID.
    *
    * @param request - The request {@link GetTokenRequest}
    * @returns A Promise of Token
@@ -152,7 +154,7 @@ class API extends API$1 {
   }, unmarshalToken);
 
   /**
-   * Delete the token associated with the specified token ID.
+   * Delete a given token specified by the token ID.
    *
    * @param request - The request {@link DeleteTokenRequest}
    */
@@ -162,7 +164,8 @@ class API extends API$1 {
   });
 
   /**
-   * Create a contact point to receive alerts for the default receiver.
+   * Create a contact point associated with the default receiver, to receive
+   * alerts.
    *
    * @param request - The request {@link CreateContactPointRequest}
    * @returns A Promise of ContactPoint
@@ -180,8 +183,8 @@ class API extends API$1 {
   }, unmarshalListContactPointsResponse);
 
   /**
-   * Get a list of contact points for the Cockpit associated with the specified
-   * Project ID.
+   * Get a list of contact points created for a given Cockpit, specified by the
+   * ID of the Project the Cockpit belongs to.
    *
    * @param request - The request {@link ListContactPointsRequest}
    * @returns A Promise of ListContactPointsResponse
@@ -189,7 +192,7 @@ class API extends API$1 {
   listContactPoints = (request = {}) => enrichForPagination('contactPoints', this.pageOfListContactPoints, request);
 
   /**
-   * Delete a contact point for the default receiver.
+   * Delete a contact point associated with the default receiver.
    *
    * @param request - The request {@link DeleteContactPointRequest}
    */
@@ -201,7 +204,8 @@ class API extends API$1 {
   });
 
   /**
-   * Enable the sending of managed alerts for the specified Project's Cockpit.
+   * Enable the sending of managed alerts for a given Cockpit, specified by the
+   * ID of the Project the Cockpit belongs to.
    *
    * @param request - The request {@link EnableManagedAlertsRequest}
    */
@@ -213,7 +217,8 @@ class API extends API$1 {
   });
 
   /**
-   * Disable the sending of managed alerts for the specified Project's Cockpit.
+   * Disable the sending of managed alerts for a given Cockpit, specified by the
+   * ID of the Project the Cockpit belongs to.
    *
    * @param request - The request {@link DisableManagedAlertsRequest}
    */
@@ -225,7 +230,8 @@ class API extends API$1 {
   });
 
   /**
-   * Trigger a test alert to all of the Cockpit's receivers.
+   * Send a test alert to make sure your contact points get notified when an
+   * actual alert is triggered.
    *
    * @param request - The request {@link TriggerTestAlertRequest}
    */
@@ -237,8 +243,8 @@ class API extends API$1 {
   });
 
   /**
-   * 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. Make sure you save the
+   * automatically-generated password and the Grafana user ID.
    *
    * @param request - The request {@link CreateGrafanaUserRequest}
    * @returns A Promise of GrafanaUser
@@ -256,8 +262,7 @@ class API extends API$1 {
   }, unmarshalListGrafanaUsersResponse);
 
   /**
-   * Get a list of Grafana users who are able to connect to the Cockpit's
-   * Grafana instance.
+   * Get a list of all Grafana users created in your Cockpit's Grafana.
    *
    * @param request - The request {@link ListGrafanaUsersRequest}
    * @returns A Promise of ListGrafanaUsersResponse
@@ -265,8 +270,8 @@ class API extends API$1 {
   listGrafanaUsers = (request = {}) => enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request);
 
   /**
-   * 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 your Cockpit's Grafana, specified by the ID of
+   * the Project the Cockpit belongs to, and the ID of the Grafana user.
    *
    * @param request - The request {@link DeleteGrafanaUserRequest}
    */
@@ -278,8 +283,8 @@ class API extends API$1 {
   });
 
   /**
-   * Reset a Grafana user's password specified by the Cockpit's Project ID and
-   * the Grafana user ID.
+   * Reset the password of a Grafana user, specified by the ID of the Project
+   * the Cockpit belongs to, and the ID of the Grafana user.
    *
    * @param request - The request {@link ResetGrafanaUserPasswordRequest}
    * @returns A Promise of GrafanaUser

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

@@ -364,7 +364,7 @@ class API extends API$1 {
   pageOfListPolicies = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/iam/v1alpha1/policies`,
-    urlParams: urlParams(['application_ids', request.applicationIds], ['editable', request.editable], ['group_ids', request.groupIds], ['no_principal', request.noPrincipal], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['policy_name', request.policyName], ['tag', request.tag], ['user_ids', request.userIds])
+    urlParams: urlParams(['application_ids', request.applicationIds], ['editable', request.editable], ['group_ids', request.groupIds], ['no_principal', request.noPrincipal], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['policy_ids', request.policyIds], ['policy_name', request.policyName], ['tag', request.tag], ['user_ids', request.userIds])
   }, unmarshalListPoliciesResponse);
 
   /**
@@ -503,7 +503,7 @@ class API extends API$1 {
   pageOfListAPIKeys = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/iam/v1alpha1/api-keys`,
-    urlParams: urlParams(['access_key', request.accessKey], ['bearer_id', request.bearerId], ['bearer_type', request.bearerType], ['description', request.description], ['editable', request.editable], ['expired', request.expired], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ...Object.entries(resolveOneOf([{
+    urlParams: urlParams(['access_key', request.accessKey], ['access_keys', request.accessKeys], ['bearer_id', request.bearerId], ['bearer_type', request.bearerType], ['description', request.description], ['editable', request.editable], ['expired', request.expired], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ...Object.entries(resolveOneOf([{
       param: 'application_id',
       value: request.applicationId
     }, {

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

@@ -167,7 +167,8 @@ const unmarshalServerMaintenance = data => {
     throw new TypeError(`Unmarshalling the type 'ServerMaintenance' failed as data isn't a dictionary.`);
   }
   return {
-    reason: data.reason
+    reason: data.reason,
+    startDate: unmarshalDate(data.start_date)
   };
 };
 const unmarshalVolumeServer = data => {
@@ -1347,7 +1348,8 @@ const marshalServerLocation = (request, defaults) => ({
   zone_id: request.zoneId
 });
 const marshalServerMaintenance = (request, defaults) => ({
-  reason: request.reason
+  reason: request.reason,
+  start_date: request.startDate
 });
 const marshalSetServerRequest = (request, defaults) => ({
   allowed_actions: request.allowedActions !== undefined ? request.allowedActions : undefined,

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

@@ -1,7 +1,7 @@
 import { API as API$1 } from '../../../scw/api.js';
 import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
-import { marshalCreateJobDefinitionRequest, unmarshalJobDefinition, unmarshalListJobDefinitionsResponse, marshalUpdateJobDefinitionRequest, unmarshalJobRun, unmarshalListJobRunsResponse } from './marshalling.gen.js';
+import { marshalCreateJobDefinitionRequest, unmarshalJobDefinition, unmarshalListJobDefinitionsResponse, marshalUpdateJobDefinitionRequest, marshalStartJobDefinitionRequest, unmarshalJobRun, unmarshalListJobRunsResponse } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
@@ -83,7 +83,7 @@ class API extends API$1 {
    * @returns A Promise of JobRun
    */
   startJobDefinition = request => this.client.fetch({
-    body: '{}',
+    body: JSON.stringify(marshalStartJobDefinitionRequest(request, this.client.settings)),
     headers: jsonContentHeaders,
     method: 'POST',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam('jobDefinitionId', request.jobDefinitionId)}/start`

package/dist/api/jobs/v1alpha1/marshalling.gen.js

@@ -39,8 +39,10 @@ const unmarshalJobRun = data => {
     throw new TypeError(`Unmarshalling the type 'JobRun' failed as data isn't a dictionary.`);
   }
   return {
+    command: data.command,
     cpuLimit: data.cpu_limit,
     createdAt: unmarshalDate(data.created_at),
+    environmentVariables: data.environment_variables,
     errorMessage: data.error_message,
     exitCode: data.exit_code,
     id: data.id,
@@ -87,6 +89,11 @@ const marshalCreateJobDefinitionRequest = (request, defaults) => ({
   name: request.name || randomName('job'),
   project_id: request.projectId ?? defaults.defaultProjectId
 });
+const marshalStartJobDefinitionRequest = (request, defaults) => ({
+  command: request.command,
+  environment_variables: request.environmentVariables,
+  replicas: request.replicas
+});
 const marshalUpdateJobDefinitionRequestCronScheduleConfig = (request, defaults) => ({
   schedule: request.schedule,
   timezone: request.timezone
@@ -103,4 +110,4 @@ const marshalUpdateJobDefinitionRequest = (request, defaults) => ({
   name: request.name
 });
 
-export { marshalCreateJobDefinitionRequest, marshalUpdateJobDefinitionRequest, unmarshalJobDefinition, unmarshalJobRun, unmarshalListJobDefinitionsResponse, unmarshalListJobRunsResponse };
+export { marshalCreateJobDefinitionRequest, marshalStartJobDefinitionRequest, marshalUpdateJobDefinitionRequest, unmarshalJobDefinition, unmarshalJobRun, unmarshalListJobDefinitionsResponse, unmarshalListJobRunsResponse };

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

@@ -150,7 +150,7 @@ class API extends API$1 {
   _getClusterKubeConfig = request => this.client.fetch({
     method: 'GET',
     path: `/k8s/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/clusters/${validatePathParam('clusterId', request.clusterId)}/kubeconfig`,
-    urlParams: urlParams(['dl', 1]),
+    urlParams: urlParams(['dl', 1], ['redacted', request.redacted]),
     responseType: 'blob'
   });
 

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

@@ -70,7 +70,7 @@ class API extends API$1 {
   pageOfListDatabases = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/serverless-sqldb/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/databases`,
-    urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
+    urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
   }, unmarshalListDatabasesResponse);
 
   /**
@@ -129,7 +129,7 @@ class API extends API$1 {
   pageOfListDatabaseBackups = request => this.client.fetch({
     method: 'GET',
     path: `/serverless-sqldb/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups`,
-    urlParams: urlParams(['database_id', request.databaseId], ['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize])
+    urlParams: urlParams(['database_id', request.databaseId], ['order_by', request.orderBy], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize], ['project_id', request.projectId])
   }, unmarshalListDatabaseBackupsResponse);
 
   /**