@scaleway/sdk 2.72.0 → 2.73.0

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

@@ -9,23 +9,41 @@ export type ServerPrivateNetworkStatus = 'vpc_unknown_status' | 'vpc_enabled' |
 export type ServerStatus = 'unknown_status' | 'starting' | 'ready' | 'error' | 'rebooting' | 'updating' | 'locking' | 'locked' | 'unlocking' | 'reinstalling' | 'busy';
 export type ServerTypeStock = 'unknown_stock' | 'no_stock' | 'low_stock' | 'high_stock';
 export interface OS {
-    /** Unique ID of the OS. */
+    /**
+     * Unique ID of the OS.
+     */
     id: string;
-    /** OS name. */
+    /**
+     * OS name.
+     */
     name: string;
-    /** OS name as it should be displayed. */
+    /**
+     * OS name as it should be displayed.
+     */
     label: string;
-    /** URL of the image. */
+    /**
+     * URL of the image.
+     */
     imageUrl: string;
-    /** The OS family to which this OS belongs, eg. 13 or 14. */
+    /**
+     * The OS family to which this OS belongs, eg. 13 or 14.
+     */
     family: string;
-    /** Describes if the OS is in beta. */
+    /**
+     * Describes if the OS is in beta.
+     */
     isBeta: boolean;
-    /** The OS version number, eg. Sonoma has version number 14.3. */
+    /**
+     * The OS version number, eg. Sonoma has version number 14.3.
+     */
     version: string;
-    /** The current xcode version for this OS. */
+    /**
+     * The current xcode version for this OS.
+     */
     xcodeVersion: string;
-    /** List of compatible server types. */
+    /**
+     * List of compatible server types.
+     */
     compatibleServerTypes: string[];
 }
 export interface ServerTypeCPU {
@@ -60,101 +78,161 @@ export interface ConnectivityDiagnosticServerHealth {
     isVncPortUp: boolean;
 }
 export interface ServerPrivateNetwork {
-    /** ID of the Server-to-Private Network mapping. */
+    /**
+     * ID of the Server-to-Private Network mapping.
+     */
     id: string;
-    /** Private Network Project ID. */
+    /**
+     * Private Network Project ID.
+     */
     projectId: string;
-    /** Apple silicon server ID. */
+    /**
+     * Apple silicon server ID.
+     */
     serverId: string;
-    /** Private Network ID. */
+    /**
+     * Private Network ID.
+     */
     privateNetworkId: string;
-    /** ID of the VLAN associated with the Private Network. */
+    /**
+     * ID of the VLAN associated with the Private Network.
+     */
     vlan?: number;
-    /** Configuration status of the Private Network. */
+    /**
+     * Configuration status of the Private Network.
+     */
     status: ServerPrivateNetworkServerStatus;
-    /** Private Network creation date. */
+    /**
+     * Private Network creation date.
+     */
     createdAt?: Date;
-    /** Date the Private Network was last modified. */
+    /**
+     * Date the Private Network was last modified.
+     */
     updatedAt?: Date;
-    /** IPAM IP IDs of the server, if it has any. */
+    /**
+     * IPAM IP IDs of the server, if it has any.
+     */
     ipamIpIds: string[];
 }
 export interface ServerType {
-    /** CPU description. */
+    /**
+     * CPU description.
+     */
     cpu?: ServerTypeCPU;
-    /** Size of the local disk of the server. */
+    /**
+     * Size of the local disk of the server.
+     */
     disk?: ServerTypeDisk;
-    /** Name of the type. */
+    /**
+     * Name of the type.
+     */
     name: string;
-    /** Size of memory available. */
+    /**
+     * Size of memory available.
+     */
     memory?: ServerTypeMemory;
-    /** Current stock. */
+    /**
+     * Current stock.
+     */
     stock: ServerTypeStock;
-    /** Minimum duration of the lease in seconds (example. 3.4s). */
+    /**
+     * Minimum duration of the lease in seconds (example. 3.4s).
+     */
     minimumLeaseDuration?: string;
-    /** GPU description. */
+    /**
+     * GPU description.
+     */
     gpu?: ServerTypeGPU;
-    /** Network description. */
+    /**
+     * Network description.
+     */
     network?: ServerTypeNetwork;
-    /** The default OS for this server type. */
+    /**
+     * The default OS for this server type.
+     */
     defaultOs?: OS;
 }
 export interface Server {
-    /** UUID of the server. */
+    /**
+     * UUID of the server.
+     */
     id: string;
-    /** Type of the server. */
+    /**
+     * Type of the server.
+     */
     type: string;
-    /** Name of the server. */
+    /**
+     * Name of the server.
+     */
     name: string;
-    /** Project this server is associated with. */
+    /**
+     * Project this server is associated with.
+     */
     projectId: string;
-    /** Organization this server is associated with. */
+    /**
+     * Organization this server is associated with.
+     */
     organizationId: string;
-    /** IPv4 address of the server. */
+    /**
+     * IPv4 address of the server.
+     */
     ip: string;
-    /** Vnc:// URL to access Apple Remote Desktop. */
+    /**
+     * Vnc:// URL to access Apple Remote Desktop.
+     */
     vncUrl: string;
-    /** SSH Username for remote shell. */
+    /**
+     * SSH Username for remote shell.
+     */
     sshUsername: string;
-    /** Admin password required to execute commands. */
+    /**
+     * Admin password required to execute commands.
+     */
     sudoPassword: string;
-    /** VNC port to use for remote desktop connection. */
+    /**
+     * VNC port to use for remote desktop connection.
+     */
     vncPort: number;
     /**
-     * Initially installed OS, this does not necessarily reflect the current OS
-     * version.
+     * Initially installed OS, this does not necessarily reflect the current OS version.
      */
     os?: OS;
-    /** Current status of the server. */
+    /**
+     * Current status of the server.
+     */
     status: ServerStatus;
-    /** Date on which the server was created. */
+    /**
+     * Date on which the server was created.
+     */
     createdAt?: Date;
-    /** Date on which the server was last updated. */
+    /**
+     * Date on which the server was last updated.
+     */
     updatedAt?: Date;
-    /** Date from which the server can be deleted. */
+    /**
+     * Date from which the server can be deleted.
+     */
     deletableAt?: Date;
     /**
-     * Set to true to mark the server for automatic deletion depending on
-     * `deletable_at` date. Set to false to cancel an existing deletion schedule.
-     * Leave unset otherwise.
+     * Set to true to mark the server for automatic deletion depending on `deletable_at` date. Set to false to cancel an existing deletion schedule. Leave unset otherwise.
      */
     deletionScheduled: boolean;
-    /** Zone of the server. */
+    /**
+     * Zone of the server.
+     */
     zone: ScwZone;
     /**
-     * Set to true once the server has completed its provisioning steps and is
-     * ready to use. Some OS configurations might require a reinstallation of the
-     * server before delivery depending on the available stock. A reinstallation
-     * after the initial delivery will not change this flag and can be tracked
-     * using the server status.
+     * Set to true once the server has completed its provisioning steps and is ready to use. Some OS configurations might require a reinstallation of the server before delivery depending on the available stock. A reinstallation after the initial delivery will not change this flag and can be tracked using the server status.
      */
     delivered: boolean;
     /**
-     * Activation status of optional Private Network feature support for this
-     * server.
+     * Activation status of optional Private Network feature support for this server.
      */
     vpcStatus: ServerPrivateNetworkStatus;
-    /** Commitment scheme applied to this server. */
+    /**
+     * Commitment scheme applied to this server.
+     */
     commitment?: Commitment;
 }
 export interface CommitmentTypeValue {
@@ -169,84 +247,112 @@ export interface ConnectivityDiagnostic {
     errorMessage: string;
 }
 export type CreateServerRequest = {
-    /** 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;
-    /** Create a server with this given name. */
+    /**
+     * Create a server with this given name.
+     */
     name?: string;
-    /** Create a server in the given project ID. */
+    /**
+     * Create a server in the given project ID.
+     */
     projectId?: string;
-    /** Create a server of the given type. */
+    /**
+     * Create a server of the given type.
+     */
     type: string;
     /**
-     * Create a server & install the given os_id, when no os_id provided the
-     * default OS for this server type is chosen. Requesting a non-default OS will
-     * induce an extended delivery time.
+     * Create a server & install the given os_id, when no os_id provided the default OS for this server type is chosen. Requesting a non-default OS will induce an extended delivery time.
      */
     osId?: string;
     /**
-     * Activate the Private Network feature for this server. This feature is
-     * configured through the Apple Silicon - Private Networks API.
+     * Activate the Private Network feature for this server. This feature is configured through the Apple Silicon - Private Networks API.
      */
     enableVpc: boolean;
     /**
-     * Activate commitment for this server. If not specified, there is a 24h
-     * commitment due to Apple licensing (commitment_type `duration_24h`). It can
-     * be updated with the Update Server request. Available commitment depends on
-     * server type.
+     * Activate commitment for this server. If not specified, there is a 24h commitment due to Apple licensing (commitment_type `duration_24h`). It can be updated with the Update Server request. Available commitment depends on server type.
      */
     commitmentType?: CommitmentType;
 };
 export type DeleteServerRequest = {
-    /** 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;
-    /** UUID of the server you want to delete. */
+    /**
+     * UUID of the server you want to delete.
+     */
     serverId: string;
 };
 export type GetConnectivityDiagnosticRequest = {
-    /** 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;
     diagnosticId: string;
 };
 export type GetOSRequest = {
-    /** 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;
-    /** UUID of the OS you want to get. */
+    /**
+     * UUID of the OS you want to get.
+     */
     osId: string;
 };
 export type GetServerRequest = {
-    /** 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;
-    /** UUID of the server you want to get. */
+    /**
+     * UUID of the server you want to get.
+     */
     serverId: string;
 };
 export type GetServerTypeRequest = {
-    /** 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;
-    /** Server type identifier. */
+    /**
+     * Server type identifier.
+     */
     serverType: string;
 };
 export type ListOSRequest = {
-    /** 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;
-    /** Positive integer to choose the page to return. */
+    /**
+     * Positive integer to choose the page to return.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
-    /** List of compatible server types. */
+    /**
+     * List of compatible server types.
+     */
     serverType?: string;
     /**
-     * Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not
-     * "12")).
+     * Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")).
      */
     name?: string;
 };
 export interface ListOSResponse {
-    /** Total number of OS. */
+    /**
+     * Total number of OS.
+     */
     totalCount: number;
-    /** List of OS. */
+    /**
+     * List of OS.
+     */
     os: OS[];
 }
 export interface ListServerPrivateNetworksResponse {
@@ -254,108 +360,166 @@ export interface ListServerPrivateNetworksResponse {
     totalCount: number;
 }
 export type ListServerTypesRequest = {
-    /** 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;
 };
 export interface ListServerTypesResponse {
-    /** Available server types. */
+    /**
+     * Available server types.
+     */
     serverTypes: ServerType[];
 }
 export type ListServersRequest = {
-    /** 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 servers. */
+    /**
+     * Sort order of the returned servers.
+     */
     orderBy?: ListServersRequestOrderBy;
-    /** Only list servers of this project ID. */
+    /**
+     * Only list servers of this project ID.
+     */
     projectId?: string;
-    /** Only list servers of this Organization ID. */
+    /**
+     * Only list servers of this Organization ID.
+     */
     organizationId?: string;
-    /** Positive integer to choose the page to return. */
+    /**
+     * Positive integer to choose the page to return.
+     */
     page?: number;
     /**
-     * Positive integer lower or equal to 100 to select the number of items to
-     * return.
+     * Positive integer lower or equal to 100 to select the number of items to return.
      */
     pageSize?: number;
 };
 export interface ListServersResponse {
-    /** Total number of servers. */
+    /**
+     * Total number of servers.
+     */
     totalCount: number;
-    /** Paginated returned servers. */
+    /**
+     * Paginated returned servers.
+     */
     servers: Server[];
 }
 export type PrivateNetworkApiAddServerPrivateNetworkRequest = {
-    /** 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 server. */
+    /**
+     * ID of the server.
+     */
     serverId: string;
-    /** ID of the Private Network. */
+    /**
+     * ID of the Private Network.
+     */
     privateNetworkId: string;
-    /** IPAM IDs of IPs to attach to the server. */
+    /**
+     * IPAM IDs of IPs to attach to the server.
+     */
     ipamIpIds?: string[];
 };
 export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = {
-    /** 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 server. */
+    /**
+     * ID of the server.
+     */
     serverId: string;
-    /** ID of the Private Network. */
+    /**
+     * ID of the Private Network.
+     */
     privateNetworkId: string;
 };
 export type PrivateNetworkApiGetServerPrivateNetworkRequest = {
-    /** 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;
     serverId: string;
     privateNetworkId: string;
 };
 export type PrivateNetworkApiListServerPrivateNetworksRequest = {
-    /** 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 for the returned Private Networks. */
+    /**
+     * Sort order for the returned Private Networks.
+     */
     orderBy?: ListServerPrivateNetworksRequestOrderBy;
-    /** Page number for the returned Private Networks. */
+    /**
+     * Page number for the returned Private Networks.
+     */
     page?: number;
-    /** Maximum number of Private Networks per page. */
+    /**
+     * Maximum number of Private Networks per page.
+     */
     pageSize?: number;
-    /** Filter Private Networks by server ID. */
+    /**
+     * Filter Private Networks by server ID.
+     */
     serverId?: string;
-    /** Filter Private Networks by Private Network ID. */
+    /**
+     * Filter Private Networks by Private Network ID.
+     */
     privateNetworkId?: string;
-    /** Filter Private Networks by Organization ID. */
+    /**
+     * Filter Private Networks by Organization ID.
+     */
     organizationId?: string;
-    /** Filter Private Networks by Project ID. */
+    /**
+     * Filter Private Networks by Project ID.
+     */
     projectId?: string;
-    /** Filter Private Networks by IPAM IP IDs. */
+    /**
+     * Filter Private Networks by IPAM IP IDs.
+     */
     ipamIpIds?: string[];
 };
 export type PrivateNetworkApiSetServerPrivateNetworksRequest = {
-    /** 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 server. */
+    /**
+     * ID of the server.
+     */
     serverId: string;
     /**
-     * Object where the keys are the IDs of Private Networks and the values are
-     * arrays of IPAM IDs representing the IPs to assign to this Apple silicon
-     * server on the Private Network. If the array supplied for a Private Network
-     * is empty, the next available IP from the Private Network's CIDR block will
-     * automatically be used for attachment.
+     * Object where the keys are the IDs of Private Networks and the values are arrays of IPAM IDs representing the IPs to assign to this Apple silicon server on the Private Network. If the array supplied for a Private Network is empty, the next available IP from the Private Network's CIDR block will automatically be used for attachment.
      */
     perPrivateNetworkIpamIpIds: Record<string, string[]>;
 };
 export type RebootServerRequest = {
-    /** 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;
-    /** UUID of the server you want to reboot. */
+    /**
+     * UUID of the server you want to reboot.
+     */
     serverId: string;
 };
 export type ReinstallServerRequest = {
-    /** 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;
-    /** UUID of the server you want to reinstall. */
+    /**
+     * UUID of the server you want to reinstall.
+     */
     serverId: string;
     /**
-     * Reinstall the server with the target OS, when no os_id provided the default
-     * OS for the server type is used.
+     * Reinstall the server with the target OS, when no os_id provided the default OS for the server type is used.
      */
     osId?: string;
 };
@@ -363,7 +527,9 @@ export interface SetServerPrivateNetworksResponse {
     serverPrivateNetworks: ServerPrivateNetwork[];
 }
 export type StartConnectivityDiagnosticRequest = {
-    /** 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;
     serverId: string;
 };
@@ -371,19 +537,28 @@ export interface StartConnectivityDiagnosticResponse {
     diagnosticId: string;
 }
 export type UpdateServerRequest = {
-    /** 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;
-    /** UUID of the server you want to update. */
+    /**
+     * UUID of the server you want to update.
+     */
     serverId: string;
-    /** Updated name for your server. */
+    /**
+     * Updated name for your server.
+     */
     name?: string;
-    /** Specify whether the server should be flagged for automatic deletion. */
+    /**
+     * Specify whether the server should be flagged for automatic deletion.
+     */
     scheduleDeletion?: boolean;
-    /** Activate or deactivate Private Network support for this server. */
+    /**
+     * Activate or deactivate Private Network support for this server.
+     */
     enableVpc?: boolean;
     /**
-     * Change commitment. Use 'none' to automatically cancel a renewing
-     * commitment.
+     * Change commitment. Use 'none' to automatically cancel a renewing commitment.
      */
     commitmentType?: CommitmentTypeValue;
 };

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

@@ -9,9 +9,7 @@ class API extends api.API {
   /** Lists the available regions of the API. */
   static LOCALITIES = ["fr-par", "nl-ams"];
   /**
-   * List events. Retrieve the list of Audit Trail events for a Scaleway
-   * Organization and/or Project. You must specify the `organization_id` and
-   * optionally, the `project_id`.
+   * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
    *
    * @param request - The request {@link ListEventsRequest}
    * @returns A Promise of ListEventsResponse
@@ -44,8 +42,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListEventsResponse
   );
   /**
-   * Retrieve the list of Scaleway resources for which you have Audit Trail
-   * events.
+   * Retrieve the list of Scaleway resources for which you have Audit Trail events.
    *
    * @param request - The request {@link ListProductsRequest}
    * @returns A Promise of ListProductsResponse