@scaleway/sdk 1.20.0 → 1.22.0

package/dist/index.d.ts

@@ -129,7 +129,7 @@ interface ResponseInterceptor {
  * @public
  */
 interface ResponseErrorInterceptor {
-    ({ request, error }: {
+    ({ request, error, }: {
         request: Request;
         error: unknown;
     }): unknown | Promise<unknown>;
@@ -1052,16 +1052,16 @@ declare const enrichForPagination: <K extends string, T extends PaginatedContent
     [Symbol.asyncIterator]: () => AsyncGenerator<T[K], void, void>;
 };
 
-type ListProjectsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+type ListProjectsRequestOrderBy$1 = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
 /** List projects response. */
-interface ListProjectsResponse {
+interface ListProjectsResponse$1 {
     /** Total number of Projects. */
     totalCount: number;
     /** Paginated returned Projects. */
-    projects: Project[];
+    projects: Project$1[];
 }
 /** Project. */
-interface Project {
+interface Project$1 {
     /** ID of the Project. */
     id: string;
     /** Name of the Project. */
@@ -1093,7 +1093,7 @@ type ListProjectsRequest = {
     /** Maximum number of Project per page. */
     pageSize?: number;
     /** Sort order of the returned Projects. */
-    orderBy?: ListProjectsRequestOrderBy;
+    orderBy?: ListProjectsRequestOrderBy$1;
     /**
      * Project IDs to filter for. The results will be limited to any Projects with
      * an ID in this array.
@@ -1123,25 +1123,175 @@ type UpdateProjectRequest = {
  * User related data. This API allows you to manage projects.
  */
 declare class API$r extends API$s {
+    /**
+     * Create a new Project for an Organization. Deprecated in favor of Account
+     * API v3. Generate a new Project for an Organization, specifying its
+     * configuration including name and description.
+     *
+     * @deprecated
+     * @param request - The request {@link CreateProjectRequest}
+     * @returns A Promise of Project
+     */
+    createProject: (request?: Readonly<CreateProjectRequest>) => Promise<Project$1>;
+    protected pageOfListProjects: (request?: Readonly<ListProjectsRequest>) => Promise<ListProjectsResponse$1>;
+    /**
+     * List all Projects of an Organization. Deprecated in favor of Account API
+     * v3. 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 include the creation and update date of the
+     * Project.
+     *
+     * @deprecated
+     * @param request - The request {@link ListProjectsRequest}
+     * @returns A Promise of ListProjectsResponse
+     */
+    listProjects: (request?: Readonly<ListProjectsRequest>) => Promise<ListProjectsResponse$1> & {
+        all: () => Promise<Project$1[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Project$1[], void, void>;
+    };
+    /**
+     * Get an existing Project. Deprecated in favor of Account API v3. 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.
+     *
+     * @deprecated
+     * @param request - The request {@link GetProjectRequest}
+     * @returns A Promise of Project
+     */
+    getProject: (request?: Readonly<GetProjectRequest>) => Promise<Project$1>;
+    /**
+     * Delete an existing Project. Deprecated in favor of Account API v3. 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.
+     *
+     * @deprecated
+     * @param request - The request {@link DeleteProjectRequest}
+     */
+    deleteProject: (request?: Readonly<DeleteProjectRequest>) => Promise<void>;
+    /**
+     * Update Project. Deprecated in favor of Account API v3. Update the
+     * parameters of an existing Project, specified by its Project ID. These
+     * parameters include the name and description.
+     *
+     * @deprecated
+     * @param request - The request {@link UpdateProjectRequest}
+     * @returns A Promise of Project
+     */
+    updateProject: (request?: Readonly<UpdateProjectRequest>) => Promise<Project$1>;
+}
+
+type index_gen$o_CreateProjectRequest = CreateProjectRequest;
+type index_gen$o_DeleteProjectRequest = DeleteProjectRequest;
+type index_gen$o_GetProjectRequest = GetProjectRequest;
+type index_gen$o_ListProjectsRequest = ListProjectsRequest;
+type index_gen$o_UpdateProjectRequest = UpdateProjectRequest;
+declare namespace index_gen$o {
+  export {
+    API$r as API,
+    index_gen$o_CreateProjectRequest as CreateProjectRequest,
+    index_gen$o_DeleteProjectRequest as DeleteProjectRequest,
+    index_gen$o_GetProjectRequest as GetProjectRequest,
+    index_gen$o_ListProjectsRequest as ListProjectsRequest,
+    ListProjectsRequestOrderBy$1 as ListProjectsRequestOrderBy,
+    ListProjectsResponse$1 as ListProjectsResponse,
+    Project$1 as Project,
+    index_gen$o_UpdateProjectRequest as UpdateProjectRequest,
+  };
+}
+
+type ListProjectsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+/** List projects response. */
+interface ListProjectsResponse {
+    /** Total number of Projects. */
+    totalCount: number;
+    /** Paginated returned Projects. */
+    projects: Project[];
+}
+/** Project. */
+interface Project {
+    /** ID of the Project. */
+    id: string;
+    /** Name of the Project. */
+    name: string;
+    /** Organization ID of the Project. */
+    organizationId: string;
+    /** Creation date of the Project. */
+    createdAt?: Date;
+    /** Update date of the Project. */
+    updatedAt?: Date;
+    /** Description of the Project. */
+    description: string;
+}
+type ProjectApiCreateProjectRequest$1 = {
+    /** Name of the Project. */
+    name?: string;
+    /** Organization ID of the Project. */
+    organizationId?: string;
+    /** Description of the Project. */
+    description: string;
+};
+type ProjectApiListProjectsRequest$1 = {
+    /** Organization ID of the Project. */
+    organizationId?: string;
+    /** Name of the Project. */
+    name?: string;
+    /** Page number for the returned Projects. */
+    page?: number;
+    /** Maximum number of Project per page. */
+    pageSize?: number;
+    /** 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.
+     */
+    projectIds?: string[];
+};
+type ProjectApiGetProjectRequest = {
+    /** Project ID of the Project. */
+    projectId?: string;
+};
+type ProjectApiDeleteProjectRequest = {
+    /** Project ID of the Project. */
+    projectId?: string;
+};
+type ProjectApiUpdateProjectRequest$1 = {
+    /** Project ID of the Project. */
+    projectId?: string;
+    /** Name of the Project. */
+    name?: string;
+    /** Description of the Project. */
+    description?: string;
+};
+
+/**
+ * Account API.
+ *
+ * This API allows you to manage projects.
+ */
+declare class ProjectAPI extends API$s {
     /**
      * 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 CreateProjectRequest}
+     * @param request - The request {@link ProjectApiCreateProjectRequest}
      * @returns A Promise of Project
      */
-    createProject: (request?: Readonly<CreateProjectRequest>) => Promise<Project>;
-    protected pageOfListProjects: (request?: Readonly<ListProjectsRequest>) => Promise<ListProjectsResponse>;
+    createProject: (request: Readonly<ProjectApiCreateProjectRequest$1>) => Promise<Project>;
+    protected pageOfListProjects: (request?: Readonly<ProjectApiListProjectsRequest$1>) => 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 include the
+     * associated Organizations, names, and IDs. Other information includes the
      * creation and update date of the Project.
      *
-     * @param request - The request {@link ListProjectsRequest}
+     * @param request - The request {@link ProjectApiListProjectsRequest}
      * @returns A Promise of ListProjectsResponse
      */
-    listProjects: (request?: Readonly<ListProjectsRequest>) => Promise<ListProjectsResponse> & {
+    listProjects: (request?: Readonly<ProjectApiListProjectsRequest$1>) => Promise<ListProjectsResponse> & {
         all: () => Promise<Project[]>;
         [Symbol.asyncIterator]: () => AsyncGenerator<Project[], void, void>;
     };
@@ -1150,54 +1300,101 @@ declare class API$r extends API$s {
      * specified by its Project ID. Its full details, including ID, name and
      * description, are returned in the response object.
      *
-     * @param request - The request {@link GetProjectRequest}
+     * @param request - The request {@link ProjectApiGetProjectRequest}
      * @returns A Promise of Project
      */
-    getProject: (request?: Readonly<GetProjectRequest>) => Promise<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.
      *
-     * @param request - The request {@link DeleteProjectRequest}
+     * @param request - The request {@link ProjectApiDeleteProjectRequest}
      */
-    deleteProject: (request?: Readonly<DeleteProjectRequest>) => Promise<void>;
+    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.
      *
-     * @param request - The request {@link UpdateProjectRequest}
+     * @param request - The request {@link ProjectApiUpdateProjectRequest}
      * @returns A Promise of Project
      */
-    updateProject: (request?: Readonly<UpdateProjectRequest>) => Promise<Project>;
+    updateProject: (request?: Readonly<ProjectApiUpdateProjectRequest$1>) => Promise<Project>;
+}
+
+declare const ProjectApiCreateProjectRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+declare const ProjectApiListProjectsRequest: {
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+    page: {
+        greaterThan: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+declare const ProjectApiUpdateProjectRequest: {
+    description: {
+        maxLength: number;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+        pattern: RegExp;
+    };
+};
+
+declare const validationRules_gen$6_ProjectApiCreateProjectRequest: typeof ProjectApiCreateProjectRequest;
+declare const validationRules_gen$6_ProjectApiListProjectsRequest: typeof ProjectApiListProjectsRequest;
+declare const validationRules_gen$6_ProjectApiUpdateProjectRequest: typeof ProjectApiUpdateProjectRequest;
+declare namespace validationRules_gen$6 {
+  export {
+    validationRules_gen$6_ProjectApiCreateProjectRequest as ProjectApiCreateProjectRequest,
+    validationRules_gen$6_ProjectApiListProjectsRequest as ProjectApiListProjectsRequest,
+    validationRules_gen$6_ProjectApiUpdateProjectRequest as ProjectApiUpdateProjectRequest,
+  };
 }
 
-type index_gen$n_CreateProjectRequest = CreateProjectRequest;
-type index_gen$n_DeleteProjectRequest = DeleteProjectRequest;
-type index_gen$n_GetProjectRequest = GetProjectRequest;
-type index_gen$n_ListProjectsRequest = ListProjectsRequest;
 type index_gen$n_ListProjectsRequestOrderBy = ListProjectsRequestOrderBy;
 type index_gen$n_ListProjectsResponse = ListProjectsResponse;
 type index_gen$n_Project = Project;
-type index_gen$n_UpdateProjectRequest = UpdateProjectRequest;
+type index_gen$n_ProjectAPI = ProjectAPI;
+declare const index_gen$n_ProjectAPI: typeof ProjectAPI;
+type index_gen$n_ProjectApiDeleteProjectRequest = ProjectApiDeleteProjectRequest;
+type index_gen$n_ProjectApiGetProjectRequest = ProjectApiGetProjectRequest;
 declare namespace index_gen$n {
   export {
-    API$r as API,
-    index_gen$n_CreateProjectRequest as CreateProjectRequest,
-    index_gen$n_DeleteProjectRequest as DeleteProjectRequest,
-    index_gen$n_GetProjectRequest as GetProjectRequest,
-    index_gen$n_ListProjectsRequest as ListProjectsRequest,
     index_gen$n_ListProjectsRequestOrderBy as ListProjectsRequestOrderBy,
     index_gen$n_ListProjectsResponse as ListProjectsResponse,
     index_gen$n_Project as Project,
-    index_gen$n_UpdateProjectRequest as UpdateProjectRequest,
+    index_gen$n_ProjectAPI as ProjectAPI,
+    ProjectApiCreateProjectRequest$1 as ProjectApiCreateProjectRequest,
+    index_gen$n_ProjectApiDeleteProjectRequest as ProjectApiDeleteProjectRequest,
+    index_gen$n_ProjectApiGetProjectRequest as ProjectApiGetProjectRequest,
+    ProjectApiListProjectsRequest$1 as ProjectApiListProjectsRequest,
+    ProjectApiUpdateProjectRequest$1 as ProjectApiUpdateProjectRequest,
+    validationRules_gen$6 as ValidationRules,
   };
 }
 
 declare namespace index$t {
   export {
-    index_gen$n as v2,
+    index_gen$o as v2,
+    index_gen$n as v3,
   };
 }
 
@@ -8705,6 +8902,12 @@ type DeleteUserRequest$1 = {
     /** ID of the user to delete. */
     userId: string;
 };
+type CreateUserRequest$1 = {
+    /** ID of the Organization. */
+    organizationId?: string;
+    /** Email of the user. */
+    email: string;
+};
 type ListApplicationsRequest$1 = {
     /** Criteria for sorting results. */
     orderBy?: ListApplicationsRequestOrderBy;
@@ -9159,6 +9362,14 @@ declare class API$i extends API$s {
      * @param request - The request {@link DeleteUserRequest}
      */
     deleteUser: (request: Readonly<DeleteUserRequest$1>) => Promise<void>;
+    /**
+     * Create a new user. Create a new user. You must define the `organization_id`
+     * and the `email` in your request.
+     *
+     * @param request - The request {@link CreateUserRequest}
+     * @returns A Promise of User
+     */
+    createUser: (request: Readonly<CreateUserRequest$1>) => Promise<User$1>;
     protected pageOfListApplications: (request?: Readonly<ListApplicationsRequest$1>) => Promise<ListApplicationsResponse>;
     /**
      * List applications of an Organization. List the applications of an
@@ -9820,6 +10031,7 @@ declare namespace index_gen$f {
     CreateGroupRequest$1 as CreateGroupRequest,
     CreatePolicyRequest$1 as CreatePolicyRequest,
     CreateSSHKeyRequest$1 as CreateSSHKeyRequest,
+    CreateUserRequest$1 as CreateUserRequest,
     index_gen$f_DeleteAPIKeyRequest as DeleteAPIKeyRequest,
     index_gen$f_DeleteApplicationRequest as DeleteApplicationRequest,
     index_gen$f_DeleteGroupRequest as DeleteGroupRequest,
@@ -10751,6 +10963,11 @@ type ListServersRequest = {
     privateNetwork?: string;
     /** Define the order of the returned servers. */
     order?: ListServersRequestOrder;
+    /**
+     * List Instances from the given Private Networks (use commas to separate
+     * them).
+     */
+    privateNetworks?: string[];
 };
 type DeleteServerRequest = {
     /** Zone to target. If none is passed will use default zone from the config. */
@@ -14733,6 +14950,10 @@ interface ClusterType {
     sla: number;
     /** Resiliency offered by the offer. */
     resiliency: ClusterTypeResiliency;
+    /** Max RAM allowed for the control plane. */
+    memory: number;
+    /** Returns information if this offer uses dedicated resources. */
+    dedicated: boolean;
 }
 /** Create cluster request. auto upgrade. */
 interface CreateClusterRequestAutoUpgrade {
@@ -21188,7 +21409,7 @@ type NodeTypeGeneration = 'unknown_generation' | 'generation_v1' | 'generation_v
 type NodeTypeStock$1 = 'unknown' | 'low_stock' | 'out_of_stock' | 'available';
 type Permission = 'readonly' | 'readwrite' | 'all' | 'custom' | 'none';
 /** Read replica. status. */
-type ReadReplicaStatus = 'unknown' | 'provisioning' | 'initializing' | 'ready' | 'deleting' | 'error' | 'locked' | 'configuring';
+type ReadReplicaStatus = 'unknown' | 'provisioning' | 'initializing' | 'ready' | 'deleting' | 'error' | 'locked' | 'configuring' | 'promoting';
 type SnapshotStatus = 'unknown' | 'creating' | 'ready' | 'restoring' | 'deleting' | 'error' | 'locked';
 type VolumeType = 'lssd' | 'bssd';
 interface ACLRule$1 {
@@ -22164,6 +22385,15 @@ type ResetReadReplicaRequest = {
     /** UUID of the Read Replica. */
     readReplicaId: string;
 };
+type PromoteReadReplicaRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the
+     * config.
+     */
+    region?: Region;
+    /** UUID of the Read Replica. */
+    readReplicaId: string;
+};
 type CreateReadReplicaEndpointRequest = {
     /**
      * Region to target. If none is passed will use default region from the
@@ -22829,6 +23059,14 @@ declare class API$9 extends API$s {
      * @returns A Promise of ReadReplica
      */
     resetReadReplica: (request: Readonly<ResetReadReplicaRequest>) => Promise<ReadReplica>;
+    /**
+     * Promote a Read Replica. Promote a Read Replica to Database Instance
+     * automatically.
+     *
+     * @param request - The request {@link PromoteReadReplicaRequest}
+     * @returns A Promise of Instance
+     */
+    promoteReadReplica: (request: Readonly<PromoteReadReplicaRequest>) => Promise<Instance>;
     /**
      * Create an endpoint for a Read Replica. Create a new endpoint for a Read
      * Replica. Read Replicas can have at most one direct access and one Private
@@ -23289,6 +23527,7 @@ type index_gen$9_Permission = Permission;
 type index_gen$9_PrepareInstanceLogsRequest = PrepareInstanceLogsRequest;
 type index_gen$9_PrepareInstanceLogsResponse = PrepareInstanceLogsResponse;
 type index_gen$9_Privilege = Privilege;
+type index_gen$9_PromoteReadReplicaRequest = PromoteReadReplicaRequest;
 type index_gen$9_PurgeInstanceLogsRequest = PurgeInstanceLogsRequest;
 declare const index_gen$9_READ_REPLICA_TRANSIENT_STATUSES: typeof READ_REPLICA_TRANSIENT_STATUSES;
 type index_gen$9_ReadReplica = ReadReplica;
@@ -23428,6 +23667,7 @@ declare namespace index_gen$9 {
     index_gen$9_PrepareInstanceLogsRequest as PrepareInstanceLogsRequest,
     index_gen$9_PrepareInstanceLogsResponse as PrepareInstanceLogsResponse,
     index_gen$9_Privilege as Privilege,
+    index_gen$9_PromoteReadReplicaRequest as PromoteReadReplicaRequest,
     index_gen$9_PurgeInstanceLogsRequest as PurgeInstanceLogsRequest,
     index_gen$9_READ_REPLICA_TRANSIENT_STATUSES as READ_REPLICA_TRANSIENT_STATUSES,
     index_gen$9_ReadReplica as ReadReplica,
@@ -24859,7 +25099,7 @@ declare namespace index$6 {
 type ListSecretsRequestOrderBy = 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
 type Product = 'unknown';
 type SecretStatus = 'ready' | 'locked';
-type SecretType = 'unknown_secret_type' | 'opaque' | 'network_edge_certificate';
+type SecretType = 'unknown_secret_type' | 'opaque' | 'certificate';
 type SecretVersionStatus = 'unknown' | 'enabled' | 'disabled' | 'destroyed';
 /** Access secret version response. */
 interface AccessSecretVersionResponse {
@@ -25846,6 +26086,7 @@ declare namespace index$4 {
 
 type DomainLastStatusRecordStatus = 'unknown_record_status' | 'valid' | 'invalid' | 'not_found';
 type DomainStatus = 'unknown' | 'checked' | 'unchecked' | 'invalid' | 'locked' | 'revoked' | 'pending';
+type EmailFlag = 'unknown_flag' | 'soft_bounce' | 'hard_bounce' | 'spam';
 type EmailRcptType = 'unknown_rcpt_type' | 'to' | 'cc' | 'bcc';
 type EmailStatus = 'unknown' | 'new' | 'sending' | 'sent' | 'failed' | 'canceled';
 type ListEmailsRequestOrderBy = 'created_at_desc' | 'created_at_asc' | 'updated_at_desc' | 'updated_at_asc' | 'status_desc' | 'status_asc' | 'mail_from_desc' | 'mail_from_asc' | 'mail_rcpt_desc' | 'mail_rcpt_asc' | 'subject_desc' | 'subject_asc';
@@ -25965,6 +26206,11 @@ interface Email {
     tryCount: number;
     /** Information about the last three attempts to send the email. */
     lastTries: EmailTry[];
+    /**
+     * Flags categorize emails. They allow you to obtain more information about
+     * recurring errors, for example.
+     */
+    flags: EmailFlag[];
 }
 /** Email. try. */
 interface EmailTry {
@@ -26094,6 +26340,8 @@ type ListEmailsRequest = {
     search?: string;
     /** (Optional) List emails corresponding to specific criteria. */
     orderBy?: ListEmailsRequestOrderBy;
+    /** (Optional) List emails containing only specific flags. */
+    flags?: EmailFlag[];
 };
 type GetStatisticsRequest = {
     /**
@@ -26333,6 +26581,7 @@ type index_gen$4_DomainStatistics = DomainStatistics;
 type index_gen$4_DomainStatus = DomainStatus;
 declare const index_gen$4_EMAIL_TRANSIENT_STATUSES: typeof EMAIL_TRANSIENT_STATUSES;
 type index_gen$4_Email = Email;
+type index_gen$4_EmailFlag = EmailFlag;
 type index_gen$4_EmailRcptType = EmailRcptType;
 type index_gen$4_EmailStatus = EmailStatus;
 type index_gen$4_EmailTry = EmailTry;
@@ -26367,6 +26616,7 @@ declare namespace index_gen$4 {
     index_gen$4_DomainStatus as DomainStatus,
     index_gen$4_EMAIL_TRANSIENT_STATUSES as EMAIL_TRANSIENT_STATUSES,
     index_gen$4_Email as Email,
+    index_gen$4_EmailFlag as EmailFlag,
     index_gen$4_EmailRcptType as EmailRcptType,
     index_gen$4_EmailStatus as EmailStatus,
     index_gen$4_EmailTry as EmailTry,

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = 'v1.19.0';
+const version = 'v1.21.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 export { userAgent, version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -35,5 +35,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "3e5285da8a27a10f9795d32e271aa06514cbf6cb"
+  "gitHead": "66cde1e17baccf8720e9ce92e0a3688295d2be12"
 }