@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -4,193 +4,301 @@ export type ListFlexibleIPsRequestOrderBy = 'created_at_asc' | 'created_at_desc'
 export type MACAddressStatus = 'unknown' | 'ready' | 'updating' | 'used' | 'error' | 'deleting';
 export type MACAddressType = 'unknown_type' | 'vmware' | 'xen' | 'kvm';
 export interface MACAddress {
-    /** ID of the flexible IP. */
+    /**
+     * ID of the flexible IP.
+     */
     id: string;
-    /** MAC address of the Virtual MAC. */
+    /**
+     * MAC address of the Virtual MAC.
+     */
     macAddress: string;
-    /** Type of virtual MAC. */
+    /**
+     * Type of virtual MAC.
+     */
     macType: MACAddressType;
-    /** Status of virtual MAC. */
+    /**
+     * Status of virtual MAC.
+     */
     status: MACAddressStatus;
-    /** Date on which the virtual MAC was last updated. */
+    /**
+     * Date on which the virtual MAC was last updated.
+     */
     updatedAt?: Date;
-    /** Date on which the virtual MAC was created. */
+    /**
+     * Date on which the virtual MAC was created.
+     */
     createdAt?: Date;
-    /** MAC address IP Availability Zone. */
+    /**
+     * MAC address IP Availability Zone.
+     */
     zone: ScwZone;
 }
 export interface FlexibleIP {
-    /** ID of the flexible IP. */
+    /**
+     * ID of the flexible IP.
+     */
     id: string;
-    /** ID of the Organization the flexible IP is attached to. */
+    /**
+     * ID of the Organization the flexible IP is attached to.
+     */
     organizationId: string;
-    /** ID of the Project the flexible IP is attached to. */
+    /**
+     * ID of the Project the flexible IP is attached to.
+     */
     projectId: string;
-    /** Flexible IP description. */
+    /**
+     * Flexible IP description.
+     */
     description: string;
-    /** Flexible IP tags. */
+    /**
+     * Flexible IP tags.
+     */
     tags: string[];
-    /** Date on which the flexible IP was last updated. */
+    /**
+     * Date on which the flexible IP was last updated.
+     */
     updatedAt?: Date;
-    /** Date on which the flexible IP was created. */
+    /**
+     * Date on which the flexible IP was created.
+     */
     createdAt?: Date;
     /**
-     * - Ready : flexible IP is created and ready to be attached to a server or to
-     *   be associated with a virtual MAC.
-     * - Updating: flexible IP is being attached to a server or a virtual MAC
-     *   operation is ongoing
-     * - Attached: flexible IP is attached to a server
-     * - Error: a flexible IP operation resulted in an error
-     * - Detaching: flexible IP is being detached from a server
-     * - Locked: the resource of the flexible IP is locked.
+     * - ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
+  - updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing
+  - attached: flexible IP is attached to a server
+  - error: a flexible IP operation resulted in an error
+  - detaching: flexible IP is being detached from a server
+  - locked: the resource of the flexible IP is locked.
      */
     status: FlexibleIPStatus;
-    /** IP of the flexible IP. */
+    /**
+     * IP of the flexible IP.
+     */
     ipAddress: string;
-    /** MAC address of the flexible IP. */
+    /**
+     * MAC address of the flexible IP.
+     */
     macAddress?: MACAddress;
-    /** ID of the server linked to the flexible IP. */
+    /**
+     * ID of the server linked to the flexible IP.
+     */
     serverId?: string;
-    /** Reverse DNS value. */
+    /**
+     * Reverse DNS value.
+     */
     reverse: string;
-    /** Availability Zone of the flexible IP. */
+    /**
+     * Availability Zone of the flexible IP.
+     */
     zone: ScwZone;
 }
 export type AttachFlexibleIPRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
     /**
-     * Multiple IDs can be provided, but note that flexible IPs must belong to the
-     * same MAC group (see details about MAC groups).
+     * Multiple IDs can be provided, but note that flexible IPs must belong to the same MAC group (see details about MAC groups).
      */
     fipsIds: string[];
-    /** ID of the server on which to attach the flexible IPs. */
+    /**
+     * ID of the server on which to attach the flexible IPs.
+     */
     serverId: string;
 };
 export interface AttachFlexibleIPsResponse {
-    /** Total count of flexible IPs that are being updated. */
+    /**
+     * Total count of flexible IPs that are being updated.
+     */
     totalCount: number;
-    /** List of flexible IPs in an updating state. */
+    /**
+     * List of flexible IPs in an updating state.
+     */
     flexibleIps: FlexibleIP[];
 }
 export type CreateFlexibleIPRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** ID of the project to associate with the Flexible IP. */
