@scaleway/sdk 2.26.0 → 2.28.0

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

@@ -0,0 +1,209 @@
+import type { Region, Zone } from '../../../bridge';
+export type ListIPsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'attached_at_desc' | 'attached_at_asc';
+export type ResourceType = 'unknown_type' | 'instance_server' | 'instance_ip' | 'instance_private_nic' | 'lb_server' | 'fip_ip' | 'vpc_gateway' | 'vpc_gateway_network' | 'k8s_node' | 'k8s_cluster' | 'rdb_instance' | 'redis_cluster' | 'baremetal_server' | 'baremetal_private_nic' | 'llm_deployment';
+export interface Resource {
+    /** Type of resource the IP is attached to. */
+    type: ResourceType;
+    /** ID of the resource the IP is attached to. */
+    id: string;
+    /** MAC of the resource the IP is attached to. */
+    macAddress?: string;
+    /**
+     * When the IP is in a Private Network, then a DNS record is available to
+     * resolve the resource name to this IP.
+     */
+    name?: string;
+}
+export interface Reverse {
+    /** Reverse domain name. */
+    hostname: string;
+    /** IP corresponding to the hostname. */
+    address?: string;
+}
+export interface Source {
+    /**
+     * This source is global.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    zonal?: string;
+    /**
+     * This source is specific.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    privateNetworkId?: string;
+    /**
+     * This source is specific.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    subnetId?: string;
+}
+export interface IP {
+    /** IP ID. */
+    id: string;
+    /** IPv4 or IPv6 address in CIDR notation. */
+    address: string;
+    /** Scaleway Project the IP belongs to. */
+    projectId: string;
+    /** Defines whether the IP is an IPv6 (false = IPv4). */
+    isIpv6: boolean;
+    /** Date the IP was booked. */
+    createdAt?: Date;
+    /** Date the IP was last modified. */
+    updatedAt?: Date;
+    /** Source pool where the IP was booked in. */
+    source: Source;
+    /** Resource which the IP is attached to. */
+    resource?: Resource;
+    /** Tags for the IP. */
+    tags: string[];
+    /** Array of reverses associated with the IP. */
+    reverses: Reverse[];
+    /** Region of the IP. */
+    region: Region;
+    /** Zone of the IP, if zonal. */
+    zone?: Zone;
+}
+export type BookIPRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /**
+     * When creating an IP in a Private Network, the Project must match the
+     * Private Network's Project.
+     */
+    projectId?: string;
+    /** Source in which to book the IP. Not all sources are available for booking. */
+    source: Source;
+    /** Request an IPv6 instead of an IPv4. */
+    isIpv6: boolean;
+    /**
+     * The requested address should not include the subnet mask (/suffix). Note
+     * that only the Private Network source allows you to pick a specific IP. If
+     * the requested IP is already booked, then the call will fail.
+     */
+    address?: string;
+    /** Tags for the IP. */
+    tags?: string[];
+};
+export type GetIPRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** IP ID. */
+    ipId: string;
+};
+export type ListIPsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Sort order of the returned IPs. */
+    orderBy?: ListIPsRequestOrderBy;
+    /** Page number to return, from the paginated results. */
+    page?: number;
+    /** Maximum number of IPs to return per page. */
+    pageSize?: number;
+    /**
+     * Project ID to filter for. Only IPs belonging to this Project will be
+     * returned.
+     */
+    projectId?: string;
+    /**
+     * Zone to filter for. Only IPs that are zonal, and in this zone, will be
+     * returned.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    zonal?: string;
+    /**
+     * Only IPs that are private, and in this Private Network, will be returned.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    privateNetworkId?: string;
+    /**
+     * Only IPs inside this exact subnet will be returned.
+     *
+     * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId'
+     * could be set.
+     */
+    subnetId?: string;
+    /** Only IPs owned by resources in this VPC will be returned. */
+    vpcId?: string;
+    /** Defines whether to filter only for IPs which are attached to a resource. */
+    attached?: boolean;
+    /**
+     * Resource ID to filter for. Only IPs attached to this resource will be
+     * returned.
+     */
+    resourceId?: string;
+    /**
+     * Resource type to filter for. Only IPs attached to this type of resource
+     * will be returned.
+     */
+    resourceType?: ResourceType;
+    /**
+     * MAC address to filter for. Only IPs attached to a resource with this MAC
+     * address will be returned.
+     */
+    macAddress?: string;
+    /**
+     * Tags to filter for, only IPs with one or more matching tags will be
+     * returned.
+     */
+    tags?: string[];
+    /**
+     * Organization ID to filter for. Only IPs belonging to this Organization will
+     * be returned.
+     */
+    organizationId?: string;
+    /** Defines whether to filter only for IPv4s or IPv6s. */
+    isIpv6?: boolean;
+    /**
+     * Attached resource name to filter for, only IPs attached to a resource with
+     * this string within their name will be returned.
+     */
+    resourceName?: string;
+};
+export interface ListIPsResponse {
+    totalCount: number;
+    ips: IP[];
+}
+export type ReleaseIPRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** IP ID. */
+    ipId: string;
+};
+export type UpdateIPRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** IP ID. */
+    ipId: string;
+    /** Tags for the IP. */
+    tags?: string[];
+    /**
+     * Array of reverse domain names associated with an IP in the subnet of the
+     * current IP.
+     */
+    reverses?: Reverse[];
+};

