@scaleway/sdk 2.26.0 → 2.27.0

package/dist/api/test/v1/api.gen.cjs

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends api.API {
+  /**
+   * Register a user. Register a human and return a access-key and a secret-key
+   * that must be used in all other commands.
+   *
+   * Hint: you can use other test commands by setting the SCW_SECRET_KEY env
+   * variable.
+   *
+   * @param request - The request {@link RegisterRequest}
+   * @returns A Promise of RegisterResponse
+   */
+  register = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalRegisterRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/register`
+    },
+    marshalling_gen.unmarshalRegisterResponse
+  );
+  pageOfListHumans = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/test/v1/humans`,
+      urlParams: marshalling.urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId]
+      )
+    },
+    marshalling_gen.unmarshalListHumansResponse
+  );
+  /**
+   * List all your humans.
+   *
+   * @param request - The request {@link ListHumansRequest}
+   * @returns A Promise of ListHumansResponse
+   */
+  listHumans = (request = {}) => resourcePaginator.enrichForPagination("humans", this.pageOfListHumans, request);
+  /**
+   * Get human details. Get the human details associated with the given id.
+   *
+   * @param request - The request {@link GetHumanRequest}
+   * @returns A Promise of Human
+   */
+  getHuman = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/test/v1/humans/${marshalling.validatePathParam("humanId", request.humanId)}`
+    },
+    marshalling_gen.unmarshalHuman
+  );
+  /**
+   * Waits for {@link Human} to be in a final state.
+   *
+   * @param request - The request {@link GetHumanRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Human
+   */
+  waitForHuman = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.HUMAN_TRANSIENT_STATUSES.includes(res.status))),
+    this.getHuman,
+    request,
+    options
+  );
+  /**
+   * Create a new human.
+   *
+   * @param request - The request {@link CreateHumanRequest}
+   * @returns A Promise of Human
+   */
+  createHuman = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateHumanRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/humans`
+    },
+    marshalling_gen.unmarshalHuman
+  );
+  /**
+   * Update an existing human. Update the human associated with the given id.
+   *
+   * @param request - The request {@link UpdateHumanRequest}
+   * @returns A Promise of Human
+   */
+  updateHuman = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateHumanRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/test/v1/humans/${marshalling.validatePathParam("humanId", request.humanId)}`
+    },
+    marshalling_gen.unmarshalHuman
+  );
+  /**
+   * Delete an existing human. Delete the human associated with the given id.
+   *
+   * @param request - The request {@link DeleteHumanRequest}
+   * @returns A Promise of Human
+   */
+  deleteHuman = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/test/v1/humans/${marshalling.validatePathParam("humanId", request.humanId)}`
+    },
+    marshalling_gen.unmarshalHuman
+  );
+  /**
+   * Start a 1h running for the given human. Start a one hour running for the
+   * given human.
+   *
+   * @param request - The request {@link RunHumanRequest}
+   * @returns A Promise of Human
+   */
+  runHuman = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/humans/${marshalling.validatePathParam("humanId", request.humanId)}/run`
+    },
+    marshalling_gen.unmarshalHuman
+  );
+  /**
+   * Make a human smoke.
+   *
+   * @deprecated
+   * @param request - The request {@link SmokeHumanRequest}
+   * @returns A Promise of Human
+   */
+  smokeHuman = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/humans/${marshalling.validatePathParam("humanId", request.humanId)}/smoke`
+    },
+    marshalling_gen.unmarshalHuman
+  );
+}
+exports.API = API;

package/dist/api/test/v1/api.gen.d.ts