+    /**
+     * ID of the project to associate with the Flexible IP.
+     */
     projectId?: string;
-    /** Flexible IP description (max. of 255 characters). */
+    /**
+     * Flexible IP description (max. of 255 characters).
+     */
     description: string;
-    /** Tags to associate to the flexible IP. */
+    /**
+     * Tags to associate to the flexible IP.
+     */
     tags?: string[];
-    /** ID of the server to which the newly created flexible IP will be attached. */
+    /**
+     * ID of the server to which the newly created flexible IP will be attached.
+     */
     serverId?: string;
-    /** Value of the reverse DNS. */
+    /**
+     * Value of the reverse DNS.
+     */
     reverse?: string;
-    /** Defines whether the flexible IP has an IPv6 address. */
+    /**
+     * Defines whether the flexible IP has an IPv6 address.
+     */
     isIpv6: boolean;
 };
 export type DeleteFlexibleIPRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** ID of the flexible IP to delete. */
+    /**
+     * ID of the flexible IP to delete.
+     */
     fipId: string;
 };
 export type DeleteMACAddrRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
     /**
-     * If the flexible IP belongs to a MAC group, the MAC will be removed from
-     * both the MAC group and flexible IP.
+     * If the flexible IP belongs to a MAC group, the MAC will be removed from both the MAC group and flexible IP.
      */
     fipId: string;
 };
 export type DetachFlexibleIPRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
     /**
-     * List of flexible IP IDs to detach from a server. Multiple IDs can be
-     * provided. Note that flexible IPs must belong to the same MAC group.
+     * List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.
      */
     fipsIds: string[];
 };
 export interface DetachFlexibleIPsResponse {
-    /** Total count of flexible IPs that are being detached. */
+    /**
+     * Total count of flexible IPs that are being detached.
+     */
     totalCount: number;
-    /** List of flexible IPs in a detaching state. */
+    /**
+     * List of flexible IPs in a detaching state.
+     */
     flexibleIps: FlexibleIP[];
 }
 export type DuplicateMACAddrRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** Note that the flexible IPs need to be attached to the same server. */
+    /**
+     * Note that the flexible IPs need to be attached to the same server.
+     */
     fipId: string;
-    /** Note that flexible IPs need to be attached to the same server. */
+    /**
+     * Note that flexible IPs need to be attached to the same server.
+     */
     duplicateFromFipId: string;
 };
 export type GenerateMACAddrRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** ID of the flexible IP for which to generate a virtual MAC. */
+    /**
+     * ID of the flexible IP for which to generate a virtual MAC.
+     */
     fipId: string;
-    /** TODO. */
+    /**
+     * TODO.
+     */
     macType: MACAddressType;
 };
 export type GetFlexibleIPRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** ID of the flexible IP. */
+    /**
+     * ID of the flexible IP.
+     */
     fipId: string;
 };
 export type ListFlexibleIPsRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** Sort order of the returned flexible IPs. */
+    /**
+     * Sort order of the returned flexible IPs.
+     */
     orderBy?: ListFlexibleIPsRequestOrderBy;
-    /** Page number. */
+    /**
+     * Page number.
+     */
     page?: number;
-    /** Maximum number of flexible IPs per page. */
+    /**
+     * Maximum number of flexible IPs per page.
+     */
     pageSize?: number;
     /**
-     * Filter by tag, only flexible IPs with one or more matching tags will be
-     * returned.
+     * Filter by tag, only flexible IPs with one or more matching tags will be returned.
      */
     tags?: string[];
-    /** Filter by status, only flexible IPs with this status will be returned. */
+    /**
+     * Filter by status, only flexible IPs with this status will be returned.
+     */
     status?: FlexibleIPStatus[];
     /**
-     * Filter by server IDs, only flexible IPs with these server IDs will be
-     * returned.
+     * Filter by server IDs, only flexible IPs with these server IDs will be returned.
      */
     serverIds?: string[];
     /**
-     * Filter by Organization ID, only flexible IPs from this Organization will be
-     * returned.
+     * Filter by Organization ID, only flexible IPs from this Organization will be returned.
      */
     organizationId?: string;
