@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/account/v3/api.gen.cjs

@@ -13,8 +13,7 @@ class ContractAPI extends api.API {
   /**
    * Download a contract content.
    *
-   * @param request - The request
-   *   {@link ContractApiDownloadContractSignatureRequest}
+   * @param request - The request {@link ContractApiDownloadContractSignatureRequest}
    * @returns A Promise of Blob
    */
   downloadContractSignature = (request) => this.client.fetch({
@@ -24,11 +23,9 @@ class ContractAPI extends api.API {
     responseType: "blob"
   });
   /**
-   * Create a signature for your Organization for the latest version of the
-   * requested contract.
+   * Create a signature for your Organization for the latest version of the requested contract.
    *
-   * @param request - The request
-   *   {@link ContractApiCreateContractSignatureRequest}
+   * @param request - The request {@link ContractApiCreateContractSignatureRequest}
    * @returns A Promise of ContractSignature
    */
   createContractSignature = (request) => this.client.fetch(
@@ -48,8 +45,7 @@ class ContractAPI extends api.API {
   /**
    * Sign a contract for your Organization.
    *
-   * @param request - The request
-   *   {@link ContractApiValidateContractSignatureRequest}
+   * @param request - The request {@link ContractApiValidateContractSignatureRequest}
    * @returns A Promise of ContractSignature
    */
   validateContractSignature = (request) => this.client.fetch(
@@ -64,8 +60,7 @@ class ContractAPI extends api.API {
   /**
    * Check if a contract is signed for your Organization.
    *
-   * @param request - The request
-   *   {@link ContractApiCheckContractSignatureRequest}
+   * @param request - The request {@link ContractApiCheckContractSignatureRequest}
    * @returns A Promise of CheckContractSignatureResponse
    */
   checkContractSignature = (request) => this.client.fetch(
@@ -104,8 +99,7 @@ class ContractAPI extends api.API {
   /**
    * List contract signatures for an Organization.
    *
-   * @param request - The request
-   *   {@link ContractApiListContractSignaturesRequest}
+   * @param request - The request {@link ContractApiListContractSignaturesRequest}
    * @returns A Promise of ListContractSignaturesResponse
    */
   listContractSignatures = (request = {}) => resourcePaginator.enrichForPagination(
@@ -116,8 +110,7 @@ class ContractAPI extends api.API {
 }
 class ProjectAPI extends api.API {
   /**
-   * Create a new Project for an Organization. Generate a new Project for an
-   * Organization, specifying its configuration including name and description.
+   * Create a new Project for an Organization. Generate a new Project for an Organization, specifying its configuration including name and description.
    *
    * @param request - The request {@link ProjectApiCreateProjectRequest}
    * @returns A Promise of Project
@@ -155,19 +148,14 @@ class ProjectAPI extends api.API {
     marshalling_gen.unmarshalListProjectsResponse
   );
   /**
-   * List all Projects of an Organization. List all Projects of an Organization.
-   * The response will include the total number of Projects as well as their
-   * associated Organizations, names, and IDs. Other information includes the
-   * creation and update date of the Project.
+   * List all Projects of an Organization. List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names, and IDs. Other information includes the creation and update date of the Project.
    *
    * @param request - The request {@link ProjectApiListProjectsRequest}
    * @returns A Promise of ListProjectsResponse
    */
   listProjects = (request = {}) => resourcePaginator.enrichForPagination("projects", this.pageOfListProjects, request);
   /**
-   * Get an existing Project. Retrieve information about an existing Project,
-   * specified by its Project ID. Its full details, including ID, name and
-   * description, are returned in the response object.
+   * Get an existing Project. Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
    *
    * @param request - The request {@link ProjectApiGetProjectRequest}
    * @returns A Promise of Project
@@ -180,10 +168,7 @@ class ProjectAPI extends api.API {
     marshalling_gen.unmarshalProject
   );
   /**
-   * Delete an existing Project. Delete an existing Project, specified by its
-   * Project ID. The Project needs to be empty (meaning there are no resources
-   * left in it) to be deleted effectively. Note that deleting a Project is
-   * permanent, and cannot be undone.
+   * Delete an existing Project. Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
    *
    * @param request - The request {@link ProjectApiDeleteProjectRequest}
    */
@@ -192,8 +177,7 @@ class ProjectAPI extends api.API {
     path: `/account/v3/projects/${marshalling.validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
   });
   /**
-   * Update Project. Update the parameters of an existing Project, specified by
-   * its Project ID. These parameters include the name and description.
+   * Update Project. Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
    *
    * @param request - The request {@link ProjectApiUpdateProjectRequest}
    * @returns A Promise of Project
@@ -210,12 +194,9 @@ class ProjectAPI extends api.API {
     marshalling_gen.unmarshalProject
   );
   /**
-   * Set project use case. Set the project use case for a new or existing
-   * Project, specified by its Project ID. You can customize the use case, sub
-   * use case, and architecture type you want to use in the Project.
+   * Set project use case. Set the project use case for a new or existing Project, specified by its Project ID. You can customize the use case, sub use case, and architecture type you want to use in the Project.
    *
-   * @param request - The request
-   *   {@link ProjectApiSetProjectQualificationRequest}
+   * @param request - The request {@link ProjectApiSetProjectQualificationRequest}
    * @returns A Promise of ProjectQualification
    */
   setProjectQualification = (request = {}) => this.client.fetch(

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

@@ -2,40 +2,35 @@ import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CheckContractSignatureResponse, ContractApiCheckContractSignatureRequest, ContractApiCreateContractSignatureRequest, ContractApiDownloadContractSignatureRequest, ContractApiListContractSignaturesRequest, ContractApiValidateContractSignatureRequest, ContractSignature, ListContractSignaturesResponse, ListProjectsResponse, Project, ProjectApiCreateProjectRequest, ProjectApiDeleteProjectRequest, ProjectApiGetProjectRequest, ProjectApiListProjectsRequest, ProjectApiSetProjectQualificationRequest, ProjectApiUpdateProjectRequest, ProjectQualification } from './types.gen';
 /**
  * Contract API.
- *
- * The Contract API allows you to manage contracts.
+
+The Contract API allows you to manage contracts.
  */
 export declare class ContractAPI extends ParentAPI {
     /**
      * Download a contract content.
      *
-     * @param request - The request
-     *   {@link ContractApiDownloadContractSignatureRequest}
+     * @param request - The request {@link ContractApiDownloadContractSignatureRequest}
      * @returns A Promise of Blob
      */
     downloadContractSignature: (request: Readonly<ContractApiDownloadContractSignatureRequest>) => Promise<Blob>;
     /**
-     * Create a signature for your Organization for the latest version of the
-     * requested contract.
+     * Create a signature for your Organization for the latest version of the requested contract.
      *
-     * @param request - The request
-     *   {@link ContractApiCreateContractSignatureRequest}
+     * @param request - The request {@link ContractApiCreateContractSignatureRequest}
      * @returns A Promise of ContractSignature
      */
     createContractSignature: (request: Readonly<ContractApiCreateContractSignatureRequest>) => Promise<ContractSignature>;
     /**
      * Sign a contract for your Organization.
      *
-     * @param request - The request
-     *   {@link ContractApiValidateContractSignatureRequest}
+     * @param request - The request {@link ContractApiValidateContractSignatureRequest}
      * @returns A Promise of ContractSignature
      */
     validateContractSignature: (request: Readonly<ContractApiValidateContractSignatureRequest>) => Promise<ContractSignature>;
     /**
      * Check if a contract is signed for your Organization.
      *
-     * @param request - The request
-     *   {@link ContractApiCheckContractSignatureRequest}
+     * @param request - The request {@link ContractApiCheckContractSignatureRequest}
      * @returns A Promise of CheckContractSignatureResponse
      */
     checkContractSignature: (request: Readonly<ContractApiCheckContractSignatureRequest>) => Promise<CheckContractSignatureResponse>;
@@ -43,8 +38,7 @@ export declare class ContractAPI extends ParentAPI {
     /**
      * List contract signatures for an Organization.
      *
-     * @param request - The request
-     *   {@link ContractApiListContractSignaturesRequest}
+     * @param request - The request {@link ContractApiListContractSignaturesRequest}
      * @returns A Promise of ListContractSignaturesResponse
      */
     listContractSignatures: (request?: Readonly<ContractApiListContractSignaturesRequest>) => Promise<ListContractSignaturesResponse> & {
@@ -54,13 +48,12 @@ export declare class ContractAPI extends ParentAPI {
 }
 /**
  * Account API.
- *
- * This API allows you to manage your Scaleway Projects.
+
+This API allows you to manage your Scaleway Projects.
  */
 export declare class ProjectAPI extends ParentAPI {
     /**
-     * Create a new Project for an Organization. Generate a new Project for an
-     * Organization, specifying its configuration including name and description.
+     * Create a new Project for an Organization. Generate a new Project for an Organization, specifying its configuration including name and description.
      *
      * @param request - The request {@link ProjectApiCreateProjectRequest}
      * @returns A Promise of Project
@@ -68,10 +61,7 @@ export declare class ProjectAPI extends ParentAPI {
     createProject: (request: Readonly<ProjectApiCreateProjectRequest>) => Promise<Project>;
     protected pageOfListProjects: (request?: Readonly<ProjectApiListProjectsRequest>) => Promise<ListProjectsResponse>;
     /**
-     * List all Projects of an Organization. List all Projects of an Organization.
-     * The response will include the total number of Projects as well as their
-     * associated Organizations, names, and IDs. Other information includes the
-     * creation and update date of the Project.
+     * List all Projects of an Organization. List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names, and IDs. Other information includes the creation and update date of the Project.
      *
      * @param request - The request {@link ProjectApiListProjectsRequest}
      * @returns A Promise of ListProjectsResponse
@@ -81,38 +71,29 @@ export declare class ProjectAPI extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Project[], void, void>;
     };
     /**
-     * Get an existing Project. Retrieve information about an existing Project,
-     * specified by its Project ID. Its full details, including ID, name and
-     * description, are returned in the response object.
+     * Get an existing Project. Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
      *
      * @param request - The request {@link ProjectApiGetProjectRequest}
      * @returns A Promise of Project
      */
     getProject: (request?: Readonly<ProjectApiGetProjectRequest>) => Promise<Project>;
     /**
-     * Delete an existing Project. Delete an existing Project, specified by its
-     * Project ID. The Project needs to be empty (meaning there are no resources
-     * left in it) to be deleted effectively. Note that deleting a Project is
-     * permanent, and cannot be undone.
+     * Delete an existing Project. Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
      *
      * @param request - The request {@link ProjectApiDeleteProjectRequest}
      */
     deleteProject: (request?: Readonly<ProjectApiDeleteProjectRequest>) => Promise<void>;
     /**
-     * Update Project. Update the parameters of an existing Project, specified by
-     * its Project ID. These parameters include the name and description.
+     * Update Project. Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
      *
      * @param request - The request {@link ProjectApiUpdateProjectRequest}
      * @returns A Promise of Project
      */
     updateProject: (request?: Readonly<ProjectApiUpdateProjectRequest>) => Promise<Project>;
     /**
-     * Set project use case. Set the project use case for a new or existing
-     * Project, specified by its Project ID. You can customize the use case, sub
-     * use case, and architecture type you want to use in the Project.
+     * Set project use case. Set the project use case for a new or existing Project, specified by its Project ID. You can customize the use case, sub use case, and architecture type you want to use in the Project.
      *
-     * @param request - The request
-     *   {@link ProjectApiSetProjectQualificationRequest}
+     * @param request - The request {@link ProjectApiSetProjectQualificationRequest}
      * @returns A Promise of ProjectQualification
      */
     setProjectQualification: (request?: Readonly<ProjectApiSetProjectQualificationRequest>) => Promise<ProjectQualification>;

package/dist/api/account/v3/api.gen.js

@@ -11,8 +11,7 @@ class ContractAPI extends API$1 {
   /**
    * Download a contract content.
    *
-   * @param request - The request
-   *   {@link ContractApiDownloadContractSignatureRequest}
+   * @param request - The request {@link ContractApiDownloadContractSignatureRequest}
    * @returns A Promise of Blob
    */
   downloadContractSignature = (request) => this.client.fetch({
@@ -22,11 +21,9 @@ class ContractAPI extends API$1 {
     responseType: "blob"
   });
   /**
-   * Create a signature for your Organization for the latest version of the
-   * requested contract.
+   * Create a signature for your Organization for the latest version of the requested contract.
    *
-   * @param request - The request
-   *   {@link ContractApiCreateContractSignatureRequest}
+   * @param request - The request {@link ContractApiCreateContractSignatureRequest}
    * @returns A Promise of ContractSignature
    */
   createContractSignature = (request) => this.client.fetch(
@@ -46,8 +43,7 @@ class ContractAPI extends API$1 {
   /**
    * Sign a contract for your Organization.
    *
-   * @param request - The request
-   *   {@link ContractApiValidateContractSignatureRequest}
+   * @param request - The request {@link ContractApiValidateContractSignatureRequest}
    * @returns A Promise of ContractSignature
    */
   validateContractSignature = (request) => this.client.fetch(
@@ -62,8 +58,7 @@ class ContractAPI extends API$1 {
   /**
    * Check if a contract is signed for your Organization.
    *
-   * @param request - The request
-   *   {@link ContractApiCheckContractSignatureRequest}
+   * @param request - The request {@link ContractApiCheckContractSignatureRequest}
    * @returns A Promise of CheckContractSignatureResponse
    */
   checkContractSignature = (request) => this.client.fetch(
@@ -102,8 +97,7 @@ class ContractAPI extends API$1 {
   /**
    * List contract signatures for an Organization.
    *
-   * @param request - The request
-   *   {@link ContractApiListContractSignaturesRequest}
+   * @param request - The request {@link ContractApiListContractSignaturesRequest}
    * @returns A Promise of ListContractSignaturesResponse
    */
   listContractSignatures = (request = {}) => enrichForPagination(
@@ -114,8 +108,7 @@ class ContractAPI extends API$1 {
 }
 class ProjectAPI extends API$1 {
   /**
-   * Create a new Project for an Organization. Generate a new Project for an
-   * Organization, specifying its configuration including name and description.
+   * Create a new Project for an Organization. Generate a new Project for an Organization, specifying its configuration including name and description.
    *
    * @param request - The request {@link ProjectApiCreateProjectRequest}
    * @returns A Promise of Project
@@ -153,19 +146,14 @@ class ProjectAPI extends API$1 {
     unmarshalListProjectsResponse
   );
   /**
-   * List all Projects of an Organization. List all Projects of an Organization.
-   * The response will include the total number of Projects as well as their
-   * associated Organizations, names, and IDs. Other information includes the
-   * creation and update date of the Project.
+   * List all Projects of an Organization. List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names, and IDs. Other information includes the creation and update date of the Project.
    *
    * @param request - The request {@link ProjectApiListProjectsRequest}
    * @returns A Promise of ListProjectsResponse
    */
   listProjects = (request = {}) => enrichForPagination("projects", this.pageOfListProjects, request);
   /**
-   * Get an existing Project. Retrieve information about an existing Project,
-   * specified by its Project ID. Its full details, including ID, name and
-   * description, are returned in the response object.
+   * Get an existing Project. Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
    *
    * @param request - The request {@link ProjectApiGetProjectRequest}
    * @returns A Promise of Project
@@ -178,10 +166,7 @@ class ProjectAPI extends API$1 {
     unmarshalProject
   );
   /**
-   * Delete an existing Project. Delete an existing Project, specified by its
-   * Project ID. The Project needs to be empty (meaning there are no resources
-   * left in it) to be deleted effectively. Note that deleting a Project is
-   * permanent, and cannot be undone.
+   * Delete an existing Project. Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
    *
    * @param request - The request {@link ProjectApiDeleteProjectRequest}
    */
@@ -190,8 +175,7 @@ class ProjectAPI extends API$1 {
     path: `/account/v3/projects/${validatePathParam("projectId", request.projectId ?? this.client.settings.defaultProjectId)}`
   });
   /**
-   * Update Project. Update the parameters of an existing Project, specified by
-   * its Project ID. These parameters include the name and description.
+   * Update Project. Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
    *
    * @param request - The request {@link ProjectApiUpdateProjectRequest}
    * @returns A Promise of Project
@@ -208,12 +192,9 @@ class ProjectAPI extends API$1 {
     unmarshalProject
   );
   /**
-   * Set project use case. Set the project use case for a new or existing
-   * Project, specified by its Project ID. You can customize the use case, sub
-   * use case, and architecture type you want to use in the Project.
+   * Set project use case. Set the project use case for a new or existing Project, specified by its Project ID. You can customize the use case, sub use case, and architecture type you want to use in the Project.
    *
-   * @param request - The request
-   *   {@link ProjectApiSetProjectQualificationRequest}
+   * @param request - The request {@link ProjectApiSetProjectQualificationRequest}
    * @returns A Promise of ProjectQualification
    */
   setProjectQualification = (request = {}) => this.client.fetch(