@scaleway/sdk 2.35.0 → 2.37.0

package/dist/api/inference/v1beta1/types.gen.d.ts

@@ -0,0 +1,435 @@
+import type { Region } from '../../../bridge';
+export type DeploymentStatus = 'unknown_status' | 'creating' | 'deploying' | 'ready' | 'error' | 'deleting' | 'locked';
+export type ListDeploymentsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'name_asc' | 'name_desc';
+export type ListModelsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export type NodeTypeStock = 'unknown_stock' | 'low_stock' | 'out_of_stock' | 'available';
+export interface EndpointPrivateNetworkDetails {
+    /** ID of the Private Network. */
+    privateNetworkId: string;
+}
+export interface EndpointPublicAccessDetails {
+}
+export interface EndpointSpecPrivateNetwork {
+    /** ID of the Private Network. */
+    privateNetworkId: string;
+}
+export interface EndpointSpecPublic {
+}
+export interface Endpoint {
+    /** Unique identifier. */
+    id: string;
+    /**
+     * For private endpoints, the URL will be accessible only from the Private
+     * Network. In addition, private endpoints will expose a CA certificate that
+     * can be used to verify the server's identity. This CA certificate can be
+     * retrieved using the `GetDeploymentCertificate` API call.
+     */
+    url: string;
+    /**
+     * Defines whether the endpoint is public.
+     *
+     * One-of ('details'): at most one of 'publicAccess', 'privateNetwork' could
+     * be set.
+     */
+    publicAccess?: EndpointPublicAccessDetails;
+    /**
+     * Details of the Private Network.
+     *
+     * One-of ('details'): at most one of 'publicAccess', 'privateNetwork' could
+     * be set.
+     */
+    privateNetwork?: EndpointPrivateNetworkDetails;
+    /** Defines whether the authentication is disabled. */
+    disableAuth: boolean;
+}
+export interface ModelS3Model {
+    s3Url: string;
+    pythonDependencies: Record<string, string>;
+    nodeType?: string;
+    tritonServerVersion?: string;
+}
+export interface ACLRuleRequest {
+    /**
+     * It can be specified as a single IP address or a range of IP addresses in
+     * CIDR notation.
+     */
+    ip: string;
+    /** Description of the ACL rule. */
+    description: string;
+}
+export interface ACLRule {
+    /** Unique identifier. */
+    id: string;
+    /** Allowed IP address or CIDR range. */
+    ip: string;
+    /** Description of the ACL rule. */
+    description: string;
+}
+export interface EndpointSpec {
+    /**
+     * Set the endpoint as public.
+     *
+     * One-of ('spec'): at most one of 'public', 'privateNetwork' could be set.
+     */
+    public?: EndpointSpecPublic;
+    /**
+     * Private endpoints are only accessible from the Private Network.
+     *
+     * One-of ('spec'): at most one of 'public', 'privateNetwork' could be set.
+     */
+    privateNetwork?: EndpointSpecPrivateNetwork;
+    /**
+     * By default, deployments are protected by IAM authentication. When setting
+     * this field to true, the authentication will be disabled.
+     */
+    disableAuth: boolean;
+}
+export interface Deployment {
+    /** Unique identifier. */
+    id: string;
+    /** Name of the deployment. */
+    name: string;
+    /** Project ID. */
+    projectId: string;
+    /** Status of the deployment. */
+    status: DeploymentStatus;
+    /** List of tags applied to the deployment. */
+    tags: string[];
+    /** Node type of the deployment. */
+    nodeType: string;
+    /** List of endpoints. */
+    endpoints: Endpoint[];
+    /** Current size of the pool. */
+    size: number;
+    /** Defines the minimum size of the pool. */
+    minSize: number;
+    /** Defines the maximum size of the pool. */
+    maxSize: number;
+    /** Displays information if your deployment is in error state. */
+    errorMessage?: string;
+    /** The inference model used for the deployment. */
+    modelName: string;
+    /** ID of the model used for the deployment. */
+    modelId: string;
+    /** Creation date of the deployment. */
+    createdAt?: Date;
+    /** Last modification date of the deployment. */
+    updatedAt?: Date;
+    /** Region of the deployment. */
+    region: Region;
+}
+export interface Model {
+    /** Unique identifier. */
+    id: string;
+    /** Unique Name identifier. */
+    name: string;
+    /** Project ID. */
+    projectId: string;
+    /** Name of the model provider. */
+    provider: string;
+    /** List of tags applied to the model. */
+    tags: string[];
+    /** Purpose of the model. */
+    description: string;
+    /** Defines whether the model has an end user licence agreement. */
+    hasEula: boolean;
+    /** Creation date of the model. */
+    createdAt?: Date;
+    /** Last modification date of the model. */
+    updatedAt?: Date;
+    /** Region of the model. */
+    region: Region;
+    /**
+     * S3 URL pointing to the model source weight.
+     *
+     * One-of ('source'): at most one of 's3Model' could be set.
+     */
+    s3Model?: ModelS3Model;
+    /** Defines whether the model is public or not. */
+    isPublic: boolean;
+    /** Names of the node types compatible with the model. */
+    compatibleNodeTypes: string[];
+    /** Quantization level of the model. */
+    quantizationLevel: string;
+}
+export interface NodeType {
+    /** Name of the node type. */
+    name: string;
+    /** Current stock status for the node type. */
+    stockStatus: NodeTypeStock;
+    /** Current specs of the offer. */
+    description: string;
+    /** Number of virtual CPUs. */
+    vcpus: number;
+    /** Quantity of RAM. */
+    memory: number;
+    /** Quantity of GPU RAM. */
+    vram: number;
+    /** The node type is currently disabled. */
+    disabled: boolean;
+    /** The node type is currently in beta. */
+    beta: boolean;
+    /** Creation date of the node type. */
+    createdAt?: Date;
+    /** Last modification date of the node type. */
+    updatedAt?: Date;
+    /** Number of GPUs. */
+    gpus: number;
+    /** Region of the node type. */
+    region: Region;
+}
+export type AddDeploymentACLRulesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to add ACL rules to. */
+    deploymentId: string;
+    /** List of ACL rules to add. */
+    acls?: ACLRuleRequest[];
+};
+export interface AddDeploymentACLRulesResponse {
+    /** List of ACL rules added. */
+    rules: ACLRule[];
+}
+export type CreateDeploymentRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Name of the deployment. */
+    name?: string;
+    /** ID of the Project to create the deployment in. */
+    projectId?: string;
+    /** Name of the model to use. */
+    modelName: string;
+    /**
+     * If the model has an EULA, you must accept it before proceeding. The terms
+     * of the EULA can be retrieved using the `GetModelEula` API call.
+     */
+    acceptEula?: boolean;
+    /** Name of the node type to use. */
+    nodeType: string;
+    /** List of tags to apply to the deployment. */
+    tags?: string[];
+    /** Defines the minimum size of the pool. */
+    minSize?: number;
+    /** Defines the maximum size of the pool. */
+    maxSize?: number;
+    /** List of endpoints to create. */
+    endpoints: EndpointSpec[];
+};
+export type CreateEndpointRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to create the endpoint for. */
+    deploymentId: string;
+    /** Specification of the endpoint. */
+    endpoint: EndpointSpec;
+};
+export type DeleteDeploymentACLRuleRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the ACL rule to delete. */
+    aclId: string;
+};
+export type DeleteDeploymentRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to delete. */
+    deploymentId: string;
+};
+export type DeleteEndpointRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the endpoint to delete. */
+    endpointId: string;
+};
+export interface Eula {
+    /** Content of the end user licence agreement. */
+    content: string;
+}
+export type GetDeploymentCertificateRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    deploymentId: string;
+};
+export type GetDeploymentRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to get. */
+    deploymentId: string;
+};
+export type GetModelEulaRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    modelId: string;
+};
+export type GetModelRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the model to get. */
+    modelId: string;
+};
+export type ListDeploymentACLRulesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to list ACL rules for. */
+    deploymentId: string;
+    /** Page number to return. */
+    page?: number;
+    /** Maximum number of ACL rules to return per page. */
+    pageSize?: number;
+};
+export interface ListDeploymentACLRulesResponse {
+    /** List of ACL rules on the current page. */
+    rules: ACLRule[];
+    /** Total number of ACL rules. */
+    totalCount: number;
+}
+export type ListDeploymentsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Page number to return. */
+    page?: number;
+    /** Maximum number of deployments to return per page. */
+    pageSize?: number;
+    /** Order in which to return results. */
+    orderBy?: ListDeploymentsRequestOrderBy;
+    /** Filter by Project ID. */
+    projectId?: string;
+    /** Filter by Organization ID. */
+    organizationId?: string;
+    /** Filter by deployment name. */
+    name?: string;
+    /** Filter by tags. */
+    tags?: string[];
+};
+export interface ListDeploymentsResponse {
+    /** List of deployments on the current page. */
+    deployments: Deployment[];
+    /** Total number of deployments. */
+    totalCount: number;
+}
+export type ListModelsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Order in which to return results. */
+    orderBy?: ListModelsRequestOrderBy;
+    /** Page number to return. */
+    page?: number;
+    /** Maximum number of models to return per page. */
+    pageSize?: number;
+    /** Filter by Project ID. */
+    projectId?: string;
+    /** Filter by model name. */
+    name?: string;
+    /** Filter by tags. */
+    tags?: string[];
+};
+export interface ListModelsResponse {
+    /** List of models on the current page. */
+    models: Model[];
+    /** Total number of models. */
+    totalCount: number;
+}
+export type ListNodeTypesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** Page number to return. */
+    page?: number;
+    /** Maximum number of node types to return per page. */
+    pageSize?: number;
+    /** Include disabled node types in the response. */
+    includeDisabledTypes: boolean;
+};
+export interface ListNodeTypesResponse {
+    /** List of node types. */
+    nodeTypes: NodeType[];
+    /** Total number of node types. */
+    totalCount: number;
+}
+export type SetDeploymentACLRulesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to set ACL rules for. */
+    deploymentId: string;
+    /** All existing ACL rules will be replaced by the new ones. */
+    acls?: ACLRuleRequest[];
+};
+export interface SetDeploymentACLRulesResponse {
+    /** List of ACL rules that were set. */
+    rules: ACLRule[];
+}
+export type UpdateDeploymentRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the deployment to update. */
+    deploymentId: string;
+    /** Name of the deployment. */
+    name?: string;
+    /** List of tags to apply to the deployment. */
+    tags?: string[];
+    /** Defines the new minimum size of the pool. */
+    minSize?: number;
+    /** Defines the new maximum size of the pool. */
+    maxSize?: number;
+};
+export type UpdateEndpointRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** ID of the endpoint to update. */
+    endpointId: string;
+    /**
+     * By default, deployments are protected by IAM authentication. When setting
+     * this field to true, the authentication will be disabled.
+     */
+    disableAuth?: boolean;
+};

