@scaleway/sdk 2.26.0 → 2.28.0

package/dist/api/ipfs/v1alpha1/types.gen.d.ts

@@ -0,0 +1,317 @@
+import type { Region } from '../../../bridge';
+export type ListNamesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type ListPinsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type ListVolumesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type NameStatus = 'unknown_status' | 'queued' | 'publishing' | 'failed' | 'published';
+export type PinDetails = 'unknown_details' | 'pinning_looking_for_provider' | 'pinning_in_progress' | 'pinning_blocks_fetched' | 'pinning_fetching_url_data' | 'pinned_ok' | 'unpinned_ok' | 'unpinning_in_progress' | 'failed_contains_banned_cid' | 'failed_pinning' | 'failed_pinning_no_provider' | 'failed_pinning_bad_cid_format' | 'failed_pinning_timeout' | 'failed_pinning_too_big_content' | 'failed_pinning_unreachable_url' | 'failed_pinning_bad_url_format' | 'failed_pinning_no_url_content_length' | 'failed_pinning_bad_url_status_code' | 'failed_unpinning' | 'checking_coherence' | 'rescheduled';
+export type PinStatus = 'unknown_status' | 'queued' | 'pinning' | 'failed' | 'pinned';
+export interface PinCIDMeta {
+    id?: string;
+}
+export interface PinCID {
+    cid?: string;
+    name?: string;
+    origins: string[];
+    meta?: PinCIDMeta;
+}
+export interface PinInfo {
+    id?: string;
+    url?: string;
+    size?: number;
+    progress?: number;
+    statusDetails: PinDetails;
+}
+export interface Name {
+    nameId: string;
+    projectId: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    tags: string[];
+    name: string;
+    key: string;
+    status: NameStatus;
+    value: string;
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region: Region;
+}
+export interface Pin {
+    pinId: string;
+    status: PinStatus;
+    createdAt?: Date;
+    cid?: PinCID;
+    delegates: string[];
+    info?: PinInfo;
+}
+export interface Volume {
+    id: string;
+    projectId: string;
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region: Region;
+    countPin: number;
+    createdAt?: Date;
+    updatedAt?: Date;
+    tags: string[];
+    name: string;
+    size?: number;
+}
+export type CreatePinByCIDRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Volume ID on which you want to pin your content. */
+    volumeId: string;
+    /** CID containing the content you want to pin. */
+    cid: string;
+    /** Node containing the content you want to pin. */
+    origins?: string[];
+    /** Pin name. */
+    name?: string;
+};
+export type CreatePinByURLRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Volume ID on which you want to pin your content. */
+    volumeId: string;
+    /** URL containing the content you want to pin. */
+    url: string;
+    /** Pin name. */
+    name?: string;
+};
+export type CreateVolumeRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Project ID. */
+    projectId?: string;
+    /** Volume name. */
+    name: string;
+};
+export type DeletePinRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Pin ID you want to remove from the volume. */
+    pinId: string;
+    /** Volume ID. */
+    volumeId: string;
+};
+export type DeleteVolumeRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Volume ID. */
+    volumeId: string;
+};
+export interface ExportKeyNameResponse {
+    nameId: string;
+    projectId: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    publicKey: string;
+    privateKey: string;
+}
+export type GetPinRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Pin ID of which you want to obtain information. */
+    pinId: string;
+    /** Volume ID. */
+    volumeId: string;
+};
+export type GetVolumeRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Volume ID. */
+    volumeId: string;
+};
+export type IpnsApiCreateNameRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Project ID. */
+    projectId?: string;
+    /** Name for your records. */
+    name: string;
+    /** Value you want to associate with your records, CID or IPNS key. */
+    value: string;
+};
+export type IpnsApiDeleteNameRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Name ID you wish to delete. */
+    nameId: string;
+};
+export type IpnsApiExportKeyNameRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Name ID whose keys you want to export. */
+    nameId: string;
+};
+export type IpnsApiGetNameRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Name ID whose information you want to retrieve. */
+    nameId: string;
+};
+export type IpnsApiImportKeyNameRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Project ID. */
+    projectId?: string;
+    /** Name for your records. */
+    name: string;
+    /** Base64 private key. */
+    privateKey: string;
+    /** Value you want to associate with your records, CID or IPNS key. */
+    value: string;
+};
+export type IpnsApiListNamesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Project ID. */
+    projectId?: string;
+    /** Organization ID. */
+    organizationId?: string;
+    /** Sort the order of the returned names. */
+    orderBy?: ListNamesRequestOrderBy;
+    /** Page number. */
+    page?: number;
+    /** Maximum number of names to return per page. */
+    pageSize?: number;
+};
+export type IpnsApiUpdateNameRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Name ID you wish to update. */
+    nameId: string;
+    /** New name you want to associate with your record. */
+    name?: string;
+    /** New tags you want to associate with your record. */
+    tags?: string[];
+    /** Value you want to associate with your records, CID or IPNS key. */
+    value?: string;
+};
+export interface ListNamesResponse {
+    names: Name[];
+    totalCount: number;
+}
+export type ListPinsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Volume ID of which you want to list the pins. */
+    volumeId: string;
+    /** Project ID. */
+    projectId?: string;
+    /** Organization ID. */
+    organizationId?: string;
+    /** Sort order of the returned Volume. */
+    orderBy?: ListPinsRequestOrderBy;
+    /** Page number. */
+    page?: number;
+    /** Maximum number of volumes to return per page. */
+    pageSize?: number;
+    /** List pins by status. */
+    status?: PinStatus;
+};
+export interface ListPinsResponse {
+    totalCount: number;
+    pins: Pin[];
+}
+export type ListVolumesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Project ID, only volumes belonging to this project will be listed. */
+    projectId?: string;
+    /** Sort the order of the returned volumes. */
+    orderBy?: ListVolumesRequestOrderBy;
+    /** Page number. */
+    page?: number;
+    /** Maximum number of volumes to return per page. */
+    pageSize?: number;
+};
+export interface ListVolumesResponse {
+    volumes: Volume[];
+    totalCount: number;
+}
+export type ReplacePinRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Pin ID whose information you wish to replace. */
+    pinId: string;
+    /** Volume ID. */
+    volumeId: string;
+    /** New CID you want to pin in place of the old one. */
+    cid: string;
+    /** New name to replace. */
+    name?: string;
+    /** Node containing the content you want to pin. */
+    origins?: string[];
+};
+export interface ReplacePinResponse {
+    pin?: Pin;
+}
+export type UpdateVolumeRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Volume ID. */
+    volumeId: string;
+    /** Volume name. */
+    name?: string;
+    /** Tags of the volume. */
+    tags?: string[];
+};