@@ -0,0 +1,84 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { WaitForOptions } from '../../../bridge';
+import type { CreateHumanRequest, DeleteHumanRequest, GetHumanRequest, Human, ListHumansRequest, ListHumansResponse, RegisterRequest, RegisterResponse, RunHumanRequest, SmokeHumanRequest, UpdateHumanRequest } from './types.gen';
+/**
+ * Fake API.
+ *
+ * No Auth Service for end-to-end testing.
+ */
+export declare class API extends ParentAPI {
+    /**
+     * Register a user. Register a human and return a access-key and a secret-key
+     * that must be used in all other commands.
+     *
+     * Hint: you can use other test commands by setting the SCW_SECRET_KEY env
+     * variable.
+     *
+     * @param request - The request {@link RegisterRequest}
+     * @returns A Promise of RegisterResponse
+     */
+    register: (request: Readonly<RegisterRequest>) => Promise<RegisterResponse>;
+    protected pageOfListHumans: (request?: Readonly<ListHumansRequest>) => Promise<ListHumansResponse>;
+    /**
+     * List all your humans.
+     *
+     * @param request - The request {@link ListHumansRequest}
+     * @returns A Promise of ListHumansResponse
+     */
+    listHumans: (request?: Readonly<ListHumansRequest>) => Promise<ListHumansResponse> & {
+        all: () => Promise<Human[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Human[], void, void>;
+    };
+    /**
+     * Get human details. Get the human details associated with the given id.
+     *
+     * @param request - The request {@link GetHumanRequest}
+     * @returns A Promise of Human
+     */
+    getHuman: (request: Readonly<GetHumanRequest>) => Promise<Human>;
+    /**
+     * Waits for {@link Human} to be in a final state.
+     *
+     * @param request - The request {@link GetHumanRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Human
+     */
+    waitForHuman: (request: Readonly<GetHumanRequest>, options?: Readonly<WaitForOptions<Human>>) => Promise<Human>;
+    /**
+     * Create a new human.
+     *
+     * @param request - The request {@link CreateHumanRequest}
+     * @returns A Promise of Human
+     */
+    createHuman: (request: Readonly<CreateHumanRequest>) => Promise<Human>;
+    /**
+     * Update an existing human. Update the human associated with the given id.
+     *
+     * @param request - The request {@link UpdateHumanRequest}
+     * @returns A Promise of Human
+     */
+    updateHuman: (request: Readonly<UpdateHumanRequest>) => Promise<Human>;
+    /**
+     * Delete an existing human. Delete the human associated with the given id.
+     *
+     * @param request - The request {@link DeleteHumanRequest}
+     * @returns A Promise of Human
+     */
+    deleteHuman: (request: Readonly<DeleteHumanRequest>) => Promise<Human>;
+    /**
+     * Start a 1h running for the given human. Start a one hour running for the
+     * given human.
+     *
+     * @param request - The request {@link RunHumanRequest}
+     * @returns A Promise of Human
+     */
+    runHuman: (request: Readonly<RunHumanRequest>) => Promise<Human>;
+    /**
+     * Make a human smoke.
+     *
+     * @deprecated
+     * @param request - The request {@link SmokeHumanRequest}
+     * @returns A Promise of Human
+     */
+    smokeHuman: (request: Readonly<SmokeHumanRequest>) => Promise<Human>;
+}

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

@@ -1,21 +1,12 @@
-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 { HUMAN_TRANSIENT_STATUSES } from './content.gen.js';
-import { marshalRegisterRequest, unmarshalRegisterResponse, unmarshalListHumansResponse, unmarshalHuman, marshalCreateHumanRequest, marshalUpdateHumanRequest } 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.
+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 { HUMAN_TRANSIENT_STATUSES } from "./content.gen.js";
+import { marshalRegisterRequest, unmarshalRegisterResponse, unmarshalListHumansResponse, unmarshalHuman, marshalCreateHumanRequest, marshalUpdateHumanRequest } from "./marshalling.gen.js";
 const jsonContentHeaders = {
-  'Content-Type': 'application/json; charset=utf-8'
+  "Content-Type": "application/json; charset=utf-8"
 };
-
-/**
- * Fake API.
- *
- * No Auth Service for end-to-end testing.
- */
 class API extends API$1 {
   /**
    * Register a user. Register a human and return a access-key and a secret-key
@@ -27,37 +18,54 @@ class API extends API$1 {
    * @param request - The request {@link RegisterRequest}
    * @returns A Promise of RegisterResponse
    */
-  register = request => this.client.fetch({
-    body: JSON.stringify(marshalRegisterRequest(request, this.client.settings)),
-    headers: jsonContentHeaders,
-    method: 'POST',
-    path: `/test/v1/register`
-  }, unmarshalRegisterResponse);
-  pageOfListHumans = (request = {}) => this.client.fetch({
-    method: 'GET',
-    path: `/test/v1/humans`,
-    urlParams: urlParams(['order_by', request.orderBy], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId])
-  }, unmarshalListHumansResponse);
-
+  register = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalRegisterRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/register`
+    },
+    unmarshalRegisterResponse
+  );
+  pageOfListHumans = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/test/v1/humans`,
+      urlParams: urlParams(
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId]
+      )
+    },
+    unmarshalListHumansResponse
+  );
   /**
    * List all your humans.
    *
    * @param request - The request {@link ListHumansRequest}
    * @returns A Promise of ListHumansResponse
    */
-  listHumans = (request = {}) => enrichForPagination('humans', this.pageOfListHumans, request);
-
+  listHumans = (request = {}) => enrichForPagination("humans", this.pageOfListHumans, request);
   /**
    * Get human details. Get the human details associated with the given id.
    *
    * @param request - The request {@link GetHumanRequest}
    * @returns A Promise of Human
    */