package/dist/api/ipam/v1/validation-rules.gen.cjs

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ListIPsRequest = {
+  resourceName: {
+    maxLength: 63,
+    minLength: 2
+  }
+};
+exports.ListIPsRequest = ListIPsRequest;

package/dist/api/ipam/v1/validation-rules.gen.d.ts

@@ -0,0 +1,6 @@
+export declare const ListIPsRequest: {
+    resourceName: {
+        maxLength: number;
+        minLength: number;
+    };
+};

package/dist/api/ipam/v1/validation-rules.gen.js

@@ -1,11 +1,9 @@
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-
 const ListIPsRequest = {
   resourceName: {
     maxLength: 63,
     minLength: 2
   }
 };
-
-export { ListIPsRequest };
+export {
+  ListIPsRequest
+};

package/dist/api/ipfs/index.cjs

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

package/dist/api/ipfs/index.d.ts

@@ -0,0 +1 @@
+export * as v1alpha1 from './v1alpha1/index.gen';

package/dist/api/ipfs/index.js

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

package/dist/api/ipfs/v1alpha1/api.gen.cjs

@@ -0,0 +1,374 @@
+"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 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  /**
+   * Create a new volume. Create a new volume from a Project ID. Volume is
+   * identified by an ID and used to host pin references. Volume is personal (at
+   * least to your organization) even if IPFS blocks and CID are available to
+   * anyone. Should be the first command you made because every pin must be
+   * attached to a volume.
+   *
+   * @param request - The request {@link CreateVolumeRequest}
+   * @returns A Promise of Volume
+   */
+  createVolume = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateVolumeRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/volumes`
+    },
+    marshalling_gen.unmarshalVolume
+  );
+  /**
+   * Get information about a volume. Retrieve information about a specific
+   * volume.
+   *
+   * @param request - The request {@link GetVolumeRequest}
+   * @returns A Promise of Volume
+   */
+  getVolume = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/volumes/${marshalling.validatePathParam("volumeId", request.volumeId)}`
+    },
+    marshalling_gen.unmarshalVolume
+  );
+  pageOfListVolumes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/volumes`,
+      urlParams: marshalling.urlParams(
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        [
+          "project_id",
+          request.projectId ?? this.client.settings.defaultProjectId
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListVolumesResponse
+  );
+  /**
+   * List all volumes by a Project ID. Retrieve information about all volumes
+   * from a Project ID.
+   *
+   * @param request - The request {@link ListVolumesRequest}
+   * @returns A Promise of ListVolumesResponse
+   */
+  listVolumes = (request = {}) => resourcePaginator.enrichForPagination("volumes", this.pageOfListVolumes, request);
+  /**
+   * Update volume information. Update volume information (tag, name...).
+   *
+   * @param request - The request {@link UpdateVolumeRequest}
+   * @returns A Promise of Volume
+   */
+  updateVolume = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateVolumeRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/volumes/${marshalling.validatePathParam("volumeId", request.volumeId)}`
+    },
+    marshalling_gen.unmarshalVolume
+  );
+  /**
+   * Delete an existing volume. Delete a volume by its ID and every pin attached
+   * to this volume. This process can take a while to conclude, depending on the
+   * size of your pinned content.
+   *
+   * @param request - The request {@link DeleteVolumeRequest}
+   */
+  deleteVolume = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/volumes/${marshalling.validatePathParam("volumeId", request.volumeId)}`
+  });
+  /**
+   * Create a pin by URL. Will fetch and store the content pointed by the
+   * provided URL. The content must be available on the public IPFS network. The
+   * content (IPFS blocks) will be host by the pinning service until pin
+   * deletion. From that point, any other IPFS peer can fetch and host your
+   * content: Make sure to pin public or encrypted content. Many pin requests
+   * (from different users) can target the same CID. A pin is defined by its ID
+   * (UUID), its status (queued, pinning, pinned or failed) and target CID.
+   *
+   * @param request - The request {@link CreatePinByURLRequest}
+   * @returns A Promise of Pin
+   */
+  createPinByURL = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreatePinByURLRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pins/create-by-url`
+    },
+    marshalling_gen.unmarshalPin
+  );
+  /**
+   * Create a pin by CID. Will fetch and store the content pointed by the
+   * provided CID. The content must be available on the public IPFS network. The
+   * content (IPFS blocks) will be host by the pinning service until pin
+   * deletion. From that point, any other IPFS peer can fetch and host your
+   * content: Make sure to pin public or encrypted content. Many pin requests
+   * (from different users) can target the same CID. A pin is defined by its ID
+   * (UUID), its status (queued, pinning, pinned or failed) and target CID.
+   *
+   * @param request - The request {@link CreatePinByCIDRequest}
+   * @returns A Promise of Pin
+   */
+  createPinByCID = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreatePinByCIDRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pins/create-by-cid`
+    },
+    marshalling_gen.unmarshalPin
+  );
+  /**
+   * Replace pin by CID. Deletes the given resource ID and pins the new CID in
+   * its place. Will fetch and store the content pointed by the provided CID.
+   * The content must be available on the public IPFS network. The content (IPFS
+   * blocks) is hosted by the pinning service until the pin is deleted. While
+   * the content is available any other IPFS peer can fetch and host your
+   * content. For this reason, we recommend that you pin either public or
+   * encrypted content. Several different pin requests can target the same CID.
+   * A pin is defined by its ID (UUID), its status (queued, pinning, pinned or
+   * failed) and target CID.
+   *
+   * @param request - The request {@link ReplacePinRequest}
+   * @returns A Promise of ReplacePinResponse
+   */
+  replacePin = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalReplacePinRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pins/${marshalling.validatePathParam("pinId", request.pinId)}/replace`
+    },
+    marshalling_gen.unmarshalReplacePinResponse
+  );
+  /**
+   * Get pin information. Retrieve information about the provided **pin ID**,
+   * such as status, last modification, and CID.
+   *
+   * @param request - The request {@link GetPinRequest}
+   * @returns A Promise of Pin
+   */
+  getPin = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pins/${marshalling.validatePathParam("pinId", request.pinId)}`,
+      urlParams: marshalling.urlParams(["volume_id", request.volumeId])
+    },
+    marshalling_gen.unmarshalPin
+  );
+  /**
+   * Waits for {@link Pin} to be in a final state.
+   *
+   * @param request - The request {@link GetPinRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Pin
+   */
+  waitForPin = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.PIN_TRANSIENT_STATUSES.includes(res.status))),
+    this.getPin,
+    request,
+    options
+  );
+  pageOfListPins = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pins`,
+      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],
+        ["status", request.status],
+        ["volume_id", request.volumeId]
+      )
+    },
+    marshalling_gen.unmarshalListPinsResponse
+  );
+  /**
+   * List all pins within a volume. Retrieve information about all pins within a
+   * volume.
+   *
+   * @param request - The request {@link ListPinsRequest}
+   * @returns A Promise of ListPinsResponse
+   */
+  listPins = (request) => resourcePaginator.enrichForPagination("pins", this.pageOfListPins, request);
+  /**
+   * Create an unpin request. An unpin request means that you no longer own the
+   * content. This content can therefore be removed and no longer provided on
+   * the IPFS network.
+   *
+   * @param request - The request {@link DeletePinRequest}
+   */
+  deletePin = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/pins/${marshalling.validatePathParam("pinId", request.pinId)}`,
+    urlParams: marshalling.urlParams(["volume_id", request.volumeId])
+  });
+}
+class IpnsAPI extends api.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  /**
+   * Create a new name. You can use the `ipns key` command to list and generate
+   * more names and their respective keys.
+   *
+   * @param request - The request {@link IpnsApiCreateNameRequest}
+   * @returns A Promise of Name
+   */
+  createName = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalIpnsApiCreateNameRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names`
+    },
+    marshalling_gen.unmarshalName
+  );
+  /**
+   * Get information about a name. Retrieve information about a specific name.
+   *
+   * @param request - The request {@link IpnsApiGetNameRequest}
+   * @returns A Promise of Name
+   */
+  getName = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names/${marshalling.validatePathParam("nameId", request.nameId)}`
+    },
+    marshalling_gen.unmarshalName
+  );
+  /**
+   * Waits for {@link Name} to be in a final state.
+   *
+   * @param request - The request {@link IpnsApiGetNameRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Name
+   */
+  waitForName = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.NAME_TRANSIENT_STATUSES.includes(res.status))),
+    this.getName,
+    request,
+    options
+  );
+  /**
+   * Delete an existing name. Delete a name by its ID.
+   *
+   * @param request - The request {@link IpnsApiDeleteNameRequest}
+   */
+  deleteName = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names/${marshalling.validatePathParam("nameId", request.nameId)}`
+  });
+  pageOfListNames = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names`,
+      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.unmarshalListNamesResponse
+  );
+  /**
+   * List all names by a Project ID. Retrieve information about all names from a
+   * Project ID.
+   *
+   * @param request - The request {@link IpnsApiListNamesRequest}
+   * @returns A Promise of ListNamesResponse
+   */
+  listNames = (request = {}) => resourcePaginator.enrichForPagination("names", this.pageOfListNames, request);
+  /**
+   * Update name information. Update name information (CID, tag, name...).
+   *
+   * @param request - The request {@link IpnsApiUpdateNameRequest}
+   * @returns A Promise of Name
+   */
+  updateName = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalIpnsApiUpdateNameRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names/${marshalling.validatePathParam("nameId", request.nameId)}`
+    },
+    marshalling_gen.unmarshalName
+  );
+  /**
+   * Export your private key. Export a private key by its ID.
+   *
+   * @param request - The request {@link IpnsApiExportKeyNameRequest}
+   * @returns A Promise of ExportKeyNameResponse
+   */
+  exportKeyName = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names/${marshalling.validatePathParam("nameId", request.nameId)}/export-key`
+    },
+    marshalling_gen.unmarshalExportKeyNameResponse
+  );
+  /**
+   * Import your private key. Import a private key.
+   *
+   * @param request - The request {@link IpnsApiImportKeyNameRequest}
+   * @returns A Promise of Name
+   */
+  importKeyName = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalIpnsApiImportKeyNameRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/ipfs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/names/import-key`
+    },
+    marshalling_gen.unmarshalName
+  );
+}
+exports.API = API;
+exports.IpnsAPI = IpnsAPI;