package/dist/api/jobs/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/jobs/index.d.ts

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

package/dist/api/jobs/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/jobs/v1alpha1/api.gen.cjs

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+const resourcePaginator = require("../../../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 regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  /**
+   * Create a new job definition in a specified Project.
+   *
+   * @param request - The request {@link CreateJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
+  createJobDefinition = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateJobDefinitionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`
+    },
+    marshalling_gen.unmarshalJobDefinition
+  );
+  /**
+   * Get a job definition by its unique identifier.
+   *
+   * @param request - The request {@link GetJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
+  getJobDefinition = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+    },
+    marshalling_gen.unmarshalJobDefinition
+  );
+  pageOfListJobDefinitions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions`,
+      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.unmarshalListJobDefinitionsResponse
+  );
+  /**
+   * List all your job definitions with filters.
+   *
+   * @param request - The request {@link ListJobDefinitionsRequest}
+   * @returns A Promise of ListJobDefinitionsResponse
+   */
+  listJobDefinitions = (request = {}) => resourcePaginator.enrichForPagination(
+    "jobDefinitions",
+    this.pageOfListJobDefinitions,
+    request
+  );
+  /**
+   * Update an existing job definition associated with the specified unique
+   * identifier.
+   *
+   * @param request - The request {@link UpdateJobDefinitionRequest}
+   * @returns A Promise of JobDefinition
+   */
+  updateJobDefinition = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateJobDefinitionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+    },
+    marshalling_gen.unmarshalJobDefinition
+  );
+  /**
+   * Delete an exsisting job definition by its unique identifier.
+   *
+   * @param request - The request {@link DeleteJobDefinitionRequest}
+   */
+  deleteJobDefinition = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}`
+  });
+  /**
+   * Run an existing job definition by its unique identifier. This will create a
+   * new job run.
+   *
+   * @param request - The request {@link StartJobDefinitionRequest}
+   * @returns A Promise of StartJobDefinitionResponse
+   */
+  startJobDefinition = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalStartJobDefinitionRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-definitions/${marshalling.validatePathParam("jobDefinitionId", request.jobDefinitionId)}/start`
+    },
+    marshalling_gen.unmarshalStartJobDefinitionResponse
+  );
+  /**
+   * Get a job run by its unique identifier.
+   *
+   * @param request - The request {@link GetJobRunRequest}
+   * @returns A Promise of JobRun
+   */
+  getJobRun = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${marshalling.validatePathParam("jobRunId", request.jobRunId)}`
+    },
+    marshalling_gen.unmarshalJobRun
+  );
+  /**
+   * Stop a job run by its unique identifier.
+   *
+   * @param request - The request {@link StopJobRunRequest}
+   * @returns A Promise of JobRun
+   */
+  stopJobRun = (request) => this.client.fetch(
+    {
+      body: "{}",
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs/${marshalling.validatePathParam("jobRunId", request.jobRunId)}/stop`
+    },
+    marshalling_gen.unmarshalJobRun
+  );
+  pageOfListJobRuns = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/serverless-jobs/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/job-runs`,
+      urlParams: marshalling.urlParams(
+        ["job_definition_id", request.jobDefinitionId],
+        ["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.unmarshalListJobRunsResponse
+  );
+  /**
+   * List all job runs with filters.
+   *
+   * @param request - The request {@link ListJobRunsRequest}
+   * @returns A Promise of ListJobRunsResponse
+   */
+  listJobRuns = (request = {}) => resourcePaginator.enrichForPagination("jobRuns", this.pageOfListJobRuns, request);
+}
+exports.API = API;

package/dist/api/jobs/v1alpha1/api.gen.d.ts

@@ -0,0 +1,84 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { Region } from '../../../bridge';
+import type { CreateJobDefinitionRequest, DeleteJobDefinitionRequest, GetJobDefinitionRequest, GetJobRunRequest, JobDefinition, JobRun, ListJobDefinitionsRequest, ListJobDefinitionsResponse, ListJobRunsRequest, ListJobRunsResponse, StartJobDefinitionRequest, StartJobDefinitionResponse, StopJobRunRequest, UpdateJobDefinitionRequest } from './types.gen';
+/**
+ * Serverless Jobs API.
+ *
+ * This API allows you to manage your Serverless Jobs.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: Region[];
+    /**
+     * Create a new job definition in a specified Project.
+     *
+     * @param request - The request {@link CreateJobDefinitionRequest}
+     * @returns A Promise of JobDefinition
+     */
+    createJobDefinition: (request: Readonly<CreateJobDefinitionRequest>) => Promise<JobDefinition>;
+    /**
+     * Get a job definition by its unique identifier.
+     *
+     * @param request - The request {@link GetJobDefinitionRequest}
+     * @returns A Promise of JobDefinition
+     */
+    getJobDefinition: (request: Readonly<GetJobDefinitionRequest>) => Promise<JobDefinition>;
+    protected pageOfListJobDefinitions: (request?: Readonly<ListJobDefinitionsRequest>) => Promise<ListJobDefinitionsResponse>;
+    /**
+     * List all your job definitions with filters.
+     *
+     * @param request - The request {@link ListJobDefinitionsRequest}
+     * @returns A Promise of ListJobDefinitionsResponse
+     */
+    listJobDefinitions: (request?: Readonly<ListJobDefinitionsRequest>) => Promise<ListJobDefinitionsResponse> & {
+        all: () => Promise<JobDefinition[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<JobDefinition[], void, void>;
+    };
+    /**
+     * Update an existing job definition associated with the specified unique
+     * identifier.
+     *
+     * @param request - The request {@link UpdateJobDefinitionRequest}
+     * @returns A Promise of JobDefinition
+     */
+    updateJobDefinition: (request: Readonly<UpdateJobDefinitionRequest>) => Promise<JobDefinition>;
+    /**
+     * Delete an exsisting job definition by its unique identifier.
+     *
+     * @param request - The request {@link DeleteJobDefinitionRequest}
+     */
+    deleteJobDefinition: (request: Readonly<DeleteJobDefinitionRequest>) => Promise<void>;
+    /**
+     * Run an existing job definition by its unique identifier. This will create a
+     * new job run.
+     *
+     * @param request - The request {@link StartJobDefinitionRequest}
+     * @returns A Promise of StartJobDefinitionResponse
+     */
+    startJobDefinition: (request: Readonly<StartJobDefinitionRequest>) => Promise<StartJobDefinitionResponse>;
+    /**
+     * Get a job run by its unique identifier.
+     *
+     * @param request - The request {@link GetJobRunRequest}
+     * @returns A Promise of JobRun
+     */
+    getJobRun: (request: Readonly<GetJobRunRequest>) => Promise<JobRun>;
+    /**
+     * Stop a job run by its unique identifier.
+     *
+     * @param request - The request {@link StopJobRunRequest}
+     * @returns A Promise of JobRun
+     */
+    stopJobRun: (request: Readonly<StopJobRunRequest>) => Promise<JobRun>;
+    protected pageOfListJobRuns: (request?: Readonly<ListJobRunsRequest>) => Promise<ListJobRunsResponse>;
+    /**
+     * List all job runs with filters.
+     *
+     * @param request - The request {@link ListJobRunsRequest}
+     * @returns A Promise of ListJobRunsResponse
+     */
+    listJobRuns: (request?: Readonly<ListJobRunsRequest>) => Promise<ListJobRunsResponse> & {
+        all: () => Promise<JobRun[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<JobRun[], void, void>;
+    };
+}