@scaleway/sdk 2.11.0 → 2.13.0

package/dist/index.cjs

@@ -497,7 +497,7 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v2.10.0';
+const version = 'v2.12.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () =>
@@ -3660,7 +3660,7 @@ const unmarshalGetConsumptionResponse = data => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
-const unmarshalDiscountCoupon = data => {
+const unmarshalDiscountCoupon$1 = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`);
   }
@@ -3668,7 +3668,7 @@ const unmarshalDiscountCoupon = data => {
     description: data.description
   };
 };
-const unmarshalDiscountFilter = data => {
+const unmarshalDiscountFilter$1 = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`);
   }
@@ -3677,15 +3677,15 @@ const unmarshalDiscountFilter = data => {
     value: data.value
   };
 };
-const unmarshalDiscount = data => {
+const unmarshalDiscount$1 = 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,
+    coupon: data.coupon ? unmarshalDiscountCoupon$1(data.coupon) : undefined,
     creationDate: unmarshalDate(data.creation_date),
     description: data.description,
-    filters: unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
+    filters: unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter$1),
     id: data.id,
     mode: data.mode,
     organizationId: data.organization_id,
@@ -3696,12 +3696,12 @@ const unmarshalDiscount = data => {
     valueUsed: data.value_used
   };
 };
-const unmarshalListDiscountsResponse = data => {
+const unmarshalListDiscountsResponse$1 = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListDiscountsResponse' failed as data isn't a dictionary.`);
   }
   return {
-    discounts: unmarshalArrayOfObject(data.discounts, unmarshalDiscount),
+    discounts: unmarshalArrayOfObject(data.discounts, unmarshalDiscount$1),
     totalCount: data.total_count
   };
 };
@@ -3782,7 +3782,7 @@ let API$t = class API extends API$x {
     method: 'GET',
     path: `/billing/v2alpha1/discounts`,
     urlParams: urlParams(['order_by', request.orderBy], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
-  }, unmarshalListDiscountsResponse);
+  }, unmarshalListDiscountsResponse$1);
 
   /**
    * List all user's discounts. List all discounts for an organization and
@@ -3811,7 +3811,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),
@@ -3835,11 +3834,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
   };
 };
@@ -3854,6 +3855,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.`);
@@ -3980,6 +4026,12 @@ let API$s = class API extends API$x {
     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);
 };
 
 // This file was automatically generated. DO NOT EDIT.
@@ -4720,13 +4772,13 @@ const jsonContentHeaders$p = {
 /**
  * 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.
  */
 let API$q = class API extends API$x {
   /**
-   * 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
@@ -4739,7 +4791,7 @@ let API$q = class API extends API$x {
   }, 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
@@ -4760,7 +4812,8 @@ let API$q = class API extends API$x {
   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
@@ -4772,7 +4825,7 @@ let API$q = class API extends API$x {
   }, 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
@@ -4785,7 +4838,8 @@ let API$q = class API extends API$x {
   }, 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
@@ -4798,7 +4852,7 @@ let API$q = class API extends API$x {
   }, 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}
    */
@@ -4813,7 +4867,7 @@ let API$q = class API extends API$x {
   }, 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
@@ -4821,7 +4875,7 @@ let API$q = class API extends API$x {
   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
@@ -4839,7 +4893,7 @@ let API$q = class API extends API$x {
   }, unmarshalListTokensResponse$2);
 
   /**
-   * 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
@@ -4847,7 +4901,7 @@ let API$q = class API extends API$x {
   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
@@ -4858,7 +4912,7 @@ let API$q = class API extends API$x {
   }, unmarshalToken$2);
 
   /**
-   * Delete the token associated with the specified token ID.
+   * Delete a given token specified by the token ID.
    *
    * @param request - The request {@link DeleteTokenRequest}
    */
@@ -4868,7 +4922,8 @@ let API$q = class API extends API$x {
   });
 
   /**
-   * 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
@@ -4886,8 +4941,8 @@ let API$q = class API extends API$x {
   }, 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
@@ -4895,7 +4950,7 @@ let API$q = class API extends API$x {
   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}
    */
@@ -4907,7 +4962,8 @@ let API$q = class API extends API$x {
   });
 
   /**
-   * 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}
    */
@@ -4919,7 +4975,8 @@ let API$q = class API extends API$x {
   });
 
   /**
-   * 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}
    */
@@ -4931,7 +4988,8 @@ let API$q = class API extends API$x {
   });
 
   /**
-   * 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}
    */
@@ -4943,8 +5001,8 @@ let API$q = class API extends API$x {
   });
 
   /**
-   * 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
@@ -4962,8 +5020,7 @@ let API$q = class API extends API$x {
   }, 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
@@ -4971,8 +5028,8 @@ let API$q = class API extends API$x {
   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}
    */
@@ -4984,8 +5041,8 @@ let API$q = class API extends API$x {
   });
 
   /**
-   * 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
@@ -11521,7 +11578,7 @@ let API$k = class API extends API$x {
   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);
 
   /**
@@ -11660,7 +11717,7 @@ let API$k = class API extends API$x {
   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
     }, {
@@ -12254,7 +12311,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 => {
@@ -13434,7 +13492,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,
@@ -16397,8 +16456,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,
@@ -16445,6 +16506,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
@@ -16541,7 +16607,7 @@ let API$f = class API extends API$x {
    * @returns A Promise of JobRun
    */
   startJobDefinition = request => this.client.fetch({
-    body: '{}',
+    body: JSON.stringify(marshalStartJobDefinitionRequest(request, this.client.settings)),
     headers: jsonContentHeaders$e,
     method: 'POST',
     path: `/serverless-jobs/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/job-definitions/${validatePathParam('jobDefinitionId', request.jobDefinitionId)}/start`
@@ -17285,7 +17351,7 @@ let API$e = class API extends API$x {
   _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'
   });
 
@@ -24159,6 +24225,7 @@ const marshalEphemeralPolicy = (request, defaults) => ({
 const marshalCreateSecretRequest = (request, defaults) => ({
   description: request.description,
   ephemeral_policy: request.ephemeralPolicy !== undefined ? marshalEphemeralPolicy(request.ephemeralPolicy) : undefined,
+  is_protected: request.isProtected,
   name: request.name,
   path: request.path,
   project_id: request.projectId ?? defaults.defaultProjectId,
@@ -24744,7 +24811,7 @@ let API$6 = class API extends API$x {
   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);
 
   /**
@@ -24803,7 +24870,7 @@ let API$6 = class API extends API$x {
   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);
 
   /**
@@ -25252,6 +25319,16 @@ const unmarshalDomainLastStatusDkimRecord = data => {
     status: data.status
   };
 };
+const unmarshalDomainLastStatusDmarcRecord = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'DomainLastStatusDmarcRecord' failed as data isn't a dictionary.`);
+  }
+  return {
+    error: data.error,
+    lastValidAt: unmarshalDate(data.last_valid_at),
+    status: data.status
+  };
+};
 const unmarshalDomainLastStatusSpfRecord = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'DomainLastStatusSpfRecord' failed as data isn't a dictionary.`);
@@ -25268,6 +25345,7 @@ const unmarshalDomainLastStatus = data => {
   }
   return {
     dkimRecord: data.dkim_record ? unmarshalDomainLastStatusDkimRecord(data.dkim_record) : undefined,
+    dmarcRecord: data.dmarc_record ? unmarshalDomainLastStatusDmarcRecord(data.dmarc_record) : undefined,
     domainId: data.domain_id,
     domainName: data.domain_name,
     spfRecord: data.spf_record ? unmarshalDomainLastStatusSpfRecord(data.spf_record) : undefined