@scaleway/sdk 2.26.0 → 2.27.0

package/dist/scw/errors/standard/permissions-denied-error.d.ts

@@ -0,0 +1,23 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+/**
+ * Details of an {@link PermissionsDeniedError} error.
+ *
+ * @public
+ */
+export type PermissionsDeniedErrorDetails = {
+    readonly resource: string;
+    readonly action: string;
+};
+/**
+ * PermissionsDenied error happens when one or many permissions are not accorded to the user making the request.
+ *
+ * @public
+ */
+export declare class PermissionsDeniedError extends ScalewayError {
+    readonly status: number;
+    readonly body: JSONObject;
+    readonly list: PermissionsDeniedErrorDetails[];
+    constructor(status: number, body: JSONObject, list: PermissionsDeniedErrorDetails[]);
+    static fromJSON(status: number, obj: Readonly<JSONObject>): ScalewayError | null;
+}

package/dist/scw/errors/standard/permissions-denied-error.js

@@ -1,45 +1,30 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Details of an {@link PermissionsDeniedError} error.
- *
- * @public
- */
-
-/**
- * Build the default message for {@link PermissionsDeniedError}.
- *
- * @param list - The list of {@link PermissionsDeniedErrorDetails}
- * @returns The error message
- *
- * @internal
- */
-const buildMessage = list => `insufficient permissions: ${list.map(({
-  action,
-  resource
-}) => `${action} ${resource}`).join('; ')}`;
-
-/**
- * PermissionsDenied error happens when one or many permissions are not accorded to the user making the request.
- *
- * @public
- */
+import { isJSONObject } from "../../../helpers/json.js";
+import { ScalewayError } from "../scw-error.js";
+const buildMessage = (list) => `insufficient permissions: ${list.map(({ action, resource }) => `${action} ${resource}`).join("; ")}`;
 class PermissionsDeniedError extends ScalewayError {
   constructor(status, body, list) {
     super(status, body, buildMessage(list));
     this.status = status;
     this.body = body;
     this.list = list;
-    this.name = 'PermissionsDeniedError';
+    this.name = "PermissionsDeniedError";
   }
   static fromJSON(status, obj) {
-    if (!Array.isArray(obj.details)) return null;
-    return new PermissionsDeniedError(status, obj, obj.details.reduce((list, detail) => isJSONObject(detail) && typeof detail.resource === 'string' && typeof detail.action === 'string' ? list.concat({
-      action: detail.action,
-      resource: detail.resource
-    }) : list, []));
+    if (!Array.isArray(obj.details))
+      return null;
+    return new PermissionsDeniedError(
+      status,
+      obj,
+      obj.details.reduce(
+        (list, detail) => isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.action === "string" ? list.concat({
+          action: detail.action,
+          resource: detail.resource
+        }) : list,
+        []
+      )
+    );
   }
 }
-
-export { PermissionsDeniedError };
+export {
+  PermissionsDeniedError
+};

package/dist/scw/errors/standard/precondition-failed-error.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const scwError = require("../scw-error.cjs");
+const buildMessage = (precondition, helpMessage) => {
+  let message = `precondition failed: ${precondition}`;
+  if (typeof helpMessage === "string" && helpMessage.length > 0) {
+    message = message.concat(", ", helpMessage);
+  }
+  return message;
+};
+class PreconditionFailedError extends scwError.ScalewayError {
+  constructor(status, body, precondition, helpMessage) {
+    super(status, body, buildMessage(precondition, helpMessage));
+    this.status = status;
+    this.body = body;
+    this.precondition = precondition;
+    this.helpMessage = helpMessage;
+    this.name = "PreconditionFailedError";
+  }
+  static fromJSON(status, obj) {
+    if (typeof obj.precondition !== "string" || typeof obj.help_message !== "string") {
+      return null;
+    }
+    return new PreconditionFailedError(
+      status,
+      obj,
+      obj.precondition,
+      obj.help_message
+    );
+  }
+}
+exports.PreconditionFailedError = PreconditionFailedError;

