@scaleway/sdk 2.46.0 → 2.48.0

package/dist/api/index.d.ts

@@ -1,35 +1,65 @@
-export * as Account from './account';
-export * as AppleSilicon from './applesilicon';
-export * as BareMetal from './baremetal';
-export * as Billing from './billing';
-export * as Block from './block';
-export * as Cockpit from './cockpit';
-export * as Container from './container';
-export * as Dedibox from './dedibox';
-export * as DocumentDB from './document_db';
-export * as Domain from './domain';
-export * as FlexibleIP from './flexibleip';
-export * as Function from './function';
-export * as IAM from './iam';
-export * as Instance from './instance';
-export * as IOT from './iot';
-export * as IPAM from './ipam';
-export * as IPFS from './ipfs';
-export * as Jobs from './jobs';
-export * as K8S from './k8s';
-export * as KeyManager from './key_manager';
-export * as LB from './lb';
-export * as LLMInference from './llm_inference';
-export * as Marketplace from './marketplace';
-export * as MNQ from './mnq';
-export * as RDB from './rdb';
-export * as Redis from './redis';
-export * as Registry from './registry';
-export * as Secret from './secret';
-export * as ServerlessSQLDB from './serverless_sqldb';
-export * as Std from './std/index.gen';
-export * as Test from './test';
-export * as TransactionalEmail from './tem';
-export * as VPC from './vpc';
-export * as VPCGW from './vpcgw';
-export * as Webhosting from './webhosting';
+export * from './index.gen';
+/**
+ * @deprecated use Applesilicon namespace
+ */
+export * as AppleSilicon from './applesilicon/index.gen';
+/**
+ * @deprecated use Baremetal namespace
+ */
+export * as BareMetal from './baremetal/index.gen';
+/**
+ * @deprecated use DocumentDb namespace
+ */
+export * as DocumentDB from './document_db/index.gen';
+/**
+ * @deprecated use Flexibleip namespace
+ */
+export * as FlexibleIP from './flexibleip/index.gen';
+/**
+ * @deprecated use Iam namespace
+ */
+export * as IAM from './iam/index.gen';
+/**
+ * @deprecated use Iot namespace
+ */
+export * as IOT from './iot/index.gen';
+/**
+ * @deprecated use Ipam namespace
+ */
+export * as IPAM from './ipam/index.gen';
+/**
+ * @deprecated use Ipfs namespace
+ */
+export * as IPFS from './ipfs/index.gen';
+/**
+ * @deprecated use Lb namespace
+ */
+export * as LB from './lb/index.gen';
+/**
+ * @deprecated use Llm_Inference namespace
+ */
+export * as LLMInference from './llm_inference/index.gen';
+/**
+ * @deprecated use Mnq namespace
+ */
+export * as MNQ from './mnq/index.gen';
+/**
+ * @deprecated use Rdb namespace
+ */
+export * as RDB from './rdb/index.gen';
+/**
+ * @deprecated use ServerlessSqldb namespace
+ */
+export * as ServerlessSQLDB from './serverless_sqldb/index.gen';
+/**
+ * @deprecated use Tem namespace
+ */
+export * as TransactionalEmail from './tem/index.gen';
+/**
+ * @deprecated use Vpc namespace
+ */
+export * as VPC from './vpc/index.gen';
+/**
+ * @deprecated use Vpcgw namespace
+ */
+export * as VPCGW from './vpcgw/index.gen';

package/dist/api/inference/v1beta1/api.gen.cjs