-  getHuman = request => this.client.fetch({
-    method: 'GET',
-    path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
-  }, unmarshalHuman);
-
+  getHuman = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/test/v1/humans/${validatePathParam("humanId", request.humanId)}`
+    },
+    unmarshalHuman
+  );
   /**
    * Waits for {@link Human} to be in a final state.
    *
@@ -65,45 +73,59 @@ class API extends API$1 {
    * @param options - The waiting options
    * @returns A Promise of Human
    */
-  waitForHuman = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HUMAN_TRANSIENT_STATUSES.includes(res.status))), this.getHuman, request, options);
-
+  waitForHuman = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!HUMAN_TRANSIENT_STATUSES.includes(res.status))),
+    this.getHuman,
+    request,
+    options
+  );
   /**
    * Create a new human.
    *
    * @param request - The request {@link CreateHumanRequest}
    * @returns A Promise of Human
    */
-  createHuman = request => this.client.fetch({
-    body: JSON.stringify(marshalCreateHumanRequest(request, this.client.settings)),
-    headers: jsonContentHeaders,
-    method: 'POST',
-    path: `/test/v1/humans`
-  }, unmarshalHuman);
-
+  createHuman = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalCreateHumanRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/humans`
+    },
+    unmarshalHuman
+  );
   /**
    * Update an existing human. Update the human associated with the given id.
    *
    * @param request - The request {@link UpdateHumanRequest}
    * @returns A Promise of Human
    */
-  updateHuman = request => this.client.fetch({
-    body: JSON.stringify(marshalUpdateHumanRequest(request, this.client.settings)),
-    headers: jsonContentHeaders,
-    method: 'PATCH',
-    path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
-  }, unmarshalHuman);
-
+  updateHuman = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateHumanRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/test/v1/humans/${validatePathParam("humanId", request.humanId)}`
+    },
+    unmarshalHuman
+  );
   /**
    * Delete an existing human. Delete the human associated with the given id.
    *
    * @param request - The request {@link DeleteHumanRequest}
    * @returns A Promise of Human
    */
-  deleteHuman = request => this.client.fetch({
-    method: 'DELETE',
-    path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}`
-  }, unmarshalHuman);
-
+  deleteHuman = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/test/v1/humans/${validatePathParam("humanId", request.humanId)}`
+    },
+    unmarshalHuman
+  );
   /**
    * Start a 1h running for the given human. Start a one hour running for the
    * given human.
@@ -111,13 +133,15 @@ class API extends API$1 {
    * @param request - The request {@link RunHumanRequest}
    * @returns A Promise of Human
    */
-  runHuman = request => this.client.fetch({
-    body: '{}',
-    headers: jsonContentHeaders,
-    method: 'POST',
-    path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}/run`
-  }, unmarshalHuman);
-
+  runHuman = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/humans/${validatePathParam("humanId", request.humanId)}/run`
+    },
+    unmarshalHuman
+  );
   /**
    * Make a human smoke.
    *
@@ -125,12 +149,16 @@ class API extends API$1 {
    * @param request - The request {@link SmokeHumanRequest}
    * @returns A Promise of Human
    */
-  smokeHuman = request => this.client.fetch({
-    body: '{}',
-    headers: jsonContentHeaders,
-    method: 'POST',
-    path: `/test/v1/humans/${validatePathParam('humanId', request.humanId)}/smoke`
-  }, unmarshalHuman);
+  smokeHuman = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/test/v1/humans/${validatePathParam("humanId", request.humanId)}/smoke`
+    },
+    unmarshalHuman
+  );
 }
-
-export { API };
+export {
+  API
+};

package/dist/api/test/v1/content.gen.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const HUMAN_TRANSIENT_STATUSES = ["running"];
+exports.HUMAN_TRANSIENT_STATUSES = HUMAN_TRANSIENT_STATUSES;

package/dist/api/test/v1/content.gen.d.ts

@@ -0,0 +1,3 @@
+import type { HumanStatus } from './types.gen';
+/** Lists transient statutes of the enum {@link HumanStatus}. */
+export declare const HUMAN_TRANSIENT_STATUSES: HumanStatus[];

package/dist/api/test/v1/content.gen.js

@@ -1,7 +1,4 @@
-// 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 HumanStatus}. */
-const HUMAN_TRANSIENT_STATUSES = ['running'];
-
-export { HUMAN_TRANSIENT_STATUSES };
+const HUMAN_TRANSIENT_STATUSES = ["running"];
+export {
+  HUMAN_TRANSIENT_STATUSES
+};

