@scaleway/sdk 2.73.0 → 2.75.0

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

@@ -1,59 +0,0 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Zone } from '@scaleway/sdk-client';
-import type { CreatePrivateNetworkRequest, DeletePrivateNetworkRequest, GetPrivateNetworkRequest, ListPrivateNetworksRequest, ListPrivateNetworksResponse, PrivateNetwork, UpdatePrivateNetworkRequest } from './types.gen';
-/**
- * VPC API.
- *
- * This API allows you to manage your Virtual Private Clouds (VPCs) and Private
- * Networks.
- */
-export declare class API extends ParentAPI {
-    /** Lists the available zones of the API. */
-    static readonly LOCALITIES: Zone[];
-    protected pageOfListPrivateNetworks: (request?: Readonly<ListPrivateNetworksRequest>) => Promise<ListPrivateNetworksResponse>;
-    /**
-     * 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?: Readonly<ListPrivateNetworksRequest>) => Promise<ListPrivateNetworksResponse> & {
-        all: () => Promise<PrivateNetwork[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<PrivateNetwork[], void, void>;
-    };
-    /**
-     * 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?: Readonly<CreatePrivateNetworkRequest>) => Promise<PrivateNetwork>;
-    /**
-     * 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: Readonly<GetPrivateNetworkRequest>) => Promise<PrivateNetwork>;
-    /**
-     * 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: Readonly<UpdatePrivateNetworkRequest>) => Promise<PrivateNetwork>;
-    /**
-     * 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: Readonly<DeletePrivateNetworkRequest>) => Promise<void>;
-}

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

@@ -1,121 +0,0 @@
-import "../../../client/dist/internal/logger/index.js";
-import { API as API$1 } from "../../../client/dist/scw/api.js";
-import { validatePathParam, urlParams } from "../../../client/dist/helpers/marshalling.js";
-import "../../../client/dist/vendor/base64/index.js";
-import { enrichForPagination } from "../../../client/dist/scw/fetch/resource-paginator.js";
-import { unmarshalListPrivateNetworksResponse, marshalCreatePrivateNetworkRequest, unmarshalPrivateNetwork, marshalUpdatePrivateNetworkRequest } from "./marshalling.gen.js";
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends API$1 {
-  /** 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/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks`,
-      urlParams: 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]
-      )
-    },
-    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 = {}) => 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(
-        marshalCreatePrivateNetworkRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/vpc/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks`
-    },
-    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/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam("privateNetworkId", request.privateNetworkId)}`
-    },
-    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(
-        marshalUpdatePrivateNetworkRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/vpc/v1/zones/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam("privateNetworkId", request.privateNetworkId)}`
-    },
-    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/${validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/private-networks/${validatePathParam("privateNetworkId", request.privateNetworkId)}`
-  });
-}
-export {
-  API
-};

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

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

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

@@ -1,2 +0,0 @@
-export { API } from './api.gen.js';
-export type { CreatePrivateNetworkRequest, DeletePrivateNetworkRequest, GetPrivateNetworkRequest, ListPrivateNetworksRequest, ListPrivateNetworksRequestOrderBy, ListPrivateNetworksResponse, PrivateNetwork, UpdatePrivateNetworkRequest, } from './types.gen';

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

@@ -1,4 +0,0 @@
-import { API } from "./api.gen.js";
-export {
-  API
-};

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

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const randomName = require("@scaleway/random-name");
-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 unmarshalPrivateNetwork = (data) => {
-  if (!json.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'PrivateNetwork' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    createdAt: marshalling.unmarshalDate(data.created_at),
-    id: data.id,
-    name: data.name,
-    organizationId: data.organization_id,
-    projectId: data.project_id,
-    subnets: data.subnets,
-    tags: data.tags,
-    updatedAt: marshalling.unmarshalDate(data.updated_at),
-    zone: data.zone
-  };
-};
-const unmarshalListPrivateNetworksResponse = (data) => {
-  if (!json.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListPrivateNetworksResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    privateNetworks: marshalling.unmarshalArrayOfObject(
-      data.private_networks,
-      unmarshalPrivateNetwork
-    ),
-    totalCount: data.total_count
-  };
-};
-const marshalCreatePrivateNetworkRequest = (request, defaults) => ({
-  name: request.name || randomName("pn"),
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  subnets: request.subnets,
-  tags: request.tags
-});
-const marshalUpdatePrivateNetworkRequest = (request, defaults) => ({
-  name: request.name,
-  subnets: request.subnets,
-  tags: request.tags
-});
-exports.marshalCreatePrivateNetworkRequest = marshalCreatePrivateNetworkRequest;
-exports.marshalUpdatePrivateNetworkRequest = marshalUpdatePrivateNetworkRequest;
-exports.unmarshalListPrivateNetworksResponse = unmarshalListPrivateNetworksResponse;
-exports.unmarshalPrivateNetwork = unmarshalPrivateNetwork;

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

@@ -1,6 +0,0 @@
-import type { DefaultValues } from '@scaleway/sdk-client';
-import type { CreatePrivateNetworkRequest, ListPrivateNetworksResponse, PrivateNetwork, UpdatePrivateNetworkRequest } from './types.gen';
-export declare const unmarshalPrivateNetwork: (data: unknown) => PrivateNetwork;
-export declare const unmarshalListPrivateNetworksResponse: (data: unknown) => ListPrivateNetworksResponse;
-export declare const marshalCreatePrivateNetworkRequest: (request: CreatePrivateNetworkRequest, defaults: DefaultValues) => Record<string, unknown>;
-export declare const marshalUpdatePrivateNetworkRequest: (request: UpdatePrivateNetworkRequest, defaults: DefaultValues) => Record<string, unknown>;

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

@@ -1,54 +0,0 @@
-import randomName from "@scaleway/random-name";
-import "../../../client/dist/internal/logger/index.js";
-import { isJSONObject } from "../../../client/dist/helpers/json.js";
-import { unmarshalDate, unmarshalArrayOfObject } from "../../../client/dist/helpers/marshalling.js";
-import "../../../client/dist/vendor/base64/index.js";
-const unmarshalPrivateNetwork = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'PrivateNetwork' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    createdAt: unmarshalDate(data.created_at),
-    id: data.id,
-    name: data.name,
-    organizationId: data.organization_id,
-    projectId: data.project_id,
-    subnets: data.subnets,
-    tags: data.tags,
-    updatedAt: unmarshalDate(data.updated_at),
-    zone: data.zone
-  };
-};
-const unmarshalListPrivateNetworksResponse = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListPrivateNetworksResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    privateNetworks: unmarshalArrayOfObject(
-      data.private_networks,
-      unmarshalPrivateNetwork
-    ),
-    totalCount: data.total_count
-  };
-};
-const marshalCreatePrivateNetworkRequest = (request, defaults) => ({
-  name: request.name || randomName("pn"),
-  project_id: request.projectId ?? defaults.defaultProjectId,
-  subnets: request.subnets,
-  tags: request.tags
-});
-const marshalUpdatePrivateNetworkRequest = (request, defaults) => ({
-  name: request.name,
-  subnets: request.subnets,
-  tags: request.tags
-});
-export {
-  marshalCreatePrivateNetworkRequest,
-  marshalUpdatePrivateNetworkRequest,
-  unmarshalListPrivateNetworksResponse,
-  unmarshalPrivateNetwork
-};

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

@@ -1,99 +0,0 @@
-import type { Zone } from '@scaleway/sdk-client';
-export type ListPrivateNetworksRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
-export interface PrivateNetwork {
-    /** Private Network ID. */
-    id: string;
-    /** Private Network name. */
-    name: string;
-    /** Scaleway Organization the Private Network belongs to. */
-    organizationId: string;
-    /** Scaleway Project the Private Network belongs to. */
-    projectId: string;
-    /** Availability Zone in which the Private Network is available. */
-    zone: Zone;
-    /** Tags of the Private Network. */
-    tags: string[];
-    /** Date the Private Network was created. */
-    createdAt?: Date;
-    /** Date the Private Network was last modified. */
-    updatedAt?: Date;
-    /** Private Network subnets CIDR. */
-    subnets: string[];
-}
-export type CreatePrivateNetworkRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
-    zone?: Zone;
-    /** Name for the Private Network. */
-    name?: string;
-    /** Scaleway Project in which to create the Private Network. */
-    projectId?: string;
-    /** Tags for the Private Network. */
-    tags?: string[];
-    /** Private Network subnets CIDR. */
-    subnets?: string[];
-};
-export type DeletePrivateNetworkRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
-    zone?: Zone;
-    /** Private Network ID. */
-    privateNetworkId: string;
-};
-export type GetPrivateNetworkRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
-    zone?: Zone;
-    /** Private Network ID. */
-    privateNetworkId: string;
-};
-export type ListPrivateNetworksRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
-    zone?: Zone;
-    /** Sort order of the returned Private Networks. */
-    orderBy?: ListPrivateNetworksRequestOrderBy;
-    /** Page number to return, from the paginated results. */
-    page?: number;
-    /** Maximum number of Private Networks to return per page. */
-    pageSize?: number;
-    /**
-     * Name to filter for. Only Private Networks with names containing this string
-     * will be returned.
-     */
-    name?: string;
-    /**
-     * Tags to filter for. Only Private Networks with one or more matching tags
-     * will be returned.
-     */
-    tags?: string[];
-    /**
-     * Organization ID to filter for. Only Private Networks belonging to this
-     * Organization will be returned.
-     */
-    organizationId?: string;
-    /**
-     * Project ID to filter for. Only Private Networks belonging to this Project
-     * will be returned.
-     */
-    projectId?: string;
-    /**
-     * Private Network IDs to filter for. Only Private Networks with one of these
-     * IDs will be returned.
-     */
-    privateNetworkIds?: string[];
-    /** Defines whether to include regional Private Networks in the response. */
-    includeRegional?: boolean;
-};
-export interface ListPrivateNetworksResponse {
-    privateNetworks: PrivateNetwork[];
-    totalCount: number;
-}
-export type UpdatePrivateNetworkRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
-    zone?: Zone;
-    /** Private Network ID. */
-    privateNetworkId: string;
-    /** Name of the private network. */
-    name?: string;
-    /** Tags for the Private Network. */
-    tags?: string[];
-    /** @deprecated Private Network subnets CIDR (deprecated). */
-    subnets?: string[];
-};