Merge branch 'main' into v1.5756.0

Author: Codelax

packages/clients/src/api/iam/v1alpha1/api.gen.ts

@@ -34,6 +34,7 @@ import {
   unmarshalJWT,
   unmarshalListAPIKeysResponse,
   unmarshalListApplicationsResponse,
+  unmarshalListGracePeriodsResponse,
   unmarshalListGroupsResponse,
   unmarshalListJWTsResponse,
   unmarshalListLogsResponse,
@@ -86,6 +87,8 @@ import type {
   ListAPIKeysResponse,
   ListApplicationsRequest,
   ListApplicationsResponse,
+  ListGracePeriodsRequest,
+  ListGracePeriodsResponse,
   ListGroupsRequest,
   ListGroupsResponse,
   ListJWTsRequest,
@@ -401,6 +404,22 @@ export class API extends ParentAPI {
       unmarshalUser,
     )
 
+  /**
+   * List grace periods of a user. List the grace periods of a user.
+   *
+   * @param request - The request {@link ListGracePeriodsRequest}
+   * @returns A Promise of ListGracePeriodsResponse
+   */
+  listGracePeriods = (request: Readonly<ListGracePeriodsRequest> = {}) =>
+    this.client.fetch<ListGracePeriodsResponse>(
+      {
+        method: 'GET',
+        path: `/iam/v1alpha1/grace-periods`,
+        urlParams: urlParams(['user_id', request.userId]),
+      },
+      unmarshalListGracePeriodsResponse,
+    )
+
   protected pageOfListApplications = (
     request: Readonly<ListApplicationsRequest> = {},
   ) =>

packages/clients/src/api/iam/v1alpha1/marshalling.gen.ts

@@ -22,10 +22,12 @@ import type {
   CreateUserRequest,
   CreateUserRequestMember,
   EncodedJWT,
+  GracePeriod,
   Group,
   JWT,
   ListAPIKeysResponse,
   ListApplicationsResponse,
+  ListGracePeriodsResponse,
   ListGroupsResponse,
   ListJWTsResponse,
   ListLogsResponse,
@@ -302,6 +304,37 @@ export const unmarshalListApplicationsResponse = (
   } as ListApplicationsResponse
 }
 
+const unmarshalGracePeriod = (data: unknown): GracePeriod => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'GracePeriod' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    expiresAt: unmarshalDate(data.expires_at),
+    type: data.type,
+  } as GracePeriod
+}
+
+export const unmarshalListGracePeriodsResponse = (
+  data: unknown,
+): ListGracePeriodsResponse => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListGracePeriodsResponse' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    gracePeriods: unmarshalArrayOfObject(
+      data.grace_periods,
+      unmarshalGracePeriod,
+    ),
+  } as ListGracePeriodsResponse
+}
+
 export const unmarshalListGroupsResponse = (
   data: unknown,
 ): ListGroupsResponse => {

packages/clients/src/api/iam/v1alpha1/types.gen.ts

@@ -3,6 +3,11 @@
 
 export type BearerType = 'unknown_bearer_type' | 'user' | 'application'
 
+export type GracePeriodType =
+  | 'unknown_grace_period_type'
+  | 'update_password'
+  | 'set_mfa'
+
 export type ListAPIKeysRequestOrderBy =
   | 'created_at_asc'
   | 'created_at_desc'
@@ -207,6 +212,15 @@ export interface Application {
   tags: string[]
 }
 
+export interface GracePeriod {
+  /** Type of grace period. */
+  type: GracePeriodType
+  /** Date and time the grace period was created. */
+  createdAt?: Date
+  /** Date and time the grace period expires. */
+  expiresAt?: Date
+}
+
 export interface Group {
   /** ID of the group. */
   id: string
@@ -749,6 +763,16 @@ export interface ListApplicationsResponse {
   totalCount: number
 }
 
+export type ListGracePeriodsRequest = {
+  /** ID of the user to list grace periods for. */
+  userId?: string
+}
+
+export interface ListGracePeriodsResponse {
+  /** List of grace periods. */
+  gracePeriods: GracePeriod[]
+}
+
 export type ListGroupsRequest = {
   /** Sort order of groups. */
   orderBy?: ListGroupsRequestOrderBy
@@ -960,6 +984,7 @@ export interface ListUsersResponse {
 }
 
 export type LockUserRequest = {
+  /** ID of the user to lock. */
   userId: string
 }
 
@@ -999,6 +1024,7 @@ export interface SetRulesResponse {
 }
 
 export type UnlockUserRequest = {
+  /** ID of the user to unlock. */
   userId: string
 }
 

packages/clients/src/api/instance/v1/api.gen.ts

@@ -456,10 +456,17 @@ export class API extends ParentAPI {
    * for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new
    * network stack.
    *
-   * Keep in mind that `terminate` an Instance will result in the deletion of
-   * `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type
-   * will only be detached. If you want to preserve your volumes, you should
-   * detach them before the Instance deletion or `terminate` action.
+   * The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and
+   * `scratch` volumes types, `sbs_volume` volumes type will only be detached.
+   * If you want to preserve your volumes, you should detach them before the
+   * Instance deletion or `terminate` action.
+   *
+   * The `backup` action can be done with: No `volumes` key in the body: an
+   * image is created with snapshots of all the server volumes, except for the
+   * `scratch` volumes types. `volumes` key in the body with a dictionary as
+   * value, in this dictionary volumes UUID as keys and empty dictionaries as
+   * values : an image is created with the snapshots of the volumes in `volumes`
+   * key. `scratch` volumes types can't be shapshotted.
    *
    * @param request - The request {@link ServerActionRequest}
    * @returns A Promise of ServerActionResponse
@@ -1529,13 +1536,22 @@ export class API extends ParentAPI {
 
   /**
    * Get a volume or snapshot's migration plan. Given a volume or snapshot,
-   * returns the migration plan for a call to the "Apply a migration plan"
-   * endpoint. This plan will include zero or one volume, and zero or more
-   * snapshots, which will need to be migrated together. This endpoint does not
-   * perform the actual migration itself, the "Apply a migration plan" endpoint
-   * must be used. The validation_key value returned by this endpoint must be
-   * provided to the call to the "Apply a migration plan" endpoint to confirm
-   * that all resources listed in the plan should be migrated.
+   * returns the migration plan but does not perform the actual migration. To
+   * perform the migration, you have to call the [Migrate a volume and/or
+   * snapshots to
+   * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage)
+   * endpoint afterward. The endpoint returns the resources that should be
+   * migrated together:
+   *
+   * - The volume and any snapshots created from the volume, if the call was made
+   *   to plan a volume migration.
+   * - The base volume of the snapshot (if the volume is not deleted) and its
+   *   related snapshots, if the call was made to plan a snapshot migration. The
+   *   endpoint also returns the validation_key, which must be provided to the
+   *   [Migrate a volume and/or snapshots to
+   *   SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage)
+   *   endpoint to confirm that all resources listed in the plan should be
+   *   migrated.
    *
    * @param request - The request {@link PlanBlockMigrationRequest}
    * @returns A Promise of MigrationPlan
@@ -1555,9 +1571,11 @@ export class API extends ParentAPI {
 
   /**
    * Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be
-   * used, the call to this endpoint must be preceded by a call to the "Plan a
-   * migration" endpoint. To migrate all resources mentioned in the migration
-   * plan, the validation_key returned in the plan must be provided.
+   * used, the call to this endpoint must be preceded by a call to the [Get a
+   * volume or snapshot's migration
+   * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To
+   * migrate all resources mentioned in the migration plan, the validation_key
+   * returned in the plan must be provided.
    *
    * @param request - The request {@link ApplyBlockMigrationRequest}
    */

packages/clients/src/api/instance/v1/types.gen.ts

@@ -763,24 +763,27 @@ export type ApplyBlockMigrationRequest = {
   zone?: Zone
   /**
    * The volume to migrate, along with potentially other resources, according to
-   * the migration plan generated with a call to the "Plan a migration"
+   * the migration plan generated with a call to the [Get a volume or snapshot's
+   * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan)
    * endpoint.
    *
    * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set.
    */
   volumeId?: string
   /**
    * The snapshot to migrate, along with potentially other resources, according
-   * to the migration plan generated with a call to the "Plan a migration"
-   * endpoint.
+   * to the migration plan generated with a call to the [Get a volume or
+   * snapshot's migration
+   * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint.
    *
    * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set.
    */
   snapshotId?: string
   /**
-   * A value to be retrieved from a call to the "Plan a migration" endpoint, to
-   * confirm that the volume and/or snapshots specified in said plan should be
-   * migrated.
+   * A value to be retrieved from a call to the [Get a volume or snapshot's
+   * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan)
+   * endpoint, to confirm that the volume and/or snapshots specified in said
+   * plan should be migrated.
    */
   validationKey: string
 }
@@ -1725,8 +1728,10 @@ export interface MigrationPlan {
    */
   snapshots: Snapshot[]
   /**
-   * A value to be passed to the call to the "Apply a migration plan" endpoint,
-   * to confirm that the execution of the plan is being requested.
+   * A value to be passed to the call to the [Migrate a volume and/or snapshots
+   * to
+   * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage)
+   * endpoint, to confirm that the execution of the plan is being requested.
    */
   validationKey: string
 }