Skip to content

Commit 87ce12f

Browse files
committed
feat: update generated APIs
1 parent a2946f9 commit 87ce12f

File tree

4 files changed

+22
-20
lines changed

4 files changed

+22
-20
lines changed

scaleway-async/scaleway_async/iam/v1alpha1/api.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ async def update_user(
483483
Update the parameters of a user, including `tags`.
484484
:param user_id: ID of the user to update.
485485
:param tags: New tags for the user (maximum of 10 tags).
486-
:param email: New email for the user (only available on Members).
486+
:param email: IAM member email.
487487
:return: :class:`User <User>`
488488
489489
Usage:
@@ -554,7 +554,7 @@ async def create_user(
554554
:param email: Email of the user.
555555
One-Of ('type'): at most one of 'email', 'member' could be set.
556556
:param tags: Tags associated with the user.
557-
:param member: A new IAM Member to create.
557+
:param member: Details of IAM member. Private Beta feature.
558558
One-Of ('type'): at most one of 'email', 'member' could be set.
559559
:return: :class:`User <User>`
560560
@@ -589,7 +589,7 @@ async def update_user_password(
589589
send_email: bool,
590590
) -> User:
591591
"""
592-
Update an user's password.
592+
Update an user's password. Private Beta feature.
593593
:param user_id: ID of the user to update.
594594
:param password: The new password.
595595
:param send_email: Whether or not to send an email alerting the user their password has changed.
@@ -629,8 +629,8 @@ async def lock_user(
629629
user_id: str,
630630
) -> User:
631631
"""
632-
Lock a user.
633-
Lock a user. Note that a locked user cannot log in or use API keys until the locked status is removed.
632+
Lock a member.
633+
Lock a member. A locked member cannot log in or use API keys until the locked status is removed. Private Beta feature.
634634
:param user_id: ID of the user to lock.
635635
:return: :class:`User <User>`
636636
@@ -659,7 +659,8 @@ async def unlock_user(
659659
user_id: str,
660660
) -> User:
661661
"""
662-
Unlock a user.
662+
Unlock a member.
663+
Unlock a member. Private Beta feature.
663664
:param user_id: ID of the user to unlock.
664665
:return: :class:`User <User>`
665666
@@ -688,8 +689,8 @@ async def list_grace_periods(
688689
user_id: Optional[str] = None,
689690
) -> ListGracePeriodsResponse:
690691
"""
691-
List grace periods of a user.
692-
List the grace periods of a user.
692+
List grace periods of a member.
693+
List the grace periods of a member. Private Beta feature.
693694
:param user_id: ID of the user to list grace periods for.
694695
:return: :class:`ListGracePeriodsResponse <ListGracePeriodsResponse>`
695696
@@ -2018,7 +2019,7 @@ async def create_api_key(
20182019
) -> APIKey:
20192020
"""
20202021
Create an API key.
2021-
Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe.
2022+
Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id`, which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that the secret key is only shown once. Make sure that you copy and store both keys somewhere safe.
20222023
:param description: Description of the API key (max length is 200 characters).
20232024
:param application_id: ID of the application.
20242025
One-Of ('bearer'): at most one of 'application_id', 'user_id' could be set.

scaleway-async/scaleway_async/iam/v1alpha1/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1939,5 +1939,5 @@ class UpdateUserRequest:
19391939

19401940
email: Optional[str]
19411941
"""
1942-
New email for the user (only available on Members).
1942+
IAM member email.
19431943
"""

scaleway/scaleway/iam/v1alpha1/api.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ def update_user(
483483
Update the parameters of a user, including `tags`.
484484
:param user_id: ID of the user to update.
485485
:param tags: New tags for the user (maximum of 10 tags).
486-
:param email: New email for the user (only available on Members).
486+
:param email: IAM member email.
487487
:return: :class:`User <User>`
488488
489489
Usage:
@@ -554,7 +554,7 @@ def create_user(
554554
:param email: Email of the user.
555555
One-Of ('type'): at most one of 'email', 'member' could be set.
556556
:param tags: Tags associated with the user.
557-
:param member: A new IAM Member to create.
557+
:param member: Details of IAM member. Private Beta feature.
558558
One-Of ('type'): at most one of 'email', 'member' could be set.
559559
:return: :class:`User <User>`
560560
@@ -589,7 +589,7 @@ def update_user_password(
589589
send_email: bool,
590590
) -> User:
591591
"""
592-
Update an user's password.
592+
Update an user's password. Private Beta feature.
593593
:param user_id: ID of the user to update.
594594
:param password: The new password.
595595
:param send_email: Whether or not to send an email alerting the user their password has changed.
@@ -629,8 +629,8 @@ def lock_user(
629629
user_id: str,
630630
) -> User:
631631
"""
632-
Lock a user.
633-
Lock a user. Note that a locked user cannot log in or use API keys until the locked status is removed.
632+
Lock a member.
633+
Lock a member. A locked member cannot log in or use API keys until the locked status is removed. Private Beta feature.
634634
:param user_id: ID of the user to lock.
635635
:return: :class:`User <User>`
636636
@@ -659,7 +659,8 @@ def unlock_user(
659659
user_id: str,
660660
) -> User:
661661
"""
662-
Unlock a user.
662+
Unlock a member.
663+
Unlock a member. Private Beta feature.
663664
:param user_id: ID of the user to unlock.
664665
:return: :class:`User <User>`
665666
@@ -688,8 +689,8 @@ def list_grace_periods(
688689
user_id: Optional[str] = None,
689690
) -> ListGracePeriodsResponse:
690691
"""
691-
List grace periods of a user.
692-
List the grace periods of a user.
692+
List grace periods of a member.
693+
List the grace periods of a member. Private Beta feature.
693694
:param user_id: ID of the user to list grace periods for.
694695
:return: :class:`ListGracePeriodsResponse <ListGracePeriodsResponse>`
695696
@@ -2018,7 +2019,7 @@ def create_api_key(
20182019
) -> APIKey:
20192020
"""
20202021
Create an API key.
2021-
Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe.
2022+
Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id`, which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that the secret key is only shown once. Make sure that you copy and store both keys somewhere safe.
20222023
:param description: Description of the API key (max length is 200 characters).
20232024
:param application_id: ID of the application.
20242025
One-Of ('bearer'): at most one of 'application_id', 'user_id' could be set.

scaleway/scaleway/iam/v1alpha1/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1939,5 +1939,5 @@ class UpdateUserRequest:
19391939

19401940
email: Optional[str]
19411941
"""
1942-
New email for the user (only available on Members).
1942+
IAM member email.
19431943
"""

0 commit comments

Comments
 (0)