package/dist/api/inference/v1beta1/validation-rules.gen.d.ts

@@ -0,0 +1,50 @@
+export declare const CreateDeploymentRequest: {
+    maxSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    minSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    modelName: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    nodeType: {
+        maxLength: number;
+        minLength: number;
+    };
+};
+export declare const ListDeploymentsRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+    };
+};
+export declare const ListModelsRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+    };
+};
+export declare const UpdateDeploymentRequest: {
+    maxSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    minSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+    };
+};

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

@@ -36,7 +36,7 @@ const unmarshalBootscript = (data) => {
     );
   }
   return {
-    arch: data.arch,
+    architecture: data.architecture,
     bootcmdargs: data.bootcmdargs,
     default: data.default,
     dtb: data.dtb,
@@ -1399,7 +1399,7 @@ const marshalServerSummary = (request, defaults) => ({
   name: request.name
 });
 const marshalBootscript = (request, defaults) => ({
-  arch: request.arch,
+  architecture: request.architecture,
   bootcmdargs: request.bootcmdargs,
   default: request.default,
   dtb: request.dtb,

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

@@ -34,7 +34,7 @@ const unmarshalBootscript = (data) => {
     );
   }
   return {
-    arch: data.arch,
+    architecture: data.architecture,
     bootcmdargs: data.bootcmdargs,
     default: data.default,
     dtb: data.dtb,
@@ -1397,7 +1397,7 @@ const marshalServerSummary = (request, defaults) => ({
   name: request.name
 });
 const marshalBootscript = (request, defaults) => ({
-  arch: request.arch,
+  architecture: request.architecture,
   bootcmdargs: request.bootcmdargs,
   default: request.default,
   dtb: request.dtb,

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

@@ -59,7 +59,7 @@ export interface Bootscript {
     /** Bootscript title. */
     title: string;
     /** Bootscript architecture. */
-    arch: Arch;
+    architecture: Arch;
     /** Zone in which the bootscript is located. */
     zone: Zone;
 }
@@ -1797,6 +1797,7 @@ export type UpdateServerRequest = {
      *
      * - Cannot be changed if the Instance is not in `stopped` state.
      * - Cannot be changed if the Instance is in a placement group.
+     * - Cannot be changed from/to a Windows offer to/from a Linux offer.
      * - Local storage requirements of the target commercial_types must be fulfilled
      *   (i.e. if an Instance has 80GB of local storage, it can be changed into a
      *   GP1-XS, which has a maximum of 150GB, but it cannot be changed into a

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

@@ -589,6 +589,7 @@ const marshalPrivateNetworkStaticConfig = (request, defaults) => ({
   ip_address: request.ipAddress
 });
 const marshalAttachPrivateNetworkRequest = (request, defaults) => ({
+  ipam_ids: request.ipamIds,
   ...marshalling.resolveOneOf([
     {
       param: "static_config",
@@ -947,6 +948,7 @@ const marshalZonedApiAddBackendServersRequest = (request, defaults) => ({
   server_ip: request.serverIp
 });
 const marshalZonedApiAttachPrivateNetworkRequest = (request, defaults) => ({
+  ipam_ids: request.ipamIds,
   ...marshalling.resolveOneOf([
     {
       param: "static_config",

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

@@ -587,6 +587,7 @@ const marshalPrivateNetworkStaticConfig = (request, defaults) => ({
   ip_address: request.ipAddress
 });
 const marshalAttachPrivateNetworkRequest = (request, defaults) => ({
+  ipam_ids: request.ipamIds,
   ...resolveOneOf([
     {
       param: "static_config",
@@ -945,6 +946,7 @@ const marshalZonedApiAddBackendServersRequest = (request, defaults) => ({
   server_ip: request.serverIp
 });
 const marshalZonedApiAttachPrivateNetworkRequest = (request, defaults) => ({
+  ipam_ids: request.ipamIds,
   ...resolveOneOf([
     {
       param: "static_config",

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

@@ -666,6 +666,14 @@ export type AttachPrivateNetworkRequest = {
      *   'ipamConfig' could be set.
      */
     ipamConfig?: PrivateNetworkIpamConfig;
+    /**
+     * IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this
+     * Private Network. In the future, it will be possible to specify multiple IPs
+     * in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is
+     * expected. When null, a new private IP address is created for the Load
+     * Balancer on this Private Network.
+     */
+    ipamIds?: string[];
 };
 /** Add an ACL to a Load Balancer frontend. */
 export type CreateAclRequest = {
@@ -1824,6 +1832,14 @@ export type ZonedApiAttachPrivateNetworkRequest = {
      *   'ipamConfig' could be set.
      */
     ipamConfig?: PrivateNetworkIpamConfig;
+    /**
+     * IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this
+     * Private Network. In the future, it will be possible to specify multiple IPs
+     * in this field (IPv4 and IPv6), for now only one ID of an IPv4 address is
+     * expected. When null, a new private IP address is created for the Load
+     * Balancer on this Private Network.
+     */
+    ipamIds?: string[];
 };
 /** Add an ACL to a Load Balancer frontend. */
 export type ZonedApiCreateAclRequest = {

package/dist/api/marketplace/v2/types.gen.d.ts

@@ -1,6 +1,6 @@
 import type { Zone } from '../../../bridge';
 export type ListImagesRequestOrderBy = 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
-export type ListLocalImagesRequestOrderBy = 'created_at_asc' | 'created_at_desc';
+export type ListLocalImagesRequestOrderBy = 'type_asc' | 'type_desc' | 'created_at_asc' | 'created_at_desc';
 export type ListVersionsRequestOrderBy = 'created_at_asc' | 'created_at_desc';
 export type LocalImageType = 'unknown_type' | 'instance_local' | 'instance_sbs';
 export interface Category {
@@ -98,25 +98,38 @@ export interface ListImagesResponse {
 }
 export type ListLocalImagesRequest = {
     /**
+     * A positive integer lower or equal to 100 to select the number of items to
+     * display.
+     */
+    pageSize?: number;
+    /** A positive integer to choose the page to display. */
+    page?: number;
+    /** Ordering to use. */
+    orderBy?: ListLocalImagesRequestOrderBy;
+    /** Filter local images available on this Availability Zone. */
+    zone?: Zone;
+    /**
+     * Filter by image id.
+     *
      * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could
      * be set.
      */
     imageId?: string;
     /**
+     * Filter by version id.
+     *
      * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could
      * be set.
      */
     versionId?: string;
-    pageSize?: number;
-    page?: number;
-    orderBy?: ListLocalImagesRequestOrderBy;
     /**
+     * Filter by image label.
+     *
      * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could
      * be set.
      */
     imageLabel?: string;
-    /** Zone to target. If none is passed will use default zone from the config. */
-    zone?: Zone;
+    /** Filter by type. */
     type?: LocalImageType;
 };
 export interface ListLocalImagesResponse {

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

@@ -355,5 +355,30 @@ class API extends api.API {
    * @returns A Promise of ListTagsResponse
    */
   listTags = (request = {}) => resourcePaginator.enrichForPagination("tags", this.pageOfListTags, request);
+  pageOfListSecretTypes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/secret-manager/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secret-types`,
+      urlParams: marshalling.urlParams(
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        [
+          "project_id",
+          request.projectId ?? this.client.settings.defaultProjectId
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListSecretTypesResponse
+  );
+  /**
+   * List secret types. List all secret types created within a given Project.
+   *
+   * @param request - The request {@link ListSecretTypesRequest}
+   * @returns A Promise of ListSecretTypesResponse
+   */
+  listSecretTypes = (request = {}) => resourcePaginator.enrichForPagination("types", this.pageOfListSecretTypes, request);
 }
 exports.API = API;