package/dist/scw/errors/standard/precondition-failed-error.d.ts

@@ -0,0 +1,15 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+/**
+ * PreconditionFailed error is used when a precondition is not respected.
+ *
+ * @public
+ */
+export declare class PreconditionFailedError extends ScalewayError {
+    readonly status: number;
+    readonly body: JSONObject;
+    readonly precondition: string;
+    readonly helpMessage: string;
+    constructor(status: number, body: JSONObject, precondition: string, helpMessage: string);
+    static fromJSON(status: number, obj: Readonly<JSONObject>): PreconditionFailedError | null;
+}

package/dist/scw/errors/standard/precondition-failed-error.js

@@ -1,27 +1,11 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Build the default message for {@link PreconditionFailedError}.
- *
- * @param precondition - The precondition
- * @param helpMessage - The message which should help the user to fix the root cause
- * @returns The error message
- *
- * @internal
- */
+import { ScalewayError } from "../scw-error.js";
 const buildMessage = (precondition, helpMessage) => {
   let message = `precondition failed: ${precondition}`;
-  if (typeof helpMessage === 'string' && helpMessage.length > 0) {
-    message = message.concat(', ', helpMessage);
+  if (typeof helpMessage === "string" && helpMessage.length > 0) {
+    message = message.concat(", ", helpMessage);
   }
   return message;
 };
-
-/**
- * PreconditionFailed error is used when a precondition is not respected.
- *
- * @public
- */
 class PreconditionFailedError extends ScalewayError {
   constructor(status, body, precondition, helpMessage) {
     super(status, body, buildMessage(precondition, helpMessage));
@@ -29,14 +13,20 @@ class PreconditionFailedError extends ScalewayError {
     this.body = body;
     this.precondition = precondition;
     this.helpMessage = helpMessage;
-    this.name = 'PreconditionFailedError';
+    this.name = "PreconditionFailedError";
   }
   static fromJSON(status, obj) {
-    if (typeof obj.precondition !== 'string' || typeof obj.help_message !== 'string') {
+    if (typeof obj.precondition !== "string" || typeof obj.help_message !== "string") {
       return null;
     }
-    return new PreconditionFailedError(status, obj, obj.precondition, obj.help_message);
+    return new PreconditionFailedError(
+      status,
+      obj,
+      obj.precondition,
+      obj.help_message
+    );
   }
 }
-
-export { PreconditionFailedError };
+export {
+  PreconditionFailedError
+};

package/dist/scw/errors/standard/quotas-exceeded-error.cjs

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const json = require("../../../helpers/json.cjs");
+const scwError = require("../scw-error.cjs");
+const buildMessage = (list) => `quota(s) exceeded: ${list.map((details) => {
+  const message = `${details.resource} has reached its quota (${details.current}/${details.quota})`;
+  return details.scope ? `${message} for ${details.scope.kind} '${details.scope.id}'` : message;
+}).join("; ")}`;
+const buildScope = (detail) => {
+  if (typeof detail.organization_id === "string" && detail.organization_id.length) {
+    return { id: detail.organization_id, kind: "organization" };
+  }
+  if (typeof detail.project_id === "string" && detail.project_id.length) {
+    return { id: detail.project_id, kind: "project" };
+  }
+  return void 0;
+};
+class QuotasExceededError extends scwError.ScalewayError {
+  constructor(status, body, list) {
+    super(status, body, buildMessage(list));
+    this.status = status;
+    this.body = body;
+    this.list = list;
+    this.name = "QuotasExceededError";
+  }
+  static fromJSON(status, obj) {
+    if (!Array.isArray(obj.details))
+      return null;
+    return new QuotasExceededError(
+      status,
+      obj,
+      obj.details.reduce(
+        (list, detail) => json.isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.quota === "number" && typeof detail.current === "number" ? list.concat({
+          current: detail.current,
+          quota: detail.quota,
+          resource: detail.resource,
+          scope: buildScope(detail)
+        }) : list,
+        []
+      )
+    );
+  }
+}
+exports.QuotasExceededError = QuotasExceededError;

package/dist/scw/errors/standard/quotas-exceeded-error.d.ts

@@ -0,0 +1,34 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+/**
+ * Scope of an {@link QuotasExceededErrorDetails} error.
+ *
+ * @public
+ */
+export type QuotasExceededErrorScope = {
+    kind: 'organization' | 'project';
+    id: string;
+};
+/**
+ * Details of an {@link QuotasExceededError} error.
+ *
+ * @public
+ */
+export type QuotasExceededErrorDetails = {
+    readonly resource: string;
+    readonly quota: number;
+    readonly current: number;
+    readonly scope?: QuotasExceededErrorScope;
+};
+/**
+ * QuotasExceeded error happens when one or many resource exceed quotas during the creation of a resource.
+ *
+ * @public
+ */
+export declare class QuotasExceededError extends ScalewayError {
+    readonly status: number;
+    readonly body: JSONObject;
+    readonly list: QuotasExceededErrorDetails[];
+    constructor(status: number, body: JSONObject, list: QuotasExceededErrorDetails[]);
+    static fromJSON(status: number, obj: Readonly<JSONObject>): QuotasExceededError | null;
+}

package/dist/scw/errors/standard/quotas-exceeded-error.js

@@ -1,68 +1,44 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Scope of an {@link QuotasExceededErrorDetails} error.
- *
- * @public
- */
-
-/**
- * Details of an {@link QuotasExceededError} error.
- *
- * @public
- */
-
-/**
- * Build the default message for {@link QuotasExceededError}.
- *
- * @param list - The list of {@link QuotasExceededErrorDetails}
- * @returns The error message
- *
- * @internal
- */
-const buildMessage = list => `quota(s) exceeded: ${list.map(details => {
+import { isJSONObject } from "../../../helpers/json.js";
+import { ScalewayError } from "../scw-error.js";
+const buildMessage = (list) => `quota(s) exceeded: ${list.map((details) => {
   const message = `${details.resource} has reached its quota (${details.current}/${details.quota})`;
   return details.scope ? `${message} for ${details.scope.kind} '${details.scope.id}'` : message;
-}).join('; ')}`;
-const buildScope = detail => {
-  if (typeof detail.organization_id === 'string' && detail.organization_id.length) {
-    return {
-      id: detail.organization_id,
-      kind: 'organization'
-    };
+}).join("; ")}`;
+const buildScope = (detail) => {
+  if (typeof detail.organization_id === "string" && detail.organization_id.length) {
+    return { id: detail.organization_id, kind: "organization" };
   }
-  if (typeof detail.project_id === 'string' && detail.project_id.length) {
-    return {
-      id: detail.project_id,
-      kind: 'project'
-    };
+  if (typeof detail.project_id === "string" && detail.project_id.length) {
+    return { id: detail.project_id, kind: "project" };
   }
-  return undefined;
+  return void 0;
 };
-
-/**
- * QuotasExceeded error happens when one or many resource exceed quotas during the creation of a resource.
- *
- * @public
- */
 class QuotasExceededError extends ScalewayError {
   constructor(status, body, list) {
     super(status, body, buildMessage(list));
     this.status = status;
     this.body = body;
     this.list = list;
-    this.name = 'QuotasExceededError';
+    this.name = "QuotasExceededError";
   }
   static fromJSON(status, obj) {
-    if (!Array.isArray(obj.details)) return null;
-    return new QuotasExceededError(status, obj, obj.details.reduce((list, detail) => isJSONObject(detail) && typeof detail.resource === 'string' && typeof detail.quota === 'number' && typeof detail.current === 'number' ? list.concat({
-      current: detail.current,
-      quota: detail.quota,
-      resource: detail.resource,
-      scope: buildScope(detail)
-    }) : list, []));
+    if (!Array.isArray(obj.details))
+      return null;
+    return new QuotasExceededError(
+      status,
+      obj,
+      obj.details.reduce(
+        (list, detail) => isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.quota === "number" && typeof detail.current === "number" ? list.concat({
+          current: detail.current,
+          quota: detail.quota,
+          resource: detail.resource,
+          scope: buildScope(detail)
+        }) : list,
+        []
+      )
+    );
   }
 }
-
-export { QuotasExceededError };
+export {
+  QuotasExceededError
+};

package/dist/scw/errors/standard/resource-expired-error.cjs

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const scwError = require("../scw-error.cjs");
+class ResourceExpiredError extends scwError.ScalewayError {
+  constructor(status, body, resource, resourceId, expiredSince) {
+    super(
+      status,
+      body,
+      `resource ${resource} with ID ${resourceId} expired since ${expiredSince.toISOString()}`
+    );
+    this.status = status;
+    this.body = body;
+    this.resource = resource;
+    this.resourceId = resourceId;
+    this.expiredSince = expiredSince;
+    this.name = "ResourceExpiredError";
+  }
+  static fromJSON(status, obj) {
+    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.expired_since !== "string") {
+      return null;
+    }
+    return new ResourceExpiredError(
+      status,
+      obj,
+      obj.resource,
+      obj.resource_id,
+      new Date(obj.expired_since)
+    );
+  }
+}
+exports.ResourceExpiredError = ResourceExpiredError;

package/dist/scw/errors/standard/resource-expired-error.d.ts

@@ -0,0 +1,16 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+/**
+ * ResourceExpired error happens when trying to access a resource that has expired.
+ *
+ * @public
+ */
+export declare class ResourceExpiredError extends ScalewayError {
+    readonly status: number;
+    readonly body: JSONObject;
+    readonly resource: string;
+    readonly resourceId: string;
+    readonly expiredSince: Date;
+    constructor(status: number, body: JSONObject, resource: string, resourceId: string, expiredSince: Date);
+    static fromJSON(status: number, obj: Readonly<JSONObject>): ResourceExpiredError | null;
+}

package/dist/scw/errors/standard/resource-expired-error.js

@@ -1,26 +1,31 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * ResourceExpired error happens when trying to access a resource that has expired.
- *
- * @public
- */
+import { ScalewayError } from "../scw-error.js";
 class ResourceExpiredError extends ScalewayError {
   constructor(status, body, resource, resourceId, expiredSince) {
-    super(status, body, `resource ${resource} with ID ${resourceId} expired since ${expiredSince.toISOString()}`);
+    super(
+      status,
+      body,
+      `resource ${resource} with ID ${resourceId} expired since ${expiredSince.toISOString()}`
+    );
     this.status = status;
     this.body = body;
     this.resource = resource;
     this.resourceId = resourceId;
     this.expiredSince = expiredSince;
-    this.name = 'ResourceExpiredError';
+    this.name = "ResourceExpiredError";
   }
   static fromJSON(status, obj) {
-    if (typeof obj.resource !== 'string' || typeof obj.resource_id !== 'string' || typeof obj.expired_since !== 'string') {
+    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.expired_since !== "string") {
       return null;
     }
-    return new ResourceExpiredError(status, obj, obj.resource, obj.resource_id, new Date(obj.expired_since));
+    return new ResourceExpiredError(
+      status,
+      obj,
+      obj.resource,
+      obj.resource_id,
+      new Date(obj.expired_since)
+    );
   }
 }
-
-export { ResourceExpiredError };
+export {
+  ResourceExpiredError
+};

package/dist/scw/errors/standard/resource-locked-error.cjs

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const scwError = require("../scw-error.cjs");
+class ResourceLockedError extends scwError.ScalewayError {
+  constructor(status, body, resource, resourceId) {
+    super(status, body, `resource ${resource} with ID ${resourceId} is locked`);
+    this.status = status;
+    this.body = body;
+    this.resource = resource;
+    this.resourceId = resourceId;
+    this.name = "ResourceLockedError";
+  }
+  static fromJSON(status, obj) {
+    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") {
+      return null;
+    }
+    return new ResourceLockedError(status, obj, obj.resource, obj.resource_id);
+  }
+}
+exports.ResourceLockedError = ResourceLockedError;

package/dist/scw/errors/standard/resource-locked-error.d.ts

@@ -0,0 +1,15 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+/**
+ * ResourceLocked error happens when a resource is locked by trust and safety.
+ *
+ * @public
+ */
+export declare class ResourceLockedError extends ScalewayError {
+    readonly status: number;
+    readonly body: JSONObject;
+    readonly resource: string;
+    readonly resourceId: string;
+    constructor(status: number, body: JSONObject, resource: string, resourceId: string);
+    static fromJSON(status: number, obj: Readonly<JSONObject>): ResourceLockedError | null;
+}

package/dist/scw/errors/standard/resource-locked-error.js

@@ -1,10 +1,4 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * ResourceLocked error happens when a resource is locked by trust and safety.
- *
- * @public
- */
+import { ScalewayError } from "../scw-error.js";
 class ResourceLockedError extends ScalewayError {
   constructor(status, body, resource, resourceId) {
     super(status, body, `resource ${resource} with ID ${resourceId} is locked`);
@@ -12,14 +6,15 @@ class ResourceLockedError extends ScalewayError {
     this.body = body;
     this.resource = resource;
     this.resourceId = resourceId;
-    this.name = 'ResourceLockedError';
+    this.name = "ResourceLockedError";
   }
   static fromJSON(status, obj) {
-    if (typeof obj.resource !== 'string' || typeof obj.resource_id !== 'string') {
+    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") {
       return null;
     }
     return new ResourceLockedError(status, obj, obj.resource, obj.resource_id);
   }
 }
-
-export { ResourceLockedError };
+export {
+  ResourceLockedError
+};

package/dist/scw/errors/standard/resource-not-found-error.cjs

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const scwError = require("../scw-error.cjs");
+class ResourceNotFoundError extends scwError.ScalewayError {
+  constructor(status, body, resource, resourceId) {
+    super(
+      status,
+      body,
+      `resource ${resource} with ID ${resourceId} is not found`
+    );
+    this.status = status;
+    this.body = body;
+    this.resource = resource;
+    this.resourceId = resourceId;
+    this.name = "ResourceNotFoundError";
+  }
+  static fromJSON(status, obj) {
+    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") {
+      return null;
+    }
+    return new ResourceNotFoundError(status, obj, obj.resource, obj.resource_id);
+  }
+}
+exports.ResourceNotFoundError = ResourceNotFoundError;

package/dist/scw/errors/standard/resource-not-found-error.d.ts

@@ -0,0 +1,15 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+/**
+ * ResourceNotFound error happens when getting a resource that does not exist anymore.
+ *
+ * @public
+ */
+export declare class ResourceNotFoundError extends ScalewayError {
+    readonly status: number;
+    readonly body: JSONObject;
+    readonly resource: string;
+    readonly resourceId: string;
+    constructor(status: number, body: JSONObject, resource: string, resourceId: string);
+    static fromJSON(status: number, obj: Readonly<JSONObject>): ResourceNotFoundError | null;
+}

package/dist/scw/errors/standard/resource-not-found-error.js

@@ -1,25 +1,24 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * ResourceNotFound error happens when getting a resource that does not exist anymore.
- *
- * @public
- */
+import { ScalewayError } from "../scw-error.js";
 class ResourceNotFoundError extends ScalewayError {
   constructor(status, body, resource, resourceId) {
-    super(status, body, `resource ${resource} with ID ${resourceId} is not found`);
+    super(
+      status,
+      body,
+      `resource ${resource} with ID ${resourceId} is not found`
+    );
     this.status = status;
     this.body = body;
     this.resource = resource;
     this.resourceId = resourceId;
-    this.name = 'ResourceNotFoundError';
+    this.name = "ResourceNotFoundError";
   }
   static fromJSON(status, obj) {
-    if (typeof obj.resource !== 'string' || typeof obj.resource_id !== 'string') {
+    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") {
       return null;
     }
     return new ResourceNotFoundError(status, obj, obj.resource, obj.resource_id);
   }
 }
-
-export { ResourceNotFoundError };
+export {
+  ResourceNotFoundError
+};