@scaleway/sdk 2.74.0 → 2.75.0

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

@@ -1,163 +0,0 @@
-import "../../../client/dist/internal/logger/index.js";
-import { waitForResource } from "../../../client/dist/internal/async/interval-retrier.js";
-import { API as API$1 } from "../../../client/dist/scw/api.js";
-import { urlParams, validatePathParam } from "../../../client/dist/helpers/marshalling.js";
-import "../../../client/dist/vendor/base64/index.js";
-import { enrichForPagination } from "../../../client/dist/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"
-};
-class API extends API$1 {
-  /**
-     * 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(
-        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);
-  /**
-   * 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
-  );
-  /**
-   * 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) => 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
-  );
-  /**
-   * 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
-  );
-  /**
-   * 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
-  );
-  /**
-   * 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/${validatePathParam("humanId", request.humanId)}/run`
-    },
-    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/${validatePathParam("humanId", request.humanId)}/smoke`
-    },
-    unmarshalHuman
-  );
-}
-export {
-  API
-};

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

@@ -1,4 +0,0 @@
-"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

@@ -1,3 +0,0 @@
-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,4 +0,0 @@
-const HUMAN_TRANSIENT_STATUSES = ["running"];
-export {
-  HUMAN_TRANSIENT_STATUSES
-};

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

@@ -1,6 +0,0 @@
-"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

@@ -1,3 +0,0 @@
-export { API } from './api.gen.js';
-export * from './content.gen.js';
-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,6 +0,0 @@
-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

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-require("../../../client/dist/internal/logger/index.cjs");
-const json = require("../../../client/dist/helpers/json.cjs");
-const marshalling = require("../../../client/dist/helpers/marshalling.cjs");
-require("../../../client/dist/vendor/base64/index.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

@@ -1,8 +0,0 @@
-import type { DefaultValues } from '@scaleway/sdk-client';
-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>;

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

@@ -1,95 +0,0 @@
-import "../../../client/dist/internal/logger/index.js";
-import { isJSONObject } from "../../../client/dist/helpers/json.js";
-import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from "../../../client/dist/helpers/marshalling.js";
-import "../../../client/dist/vendor/base64/index.js";
-const unmarshalHuman = (data) => {
-  if (!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: 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: unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalListHumansResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListHumansResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    humans: unmarshalArrayOfObject(data.humans, unmarshalHuman),
-    totalCount: data.total_count
-  };
-};
-const unmarshalRegisterResponse = (data) => {
-  if (!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,
-  ...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
-});
-export {
-  marshalCreateHumanRequest,
-  marshalRegisterRequest,
-  marshalUpdateHumanRequest,
-  unmarshalHuman,
-  unmarshalListHumansResponse,
-  unmarshalRegisterResponse
-};

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

@@ -1,102 +0,0 @@
-export type EyeColors = 'unknown' | 'amber' | 'blue' | 'brown' | 'gray' | 'green' | 'hazel' | 'red' | 'violet';
-export type HumanStatus = 'unknown' | 'stopped' | 'running';
-export type ListHumansRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc' | 'height_asc' | 'height_desc';
-export interface Human {
-    id: string;
-    organizationId: string;
-    createdAt?: Date;
-    updatedAt?: Date;
-    height: number;
-    shoeSize: number;
-    altitudeInMeter: number;
-    altitudeInMillimeter: number;
-    fingersCount: number;
-    hairCount: number;
-    isHappy: boolean;
-    eyesColor: EyeColors;
-    status: HumanStatus;
-    name: string;
-    projectId: string;
-}
-export type CreateHumanRequest = {
-    height: number;
-    shoeSize: number;
-    altitudeInMeter: number;
-    altitudeInMillimeter: number;
-    fingersCount: number;
-    hairCount: number;
-    isHappy: boolean;
-    eyesColor?: EyeColors;
-    /**
-     * @deprecated
-     *
-     * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
-     */
-    organizationId?: string;
-    name: string;
-    /**
-     *
-     * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set.
-     */
-    projectId?: string;
-};
-export type DeleteHumanRequest = {
-    /**
-     * UUID of the human you want to delete.
-     */
-    humanId: string;
-};
-export type GetHumanRequest = {
-    /**
-     * UUID of the human you want to get.
-     */
-    humanId: string;
-};
-export type ListHumansRequest = {
-    page?: number;
-    pageSize?: number;
-    orderBy?: ListHumansRequestOrderBy;
-    organizationId?: string;
-    projectId?: string;
-};
-export interface ListHumansResponse {
-    totalCount: number;
-    humans: Human[];
-}
-export type RegisterRequest = {
-    username: string;
-};
-export interface RegisterResponse {
-    secretKey: string;
-    accessKey: string;
-}
-export type RunHumanRequest = {
-    /**
-     * UUID of the human you want to make run.
-     */
-    humanId: string;
-};
-export type SmokeHumanRequest = {
-    /**
-     * @deprecated UUID of the human you want to make smoking.
-     */
-    humanId: string;
-};
-export type UpdateHumanRequest = {
-    /**
-     * UUID of the human you want to update.
-     */
-    humanId: string;
-    /**
-     * Height of the human in meters.
-     */
-    height?: number;
-    shoeSize?: number;
-    altitudeInMeter?: number;
-    altitudeInMillimeter?: number;
-    fingersCount?: number;
-    hairCount?: number;
-    isHappy?: boolean;
-    eyesColor?: EyeColors;
-    name?: string;
-};