@@ -0,0 +1,306 @@
+"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");
+require("../../../vendor/base64/index.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"];
+  pageOfListDeployments = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["organization_id", request.organizationId],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["tags", request.tags]
+      )
+    },
+    marshalling_gen.unmarshalListDeploymentsResponse
+  );
+  /**
+   * List inference deployments. List all your inference deployments.
+   *
+   * @param request - The request {@link ListDeploymentsRequest}
+   * @returns A Promise of ListDeploymentsResponse
+   */
+  listDeployments = (request = {}) => resourcePaginator.enrichForPagination("deployments", this.pageOfListDeployments, request);
+  /**
+   * Get a deployment. Get the deployment for the given ID.
+   *
+   * @param request - The request {@link GetDeploymentRequest}
+   * @returns A Promise of Deployment
+   */
+  getDeployment = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}`
+    },
+    marshalling_gen.unmarshalDeployment
+  );
+  /**
+   * Waits for {@link Deployment} to be in a final state.
+   *
+   * @param request - The request {@link GetDeploymentRequest}
+   * @param options - The waiting options
+   * @returns A Promise of Deployment
+   */
+  waitForDeployment = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.DEPLOYMENT_TRANSIENT_STATUSES.includes(res.status))),
+    this.getDeployment,
+    request,
+    options
+  );
+  /**
+   * Create a deployment. Create a new inference deployment related to a
+   * specific model.
+   *
+   * @param request - The request {@link CreateDeploymentRequest}
+   * @returns A Promise of Deployment
+   */
+  createDeployment = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateDeploymentRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments`
+    },
+    marshalling_gen.unmarshalDeployment
+  );
+  /**
+   * Update a deployment. Update an existing inference deployment.
+   *
+   * @param request - The request {@link UpdateDeploymentRequest}
+   * @returns A Promise of Deployment
+   */
+  updateDeployment = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateDeploymentRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}`
+    },
+    marshalling_gen.unmarshalDeployment
+  );
+  /**
+   * Delete a deployment. Delete an existing inference deployment.
+   *
+   * @param request - The request {@link DeleteDeploymentRequest}
+   * @returns A Promise of Deployment
+   */
+  deleteDeployment = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}`
+    },
+    marshalling_gen.unmarshalDeployment
+  );
+  /**
+   * Get the CA certificate. Get the CA certificate used for the deployment of
+   * private endpoints. The CA certificate will be returned as a PEM file.
+   *
+   * @param request - The request {@link GetDeploymentCertificateRequest}
+   * @returns A Promise of Blob
+   */
+  getDeploymentCertificate = (request) => this.client.fetch({
+    method: "GET",
+    path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/certificate`,
+    urlParams: marshalling.urlParams(["dl", 1]),
+    responseType: "blob"
+  });
+  /**
+   * Create an endpoint. Create a new Endpoint related to a specific deployment.
+   *
+   * @param request - The request {@link CreateEndpointRequest}
+   * @returns A Promise of Endpoint
+   */
+  createEndpoint = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateEndpointRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints`
+    },
+    marshalling_gen.unmarshalEndpoint
+  );
+  /**
+   * Update an endpoint. Update an existing Endpoint.
+   *
+   * @param request - The request {@link UpdateEndpointRequest}
+   * @returns A Promise of Endpoint
+   */
+  updateEndpoint = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateEndpointRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${marshalling.validatePathParam("endpointId", request.endpointId)}`
+    },
+    marshalling_gen.unmarshalEndpoint
+  );
+  /**
+   * Delete an endpoint. Delete an existing Endpoint.
+   *
+   * @param request - The request {@link DeleteEndpointRequest}
+   */
+  deleteEndpoint = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${marshalling.validatePathParam("endpointId", request.endpointId)}`
+  });
+  pageOfListDeploymentACLRules = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/acls`,
+      urlParams: marshalling.urlParams(
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListDeploymentACLRulesResponse
+  );
+  /**
+   * List your ACLs. List ACLs for a specific deployment.
+   *
+   * @param request - The request {@link ListDeploymentACLRulesRequest}
+   * @returns A Promise of ListDeploymentACLRulesResponse
+   */
+  listDeploymentACLRules = (request) => resourcePaginator.enrichForPagination("rules", this.pageOfListDeploymentACLRules, request);
+  /**
+   * Add new ACLs. Add new ACL rules for a specific deployment.
+   *
+   * @param request - The request {@link AddDeploymentACLRulesRequest}
+   * @returns A Promise of AddDeploymentACLRulesResponse
+   */
+  addDeploymentACLRules = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalAddDeploymentACLRulesRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/acls`
+    },
+    marshalling_gen.unmarshalAddDeploymentACLRulesResponse
+  );
+  /**
+   * Set new ACL. Set new ACL rules for a specific deployment.
+   *
+   * @param request - The request {@link SetDeploymentACLRulesRequest}
+   * @returns A Promise of SetDeploymentACLRulesResponse
+   */
+  setDeploymentACLRules = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalSetDeploymentACLRulesRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PUT",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/acls`
+    },
+    marshalling_gen.unmarshalSetDeploymentACLRulesResponse
+  );
+  /**
+   * Delete an exising ACL.
+   *
+   * @param request - The request {@link DeleteDeploymentACLRuleRequest}
+   */
+  deleteDeploymentACLRule = (request) => this.client.fetch({
+    method: "DELETE",
+    path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/acls/${marshalling.validatePathParam("aclId", request.aclId)}`
+  });
+  pageOfListModels = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["project_id", request.projectId],
+        ["tags", request.tags]
+      )
+    },
+    marshalling_gen.unmarshalListModelsResponse
+  );
+  /**
+   * List models. List all available models.
+   *
+   * @param request - The request {@link ListModelsRequest}
+   * @returns A Promise of ListModelsResponse
+   */
+  listModels = (request = {}) => resourcePaginator.enrichForPagination("models", this.pageOfListModels, request);
+  /**
+   * Get a model. Get the model for the given ID.
+   *
+   * @param request - The request {@link GetModelRequest}
+   * @returns A Promise of Model
+   */
+  getModel = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${marshalling.validatePathParam("modelId", request.modelId)}`
+    },
+    marshalling_gen.unmarshalModel
+  );
+  getModelEula = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/models/${marshalling.validatePathParam("modelId", request.modelId)}/eula`
+    },
+    marshalling_gen.unmarshalEula
+  );
+  pageOfListNodeTypes = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/inference/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-types`,
+      urlParams: marshalling.urlParams(
+        ["include_disabled_types", request.includeDisabledTypes],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListNodeTypesResponse
+  );
+  /**
+   * List available node types. List all available node types. By default, the
+   * node types 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 ListNodeTypesRequest}
+   * @returns A Promise of ListNodeTypesResponse
+   */
+  listNodeTypes = (request) => resourcePaginator.enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
+}
+exports.API = API;