@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/account/v3/types.gen.d.ts

@@ -6,17 +6,29 @@ export type QualificationArchitectureType = 'unknown_architecture_type' | 'objec
 export type QualificationHostApplicationSubUseCase = 'unknown_sub_use_case' | 'saas_app' | 'government_app';
 export type QualificationHostWebsiteSubUseCase = 'unknown_sub_use_case' | 'information_website' | 'ecommerce_website' | 'high_website' | 'other_sub_use_case';
 export interface Contract {
-    /** ID of the contract. */
+    /**
+     * ID of the contract.
+     */
     id: string;
-    /** The type of the contract. */
+    /**
+     * The type of the contract.
+     */
     type: ContractType;
-    /** The name of the contract. */
+    /**
+     * The name of the contract.
+     */
     name: string;
-    /** The version of the contract. */
+    /**
+     * The version of the contract.
+     */
     version: number;
-    /** The creation date of the contract. */
+    /**
+     * The creation date of the contract.
+     */
     createdAt?: Date;
-    /** The last modification date of the contract. */
+    /**
+     * The last modification date of the contract.
+     */
     updatedAt?: Date;
 }
 export interface QualificationAiMachine {
@@ -40,197 +52,287 @@ export interface QualificationSetScalewayEnvironment {
 export interface QualificationShareData {
 }
 export interface ContractSignature {
-    /** ID of the contract signature. */
+    /**
+     * ID of the contract signature.
+     */
     id: string;
-    /** The Organization ID which signed the contract. */
+    /**
+     * The Organization ID which signed the contract.
+     */
     organizationId: string;
-    /** The creation date of the contract signature. */
+    /**
+     * The creation date of the contract signature.
+     */
     createdAt?: Date;
-    /** The signing date of the contract signature. */
+    /**
+     * The signing date of the contract signature.
+     */
     signedAt?: Date;
-    /** The expiration date of the contract signature. */
+    /**
+     * The expiration date of the contract signature.
+     */
     expiresAt?: Date;
-    /** The contract signed. */
+    /**
+     * The contract signed.
+     */
     contract?: Contract;
 }
 export interface Project {
-    /** ID of the Project. */
+    /**
+     * ID of the Project.
+     */
     id: string;
-    /** Name of the Project. */
+    /**
+     * Name of the Project.
+     */
     name: string;
-    /** Organization ID of the Project. */
+    /**
+     * Organization ID of the Project.
+     */
     organizationId: string;
-    /** Creation date of the Project. */
+    /**
+     * Creation date of the Project.
+     */
     createdAt?: Date;
-    /** Update date of the Project. */
+    /**
+     * Update date of the Project.
+     */
     updatedAt?: Date;
-    /** Description of the Project. */
+    /**
+     * Description of the Project.
+     */
     description: string;
 }
 export interface Qualification {
-    /** Architecture type of the qualification. */
+    /**
+     * Architecture type of the qualification.
+     */
     architectureType: QualificationArchitectureType;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     hostWebsite?: QualificationHostWebsite;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     hostApplication?: QualificationHostApplication;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     deploySoftware?: QualificationDeploySoftware;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     setScalewayEnvironment?: QualificationSetScalewayEnvironment;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     aiMachine?: QualificationAiMachine;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     container?: QualificationContainer;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     archiveData?: QualificationArchiveData;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     shareData?: QualificationShareData;
     /**
-     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication',
-     * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container',
-     * 'archiveData', 'shareData', 'otherUseCase' could be set.
+     *
+     * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set.
      */
     otherUseCase?: QualificationOtherUseCase;
 }
 export interface CheckContractSignatureResponse {
-    /** Whether a signature has been requested for this contract. */
+    /**
+     * Whether a signature has been requested for this contract.
+     */
     created: boolean;
-    /** Whether the signature for this contract has been validated. */
+    /**
+     * Whether the signature for this contract has been validated.
+     */
     validated: boolean;
 }
 export type ContractApiCheckContractSignatureRequest = {
-    /** ID of the Organization to check the contract signature for. */
+    /**
+     * ID of the Organization to check the contract signature for.
+     */
     organizationId?: string;
-    /** Filter on contract type. */
+    /**
+     * Filter on contract type.
+     */
     contractType?: ContractType;
-    /** Filter on contract name. */
+    /**
+     * Filter on contract name.
+     */
     contractName: string;
 };
 export type ContractApiCreateContractSignatureRequest = {
-    /** The type of the contract. */
+    /**
+     * The type of the contract.
+     */
     contractType?: ContractType;
-    /** The name of the contract. */
+    /**
+     * The name of the contract.
+     */
     contractName: string;
-    /** Whether the contract is validated at creation. */
+    /**
+     * Whether the contract is validated at creation.
+     */
     validated: boolean;
-    /** ID of the Organization. */
+    /**
+     * ID of the Organization.
+     */
     organizationId?: string;
 };
 export type ContractApiDownloadContractSignatureRequest = {
-    /** The contract signature ID. */
+    /**
+     * The contract signature ID.
+     */
     contractSignatureId: string;
-    /** The locale requested for the content of the contract. */
+    /**
+     * The locale requested for the content of the contract.
+     */
     locale?: StdLanguageCode;
 };
 export type ContractApiListContractSignaturesRequest = {
-    /** The page number for the returned contracts. */
+    /**
+     * The page number for the returned contracts.
+     */
     page?: number;
-    /** The maximum number of contracts per page. */
+    /**
+     * The maximum number of contracts per page.
+     */
     pageSize?: number;
-    /** How the contracts are ordered in the response. */
+    /**
+     * How the contracts are ordered in the response.
+     */
     orderBy?: ListContractSignaturesRequestOrderBy;
-    /** Filter on Organization ID. */
+    /**
+     * Filter on Organization ID.
+     */
     organizationId?: string;
 };
 export type ContractApiValidateContractSignatureRequest = {
-    /** The contract linked to your Organization you want to sign. */
+    /**
+     * The contract linked to your Organization you want to sign.
+     */
     contractSignatureId: string;
 };
 export interface ListContractSignaturesResponse {
-    /** The total number of contract signatures. */
+    /**
+     * The total number of contract signatures.
+     */
     totalCount: number;
-    /** The paginated returned contract signatures. */
+    /**
+     * The paginated returned contract signatures.
+     */
     contractSignatures: ContractSignature[];
 }
 export interface ListProjectsResponse {
-    /** Total number of Projects. */
+    /**
+     * Total number of Projects.
+     */
     totalCount: number;
-    /** Paginated returned Projects. */
+    /**
+     * Paginated returned Projects.
+     */
     projects: Project[];
 }
 export type ProjectApiCreateProjectRequest = {
-    /** Name of the Project. */
+    /**
+     * Name of the Project.
+     */
     name?: string;
-    /** Organization ID of the Project. */
+    /**
+     * Organization ID of the Project.
+     */
     organizationId?: string;
-    /** Description of the Project. */
+    /**
+     * Description of the Project.
+     */
     description: string;
 };
 export type ProjectApiDeleteProjectRequest = {
-    /** Project ID of the Project. */
+    /**
+     * Project ID of the Project.
+     */
     projectId?: string;
 };
 export type ProjectApiGetProjectRequest = {
-    /** Project ID of the Project. */
+    /**
+     * Project ID of the Project.
+     */
     projectId?: string;
 };
 export type ProjectApiListProjectsRequest = {
-    /** Organization ID of the Project. */
+    /**
+     * Organization ID of the Project.
+     */
     organizationId?: string;
-    /** Name of the Project. */
+    /**
+     * Name of the Project.
+     */
     name?: string;
-    /** Page number for the returned Projects. */
+    /**
+     * Page number for the returned Projects.
+     */
     page?: number;
-    /** Maximum number of Project per page. */
+    /**
+     * Maximum number of Project per page.
+     */
     pageSize?: number;
-    /** Sort order of the returned Projects. */
+    /**
+     * Sort order of the returned Projects.
+     */
     orderBy?: ListProjectsRequestOrderBy;
     /**
-     * Project IDs to filter for. The results will be limited to any Projects with
-     * an ID in this array.
+     * Project IDs to filter for. The results will be limited to any Projects with an ID in this array.
      */
     projectIds?: string[];
 };
 export type ProjectApiSetProjectQualificationRequest = {
-    /** Project ID. */
+    /**
+     * Project ID.
+     */
     projectId?: string;
-    /** Use case chosen for the Project. */
+    /**
+     * Use case chosen for the Project.
+     */
     qualification?: Qualification;
 };
 export type ProjectApiUpdateProjectRequest = {
-    /** Project ID of the Project. */
+    /**
+     * Project ID of the Project.
+     */
     projectId?: string;
-    /** Name of the Project. */
+    /**
+     * Name of the Project.
+     */
     name?: string;
-    /** Description of the Project. */
+    /**
+     * Description of the Project.
+     */
     description?: string;
 };
 export interface ProjectQualification {
-    /** Project ID. */
+    /**
+     * Project ID.
+     */
     projectId: string;
-    /** Qualification of the Project. */
+    /**
+     * Qualification of the Project.
+     */
     qualification?: Qualification;
 }

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

@@ -15,9 +15,7 @@ class API extends api.API {
   /** Lists the available zones of the API. */
   static LOCALITIES = ["fr-par-3"];
   /**
-   * List server types. List all technical details about Apple silicon server
-   * types available in the specified zone. Since there is only one Availability
-   * Zone for Apple silicon servers, the targeted value is `fr-par-3`.
+   * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
    *
    * @param request - The request {@link ListServerTypesRequest}
    * @returns A Promise of ListServerTypesResponse
@@ -30,8 +28,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListServerTypesResponse
   );
   /**
-   * Get a server type. Get technical details (CPU, disk size etc.) of a server
-   * type.
+   * Get a server type. Get technical details (CPU, disk size etc.) of a server type.
    *
    * @param request - The request {@link GetServerTypeRequest}
    * @returns A Promise of ServerType
@@ -44,8 +41,7 @@ class API extends api.API {
     marshalling_gen.unmarshalServerType
   );
   /**
-   * Create a server. Create a new server in the targeted zone, specifying its
-   * configuration including name and type.
+   * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type.
    *
    * @param request - The request {@link CreateServerRequest}
    * @returns A Promise of Server
@@ -79,9 +75,7 @@ class API extends api.API {
     marshalling_gen.unmarshalListServersResponse
   );
   /**
-   * List all servers. List all servers in the specified zone. By default,
-   * returned servers in the list are ordered by creation date in ascending
-   * order, though this can be modified via the `order_by` field.
+   * List all servers. List all servers in the specified zone. By default, returned servers 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 ListServersRequest}
    * @returns A Promise of ListServersResponse
@@ -104,17 +98,14 @@ class API extends api.API {
     marshalling_gen.unmarshalListOSResponse
   );
   /**
-   * List all Operating Systems (OS). List all Operating Systems (OS). The
-   * response will include the total number of OS as well as their associated
-   * IDs, names and labels.
+   * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
    *
    * @param request - The request {@link ListOSRequest}
    * @returns A Promise of ListOSResponse
    */
   listOS = (request = {}) => resourcePaginator.enrichForPagination("os", this.pageOfListOS, request);
   /**
-   * Get an Operating System (OS). Get an Operating System (OS). The response
-   * will include the OS's unique ID as well as its name and label.
+   * Get an Operating System (OS). Get an Operating System (OS).  The response will include the OS's unique ID as well as its name and label.
    *
    * @param request - The request {@link GetOSRequest}
    * @returns A Promise of OS
@@ -127,9 +118,7 @@ class API extends api.API {
     marshalling_gen.unmarshalOS
   );
   /**
-   * Get a server. Retrieve information about an existing Apple silicon server,
-   * specified by its server ID. Its full details, including name, status and IP
-   * address, are returned in the response object.
+   * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
    *
    * @param request - The request {@link GetServerRequest}
    * @returns A Promise of Server
@@ -157,8 +146,7 @@ class API extends api.API {
     options
   );
   /**
-   * Update a server. Update the parameters of an existing Apple silicon server,
-   * specified by its server ID.
+   * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID.
    *
    * @param request - The request {@link UpdateServerRequest}
    * @returns A Promise of Server
@@ -175,10 +163,7 @@ class API extends api.API {
     marshalling_gen.unmarshalServer
   );
   /**
-   * Delete a server. Delete an existing Apple silicon server, specified by its
-   * server ID. Deleting a server is permanent, and cannot be undone. Note that
-   * the minimum allocation period for Apple silicon-as-a-service is 24 hours,
-   * meaning you cannot delete your server prior to that.
+   * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
    *
    * @param request - The request {@link DeleteServerRequest}
    */
@@ -187,8 +172,7 @@ class API extends api.API {
     path: `/apple-silicon/v1alpha1/zones/${marshalling.validatePathParam("zone", request.zone ?? this.client.settings.defaultZone)}/servers/${marshalling.validatePathParam("serverId", request.serverId)}`
   });
   /**
-   * Reboot a server. Reboot an existing Apple silicon server, specified by its
-   * server ID.
+   * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID.
    *
    * @param request - The request {@link RebootServerRequest}
    * @returns A Promise of Server
@@ -203,10 +187,7 @@ class API extends api.API {
     marshalling_gen.unmarshalServer
   );
   /**
-   * Reinstall a server. Reinstall an existing Apple silicon server (specified
-   * by its server ID) from a new image (OS). All the data on the disk is
-   * deleted and all configuration is reset to the defailt configuration values
-   * of the image (OS).
+   * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
    *
    * @param request - The request {@link ReinstallServerRequest}
    * @returns A Promise of Server
@@ -257,8 +238,7 @@ class PrivateNetworkAPI extends api.API {
   /**
    * Waits for {@link ServerPrivateNetwork} to be in a final state.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest}
    * @param options - The waiting options
    * @returns A Promise of ServerPrivateNetwork
    */
@@ -273,11 +253,9 @@ class PrivateNetworkAPI extends api.API {
     options
   );
   /**
-   * Add a server to a Private Network. Add an Apple silicon server to a Private
-   * Network.
+   * Add a server to a Private Network. Add an Apple silicon server to a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest}
    * @returns A Promise of ServerPrivateNetwork
    */
   addServerPrivateNetwork = (request) => this.client.fetch(
@@ -295,11 +273,9 @@ class PrivateNetworkAPI extends api.API {
     marshalling_gen.unmarshalServerPrivateNetwork
   );
   /**
-   * Set multiple Private Networks on a server. Configure multiple Private
-   * Networks on an Apple silicon server.
+   * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest}
    * @returns A Promise of SetServerPrivateNetworksResponse
    */
   setServerPrivateNetworks = (request) => this.client.fetch(
@@ -337,11 +313,9 @@ class PrivateNetworkAPI extends api.API {
     marshalling_gen.unmarshalListServerPrivateNetworksResponse
   );
   /**
-   * List the Private Networks of a server. List the Private Networks of an
-   * Apple silicon server.
+   * List the Private Networks of a server. List the Private Networks of an Apple silicon server.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiListServerPrivateNetworksRequest}
+   * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest}
    * @returns A Promise of ListServerPrivateNetworksResponse
    */
   listServerPrivateNetworks = (request = {}) => resourcePaginator.enrichForPagination(
@@ -352,8 +326,7 @@ class PrivateNetworkAPI extends api.API {
   /**
    * Delete a Private Network.
    *
-   * @param request - The request
-   *   {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
+   * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest}
    */
   deleteServerPrivateNetwork = (request) => this.client.fetch({
     method: "DELETE",