package/dist/api/test/v1/index.gen.cjs

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const content_gen = require("./content.gen.cjs");
+exports.API = api_gen.API;
+exports.HUMAN_TRANSIENT_STATUSES = content_gen.HUMAN_TRANSIENT_STATUSES;

package/dist/api/test/v1/index.gen.d.ts

@@ -0,0 +1,3 @@
+export { API } from './api.gen';
+export * from './content.gen';
+export type { CreateHumanRequest, DeleteHumanRequest, EyeColors, GetHumanRequest, Human, HumanStatus, ListHumansRequest, ListHumansRequestOrderBy, ListHumansResponse, RegisterRequest, RegisterResponse, RunHumanRequest, SmokeHumanRequest, UpdateHumanRequest, } from './types.gen';

package/dist/api/test/v1/index.gen.js

@@ -1,5 +1,6 @@
-export { API } from './api.gen.js';
-export { HUMAN_TRANSIENT_STATUSES } from './content.gen.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
+import { API } from "./api.gen.js";
+import { HUMAN_TRANSIENT_STATUSES } from "./content.gen.js";
+export {
+  API,
+  HUMAN_TRANSIENT_STATUSES
+};

package/dist/api/test/v1/marshalling.gen.cjs

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const json = require("../../../helpers/json.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const unmarshalHuman = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Human' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    altitudeInMeter: data.altitude_in_meter,
+    altitudeInMillimeter: data.altitude_in_millimeter,
+    createdAt: marshalling.unmarshalDate(data.created_at),
+    eyesColor: data.eyes_color,
+    fingersCount: data.fingers_count,
+    hairCount: data.hair_count,
+    height: data.height,
+    id: data.id,
+    isHappy: data.is_happy,
+    name: data.name,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    shoeSize: data.shoe_size,
+    status: data.status,
+    updatedAt: marshalling.unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalListHumansResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListHumansResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    humans: marshalling.unmarshalArrayOfObject(data.humans, unmarshalHuman),
+    totalCount: data.total_count
+  };
+};
+const unmarshalRegisterResponse = (data) => {
+  if (!json.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'RegisterResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    accessKey: data.access_key,
+    secretKey: data.secret_key
+  };
+};
+const marshalCreateHumanRequest = (request, defaults) => ({
+  altitude_in_meter: request.altitudeInMeter,
+  altitude_in_millimeter: request.altitudeInMillimeter,
+  eyes_color: request.eyesColor,
+  fingers_count: request.fingersCount,
+  hair_count: request.hairCount,
+  height: request.height,
+  is_happy: request.isHappy,
+  name: request.name,
+  shoe_size: request.shoeSize,
+  ...marshalling.resolveOneOf([
+    {
+      default: defaults.defaultProjectId,
+      param: "project_id",
+      value: request.projectId
+    },
+    {
+      default: defaults.defaultOrganizationId,
+      param: "organization_id",
+      value: request.organizationId
+    }
+  ])
+});
+const marshalRegisterRequest = (request, defaults) => ({
+  username: request.username
+});
+const marshalUpdateHumanRequest = (request, defaults) => ({
+  altitude_in_meter: request.altitudeInMeter,
+  altitude_in_millimeter: request.altitudeInMillimeter,
+  eyes_color: request.eyesColor,
+  fingers_count: request.fingersCount,
+  hair_count: request.hairCount,
+  height: request.height,
+  is_happy: request.isHappy,
+  name: request.name,
+  shoe_size: request.shoeSize
+});
+exports.marshalCreateHumanRequest = marshalCreateHumanRequest;
+exports.marshalRegisterRequest = marshalRegisterRequest;
+exports.marshalUpdateHumanRequest = marshalUpdateHumanRequest;
+exports.unmarshalHuman = unmarshalHuman;
+exports.unmarshalListHumansResponse = unmarshalListHumansResponse;
+exports.unmarshalRegisterResponse = unmarshalRegisterResponse;

package/dist/api/test/v1/marshalling.gen.d.ts

@@ -0,0 +1,8 @@
+import type { DefaultValues } from '../../../bridge';
+import type { CreateHumanRequest, Human, ListHumansResponse, RegisterRequest, RegisterResponse, UpdateHumanRequest } from './types.gen';
+export declare const unmarshalHuman: (data: unknown) => Human;
+export declare const unmarshalListHumansResponse: (data: unknown) => ListHumansResponse;
+export declare const unmarshalRegisterResponse: (data: unknown) => RegisterResponse;
+export declare const marshalCreateHumanRequest: (request: CreateHumanRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalRegisterRequest: (request: RegisterRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateHumanRequest: (request: UpdateHumanRequest, defaults: DefaultValues) => Record<string, unknown>;