@scaleway/sdk 1.0.0 → 1.1.0

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

@@ -164,10 +164,13 @@ const unmarshalOffer = data => {
     persistentMemories: unmarshalArrayOfObject(data.persistent_memories, unmarshalPersistentMemory),
     pricePerHour: data.price_per_hour ? unmarshalMoney(data.price_per_hour) : undefined,
     pricePerMonth: data.price_per_month ? unmarshalMoney(data.price_per_month) : undefined,
+    privateBandwidth: data.private_bandwidth,
     quotaName: data.quota_name,
     raidControllers: unmarshalArrayOfObject(data.raid_controllers, unmarshalRaidController),
+    sharedBandwidth: data.shared_bandwidth,
     stock: data.stock,
-    subscriptionPeriod: data.subscription_period
+    subscriptionPeriod: data.subscription_period,
+    tags: data.tags
   };
 };
 const unmarshalOption = data => {

package/dist/api/cockpit/index.js

@@ -0,0 +1,2 @@
+import * as index_gen from './v1beta1/index.gen.js';
+export { index_gen as v1beta1 };

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

@@ -0,0 +1,307 @@
+import { waitForResource } from '../../../internal/async/interval-retrier.js';
+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';
+
+// This file was automatically generated. DO NOT EDIT.
+const jsonContentHeaders = {
+  'Content-Type': 'application/json; charset=utf-8'
+};
+
+/**
+ * Cockpit API.
+ *
+ * This API allows to manage Cockpits.
+ */
+class API extends API$1 {
+  constructor() {
+    var _this;
+    super(...arguments);
+    _this = this;
+    this.activateCockpit = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalActivateCockpitRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/activate`
+      }, unmarshalCockpit);
+    };
+    /**
+     * Get the cockpit associated with the given project ID.
+     *
+     * @param request - The request {@link GetCockpitRequest}
+     * @returns A Promise of Cockpit
+     */
+    this.getCockpit = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/cockpit/v1beta1/cockpit`,
+        urlParams: urlParams(['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+      }, unmarshalCockpit);
+    };
+    /**
+     * Waits for {@link Cockpit} to be in a final state.
+     *
+     * @param request - The request {@link GetCockpitRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Cockpit
+     */
+    this.waitForCockpit = function (request, options) {
+      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);
+    };
+    this.deactivateCockpit = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalDeactivateCockpitRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/deactivate`
+      }, unmarshalCockpit);
+    };
+    /**
+     * Reset the Grafana your cockpit associated with the given project ID.
+     *
+     * @param request - The request {@link ResetCockpitGrafanaRequest}
+     * @returns A Promise of Cockpit
+     */
+    this.resetCockpitGrafana = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalResetCockpitGrafanaRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/reset-grafana`
+      }, unmarshalCockpit);
+    };
+    /**
+     * Create token associated with the given project ID.
+     *
+     * @param request - The request {@link CreateTokenRequest}
+     * @returns A Promise of Token
+     */
+    this.createToken = request => this.client.fetch({
+      body: JSON.stringify(marshalCreateTokenRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/cockpit/v1beta1/tokens`
+    }, unmarshalToken);
+    this.pageOfListTokens = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/cockpit/v1beta1/tokens`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+      }, unmarshalListTokensResponse);
+    };
+    /**
+     * List tokens associated with the given project ID.
+     *
+     * @param request - The request {@link ListTokensRequest}
+     * @returns A Promise of ListTokensResponse
+     */
+    this.listTokens = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('tokens', _this.pageOfListTokens, request);
+    };
+    /**
+     * Get the token associated with the given ID.
+     *
+     * @param request - The request {@link GetTokenRequest}
+     * @returns A Promise of Token
+     */
+    this.getToken = request => this.client.fetch({
+      method: 'GET',
+      path: `/cockpit/v1beta1/tokens/${validatePathParam('tokenId', request.tokenId)}`
+    }, unmarshalToken);
+    /**
+     * Delete the token associated with the given ID.
+     *
+     * @param request - The request {@link DeleteTokenRequest}
+     */
+    this.deleteToken = request => this.client.fetch({
+      method: 'DELETE',
+      path: `/cockpit/v1beta1/tokens/${validatePathParam('tokenId', request.tokenId)}`
+    });
+    /**
+     * Create an alert contact point for the default receiver.
+     *
+     * @param request - The request {@link CreateContactPointRequest}
+     * @returns A Promise of ContactPoint
+     */
+    this.createContactPoint = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalCreateContactPointRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/contact-points`
+      }, unmarshalContactPoint);
+    };
+    this.pageOfListContactPoints = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/cockpit/v1beta1/contact-points`,
+        urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+      }, unmarshalListContactPointsResponse);
+    };
+    /**
+     * List alert contact points associated with the given cockpit ID.
+     *
+     * @param request - The request {@link ListContactPointsRequest}
+     * @returns A Promise of ListContactPointsResponse
+     */
+    this.listContactPoints = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('contactPoints', _this.pageOfListContactPoints, request);
+    };
+    /**
+     * Delete an alert contact point for the default receiver.
+     *
+     * @param request - The request {@link DeleteContactPointRequest}
+     */
+    this.deleteContactPoint = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalDeleteContactPointRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/delete-contact-point`
+      });
+    };
+    /**
+     * Enable managed alerts.
+     *
+     * @param request - The request {@link EnableManagedAlertsRequest}
+     */
+    this.enableManagedAlerts = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalEnableManagedAlertsRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/enable-managed-alerts`
+      });
+    };
+    /**
+     * Disable managed alerts.
+     *
+     * @param request - The request {@link DisableManagedAlertsRequest}
+     */
+    this.disableManagedAlerts = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalDisableManagedAlertsRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/disable-managed-alerts`
+      });
+    };
+    /**
+     * Trigger a test alert to all receivers.
+     *
+     * @param request - The request {@link TriggerTestAlertRequest}
+     */
+    this.triggerTestAlert = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        body: JSON.stringify(marshalTriggerTestAlertRequest(request, _this.client.settings)),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/cockpit/v1beta1/trigger-test-alert`
+      });
+    };
+    /**
+     * Create a grafana user for your grafana instance.
+     *
+     * @param request - The request {@link CreateGrafanaUserRequest}
+     * @returns A Promise of GrafanaUser
+     */
+    this.createGrafanaUser = request => this.client.fetch({
+      body: JSON.stringify(marshalCreateGrafanaUserRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/cockpit/v1beta1/grafana-users`
+    }, unmarshalGrafanaUser);
+    this.pageOfListGrafanaUsers = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this.client.fetch({
+        method: 'GET',
+        path: `/cockpit/v1beta1/grafana-users`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'login_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+      }, unmarshalListGrafanaUsersResponse);
+    };
+    /**
+     * List grafana users who are able to connect to your grafana instance.
+     *
+     * @param request - The request {@link ListGrafanaUsersRequest}
+     * @returns A Promise of ListGrafanaUsersResponse
+     */
+    this.listGrafanaUsers = function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('grafanaUsers', _this.pageOfListGrafanaUsers, request);
+    };
+    /**
+     * Delete a grafana user from your grafana instance.
+     *
+     * @param request - The request {@link DeleteGrafanaUserRequest}
+     */
+    this.deleteGrafanaUser = request => this.client.fetch({
+      body: JSON.stringify(marshalDeleteGrafanaUserRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/delete`
+    });
+    /**
+     * Reset the Grafana user password from your grafana instance.
+     *
+     * @param request - The request {@link ResetGrafanaUserPasswordRequest}
+     * @returns A Promise of GrafanaUser
+     */
+    this.resetGrafanaUserPassword = request => this.client.fetch({
+      body: JSON.stringify(marshalResetGrafanaUserPasswordRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/cockpit/v1beta1/grafana-users/${validatePathParam('grafanaUserId', request.grafanaUserId)}/reset-password`
+    }, unmarshalGrafanaUser);
+  }
+}
+
+export { API };

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

@@ -0,0 +1,7 @@
+// 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 CockpitStatus}. */
+const COCKPIT_TRANSIENT_STATUSES = ['creating', 'deleting', 'updating'];
+
+export { COCKPIT_TRANSIENT_STATUSES };

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

@@ -0,0 +1,4 @@
+export { API } from './api.gen.js';
+export { COCKPIT_TRANSIENT_STATUSES } from './content.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.

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

@@ -0,0 +1,174 @@
+import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../helpers/marshalling.js';
+
+// This file was automatically generated. DO NOT EDIT.
+const unmarshalContactPointEmail = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ContactPointEmail' failed as data isn't a dictionary.`);
+  }
+  return {
+    to: data.to
+  };
+};
+const unmarshalTokenScopes = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'TokenScopes' failed as data isn't a dictionary.`);
+  }
+  return {
+    queryLogs: data.query_logs,
+    queryMetrics: data.query_metrics,
+    setupAlerts: data.setup_alerts,
+    setupLogsRules: data.setup_logs_rules,
+    setupMetricsRules: data.setup_metrics_rules,
+    writeLogs: data.write_logs,
+    writeMetrics: data.write_metrics
+  };
+};
+const unmarshalCockpitEndpoints = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'CockpitEndpoints' failed as data isn't a dictionary.`);
+  }
+  return {
+    alertmanagerUrl: data.alertmanager_url,
+    grafanaUrl: data.grafana_url,
+    logsUrl: data.logs_url,
+    metricsUrl: data.metrics_url
+  };
+};
+const unmarshalContactPoint = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ContactPoint' failed as data isn't a dictionary.`);
+  }
+  return {
+    email: data.email ? unmarshalContactPointEmail(data.email) : undefined
+  };
+};
+const unmarshalGrafanaUser = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'GrafanaUser' failed as data isn't a dictionary.`);
+  }
+  return {
+    id: data.id,
+    login: data.login,
+    password: data.password,
+    role: data.role
+  };
+};
+const unmarshalToken = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Token' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    projectId: data.project_id,
+    scopes: data.scopes ? unmarshalTokenScopes(data.scopes) : undefined,
+    secretKey: data.secret_key,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalCockpit = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Cockpit' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    endpoints: data.endpoints ? unmarshalCockpitEndpoints(data.endpoints) : undefined,
+    managedAlertsEnabled: data.managed_alerts_enabled,
+    projectId: data.project_id,
+    status: data.status,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalListContactPointsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListContactPointsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    contactPoints: unmarshalArrayOfObject(data.contact_points, unmarshalContactPoint),
+    hasAdditionalContactPoints: data.has_additional_contact_points,
+    hasAdditionalReceivers: data.has_additional_receivers,
+    totalCount: data.total_count
+  };
+};
+const unmarshalListGrafanaUsersResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListGrafanaUsersResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    grafanaUsers: unmarshalArrayOfObject(data.grafana_users, unmarshalGrafanaUser),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListTokensResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListTokensResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    tokens: unmarshalArrayOfObject(data.tokens, unmarshalToken),
+    totalCount: data.total_count
+  };
+};
+const marshalContactPointEmail = (request, defaults) => ({
+  to: request.to
+});
+const marshalContactPoint = (request, defaults) => ({
+  ...resolveOneOf([{
+    param: 'email',
+    value: request.email ? marshalContactPointEmail(request.email) : undefined
+  }])
+});
+const marshalTokenScopes = (request, defaults) => ({
+  query_logs: request.queryLogs,
+  query_metrics: request.queryMetrics,
+  setup_alerts: request.setupAlerts,
+  setup_logs_rules: request.setupLogsRules,
+  setup_metrics_rules: request.setupMetricsRules,
+  write_logs: request.writeLogs,
+  write_metrics: request.writeMetrics
+});
+const marshalActivateCockpitRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalCreateContactPointRequest = (request, defaults) => ({
+  contact_point: request.contactPoint ? marshalContactPoint(request.contactPoint) : undefined,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalCreateGrafanaUserRequest = (request, defaults) => ({
+  login: request.login,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  role: request.role ?? 'unknown_role'
+});
+const marshalCreateTokenRequest = (request, defaults) => ({
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  scopes: request.scopes ? marshalTokenScopes(request.scopes) : undefined
+});
+const marshalDeactivateCockpitRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalDeleteContactPointRequest = (request, defaults) => ({
+  contact_point: request.contactPoint ? marshalContactPoint(request.contactPoint) : undefined,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalDeleteGrafanaUserRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalDisableManagedAlertsRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalEnableManagedAlertsRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalResetCockpitGrafanaRequest = (request, defaults) => ({
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalResetGrafanaUserPasswordRequest = (request, defaults) => ({
+  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 };