From 56cb327b8aaffea64e417e4959e26d18bc6aaa49 Mon Sep 17 00:00:00 2001
From: Scaleway Bot <github@scaleway.com>
Date: Mon, 4 Nov 2024 08:41:08 +0100
Subject: [PATCH] feat(iam): add doc for UpdateUserPassword (#1553)

Co-authored-by: Laure-di <62625835+Laure-di@users.noreply.github.com>
---
 packages/clients/src/api/iam/v1alpha1/api.gen.ts   | 6 ++++++
 packages/clients/src/api/iam/v1alpha1/types.gen.ts | 6 ++++++
 2 files changed, 12 insertions(+)

diff --git a/packages/clients/src/api/iam/v1alpha1/api.gen.ts b/packages/clients/src/api/iam/v1alpha1/api.gen.ts
index 0532fddcb..3f8bc0dd8 100644
--- a/packages/clients/src/api/iam/v1alpha1/api.gen.ts
+++ b/packages/clients/src/api/iam/v1alpha1/api.gen.ts
@@ -347,6 +347,12 @@ export class API extends ParentAPI {
       unmarshalUser,
     )
 
+  /**
+   * Update an user's password.
+   *
+   * @param request - The request {@link UpdateUserPasswordRequest}
+   * @returns A Promise of User
+   */
   updateUserPassword = (request: Readonly<UpdateUserPasswordRequest>) =>
     this.client.fetch<User>(
       {
diff --git a/packages/clients/src/api/iam/v1alpha1/types.gen.ts b/packages/clients/src/api/iam/v1alpha1/types.gen.ts
index d54393f37..233c6dddd 100644
--- a/packages/clients/src/api/iam/v1alpha1/types.gen.ts
+++ b/packages/clients/src/api/iam/v1alpha1/types.gen.ts
@@ -1079,8 +1079,14 @@ export type UpdateSSHKeyRequest = {
 }
 
 export type UpdateUserPasswordRequest = {
+  /** ID of the user to update. */
   userId: string
+  /** The new password. */
   password: string
+  /**
+   * Whether or not to send an email alerting the user their password has
+   * changed.
+   */
   sendEmail: boolean
 }