-    /** Filter by Project ID, only flexible IPs from this Project will be returned. */
+    /**
+     * Filter by Project ID, only flexible IPs from this Project will be returned.
+     */
     projectId?: string;
 };
 export interface ListFlexibleIPsResponse {
-    /** Total count of matching flexible IPs. */
+    /**
+     * Total count of matching flexible IPs.
+     */
     totalCount: number;
-    /** List of all flexible IPs. */
+    /**
+     * List of all flexible IPs.
+     */
     flexibleIps: FlexibleIP[];
 }
 export type MoveMACAddrRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
     fipId: string;
     dstFipId: string;
 };
 export type UpdateFlexibleIPRequest = {
-    /** Zone to target. If none is passed will use default zone from the config. */
+    /**
+     * Zone to target. If none is passed will use default zone from the config.
+     */
     zone?: ScwZone;
-    /** ID of the flexible IP to update. */
+    /**
+     * ID of the flexible IP to update.
+     */
     fipId: string;
-    /** Flexible IP description (max. 255 characters). */
+    /**
+     * Flexible IP description (max. 255 characters).
+     */
     description?: string;
-    /** Tags associated with the flexible IP. */
+    /**
+     * Tags associated with the flexible IP.
+     */
     tags?: string[];
-    /** Value of the reverse DNS. */
+    /**
+     * Value of the reverse DNS.
+     */
     reverse?: string;
 };

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

@@ -69,8 +69,7 @@ class API extends api.API {
     options
   );
   /**
-   * Create a deployment. Create a new inference deployment related to a
-   * specific model.
+   * Create a deployment. Create a new inference deployment related to a specific model.
    *
    * @param request - The request {@link CreateDeploymentRequest}
    * @returns A Promise of Deployment
@@ -117,12 +116,12 @@ class API extends api.API {
     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
-   */
+     * 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/v1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${marshalling.validatePathParam("deploymentId", request.deploymentId)}/certificate`,
@@ -267,9 +266,7 @@ class API extends api.API {
     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.
+   * 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

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

@@ -3,8 +3,8 @@ import type { Region as ScwRegion, WaitForOptions } from '@scaleway/sdk-client';
 import type { CreateDeploymentRequest, CreateEndpointRequest, CreateModelRequest, DeleteDeploymentRequest, DeleteEndpointRequest, DeleteModelRequest, Deployment, Endpoint, GetDeploymentCertificateRequest, GetDeploymentRequest, GetModelRequest, ListDeploymentsRequest, ListDeploymentsResponse, ListModelsRequest, ListModelsResponse, ListNodeTypesRequest, ListNodeTypesResponse, Model, UpdateDeploymentRequest, UpdateEndpointRequest } from './types.gen';
 /**
  * Managed Inference API.
- *
- * This API allows you to handle your Managed Inference services.
+
+This API allows you to handle your Managed Inference services.
  */
 export declare class API extends ParentAPI {
     /** Lists the available regions of the API. */
@@ -36,8 +36,7 @@ export declare class API extends ParentAPI {
      */
     waitForDeployment: (request: Readonly<GetDeploymentRequest>, options?: Readonly<WaitForOptions<Deployment>>) => Promise<Deployment>;
     /**
-     * Create a deployment. Create a new inference deployment related to a
-     * specific model.
+     * Create a deployment. Create a new inference deployment related to a specific model.
      *
      * @param request - The request {@link CreateDeploymentRequest}
      * @returns A Promise of Deployment
@@ -58,8 +57,8 @@ export declare class API extends ParentAPI {
      */
     deleteDeployment: (request: Readonly<DeleteDeploymentRequest>) => Promise<Deployment>;
     /**
-     * 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.
+     * 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
@@ -126,9 +125,7 @@ export declare class API extends ParentAPI {
     deleteModel: (request: Readonly<DeleteModelRequest>) => Promise<void>;
     protected pageOfListNodeTypes: (request: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse>;
     /**
-     * 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.
+     * 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

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

@@ -67,8 +67,7 @@ class API extends API$1 {
     options
   );
   /**
-   * Create a deployment. Create a new inference deployment related to a
-   * specific model.
+   * Create a deployment. Create a new inference deployment related to a specific model.
    *
    * @param request - The request {@link CreateDeploymentRequest}
    * @returns A Promise of Deployment
@@ -115,12 +114,12 @@ class API extends API$1 {
     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
-   */
+     * 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/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/deployments/${validatePathParam("deploymentId", request.deploymentId)}/certificate`,
@@ -265,9 +264,7 @@ class API extends API$1 {
     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.
+   * 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