package/dist/api/vpc/index.gen.cjs

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index_gen = require("./v1/index.gen.cjs");
-const index_gen$1 = require("./v2/index.gen.cjs");
-exports.v1 = index_gen;
-exports.v2 = index_gen$1;

package/dist/api/vpc/index.gen.d.ts

@@ -1,6 +0,0 @@
-/**
- * This file is automatically generated from /scripts/generate.js
- * PLEASE DO NOT EDIT HERE
- */
-export * as v1 from './v1/index.gen.js';
-export * as v2 from './v2/index.gen.js';

package/dist/api/vpc/index.gen.js

@@ -1,6 +0,0 @@
-import * as index_gen from "./v1/index.gen.js";
-import * as index_gen$1 from "./v2/index.gen.js";
-export {
-  index_gen as v1,
-  index_gen$1 as v2
-};

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

@@ -1,121 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-require("../../../client/dist/internal/logger/index.cjs");
-const api = require("../../../client/dist/scw/api.cjs");
-const marshalling = require("../../../client/dist/helpers/marshalling.cjs");
-require("../../../client/dist/vendor/base64/index.cjs");
-const resourcePaginator = require("../../../client/dist/scw/fetch/resource-paginator.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends api.API {
-  /** Lists the available zones of the API. */
-  static LOCALITIES = [
-    "fr-par-1",
-    "fr-par-2",
-    "fr-par-3",
-    "nl-ams-1",
-    "nl-ams-2",
-    "nl-ams-3",
-    "pl-waw-1",
-    "pl-waw-2"
-  ];
-  pageOfListPrivateNetworks = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/vpc/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks`,
-      urlParams: marshalling.urlParams(
-        ["include_regional", request.includeRegional],
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["private_network_ids", request.privateNetworkIds],
-        ["project_id", request.projectId],
-        ["tags", request.tags]
-      )
-    },
-    marshalling_gen.unmarshalListPrivateNetworksResponse
-  );
-  /**
-   * List Private Networks. List existing Private Networks in a specified
-   * Availability Zone. By default, the Private Networks returned in the list
-   * are ordered by creation date in ascending order, though this can be
-   * modified via the order_by field.
-   *
-   * @param request - The request {@link ListPrivateNetworksRequest}
-   * @returns A Promise of ListPrivateNetworksResponse
-   */
-  listPrivateNetworks = (request = {}) => resourcePaginator.enrichForPagination(
-    "privateNetworks",
-    this.pageOfListPrivateNetworks,
-    request
-  );
-  /**
-   * Create a Private Network. Create a new Private Network. Once created, you
-   * can attach Scaleway resources in the same Availability Zone.
-   *
-   * @param request - The request {@link CreatePrivateNetworkRequest}
-   * @returns A Promise of PrivateNetwork
-   */
-  createPrivateNetwork = (request = {}) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreatePrivateNetworkRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/vpc/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks`
-    },
-    marshalling_gen.unmarshalPrivateNetwork
-  );
-  /**
-   * Get a Private Network. Retrieve information about an existing Private
-   * Network, specified by its Private Network ID. Its full details are returned
-   * in the response object.
-   *
-   * @param request - The request {@link GetPrivateNetworkRequest}
-   * @returns A Promise of PrivateNetwork
-   */
-  getPrivateNetwork = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/vpc/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks/${marshalling.validatePathParam("privateNetworkId", request.privateNetworkId)}`
-    },
-    marshalling_gen.unmarshalPrivateNetwork
-  );
-  /**
-   * Update Private Network. Update parameters (such as name or tags) of an
-   * existing Private Network, specified by its Private Network ID.
-   *
-   * @param request - The request {@link UpdatePrivateNetworkRequest}
-   * @returns A Promise of PrivateNetwork
-   */
-  updatePrivateNetwork = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdatePrivateNetworkRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/vpc/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks/${marshalling.validatePathParam("privateNetworkId", request.privateNetworkId)}`
-    },
-    marshalling_gen.unmarshalPrivateNetwork
-  );
-  /**
-   * Delete a Private Network. Delete an existing Private Network. Note that you
-   * must first detach all resources from the network, in order to delete it.
-   *
-   * @param request - The request {@link DeletePrivateNetworkRequest}
-   */
-  deletePrivateNetwork = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/vpc/v1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks/${marshalling.validatePathParam("privateNetworkId", request.privateNetworkId)}`
-  });
-}
-exports.API = API;