@scaleway/sdk 2.71.1 → 2.72.0

package/dist/api/iam/v1alpha1/api.gen.d.ts

@@ -1,18 +1,14 @@
-import { API as ParentAPI } from '../../../bridge';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { APIKey, AddGroupMemberRequest, AddGroupMembersRequest, Application, ClonePolicyRequest, CreateAPIKeyRequest, CreateApplicationRequest, CreateGroupRequest, CreateJWTRequest, CreatePolicyRequest, CreateSSHKeyRequest, CreateUserMFAOTPRequest, CreateUserRequest, DeleteAPIKeyRequest, DeleteApplicationRequest, DeleteGroupRequest, DeleteJWTRequest, DeletePolicyRequest, DeleteSSHKeyRequest, DeleteUserMFAOTPRequest, DeleteUserRequest, EncodedJWT, GetAPIKeyRequest, GetApplicationRequest, GetGroupRequest, GetJWTRequest, GetLogRequest, GetOrganizationSecuritySettingsRequest, GetPolicyRequest, GetQuotumRequest, GetSSHKeyRequest, GetUserConnectionsRequest, GetUserConnectionsResponse, GetUserRequest, Group, JWT, ListAPIKeysRequest, ListAPIKeysResponse, ListApplicationsRequest, ListApplicationsResponse, ListGracePeriodsRequest, ListGracePeriodsResponse, ListGroupsRequest, ListGroupsResponse, ListJWTsRequest, ListJWTsResponse, ListLogsRequest, ListLogsResponse, ListPermissionSetsRequest, ListPermissionSetsResponse, ListPoliciesRequest, ListPoliciesResponse, ListQuotaRequest, ListQuotaResponse, ListRulesRequest, ListRulesResponse, ListSSHKeysRequest, ListSSHKeysResponse, ListUsersRequest, ListUsersResponse, LockUserRequest, Log, MFAOTP, OrganizationSecuritySettings, Policy, Quotum, RemoveGroupMemberRequest, SSHKey, SetGroupMembersRequest, SetRulesRequest, SetRulesResponse, UnlockUserRequest, UpdateAPIKeyRequest, UpdateApplicationRequest, UpdateGroupRequest, UpdateOrganizationSecuritySettingsRequest, UpdatePolicyRequest, UpdateSSHKeyRequest, UpdateUserPasswordRequest, UpdateUserRequest, UpdateUserUsernameRequest, User, ValidateUserMFAOTPRequest, ValidateUserMFAOTPResponse } from './types.gen';
 /**
  * IAM API.
- *
- * This API allows you to manage Identity and Access Management (IAM) across
- * your Scaleway Organizations, Projects and resources.
+
+This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources.
  */
 export declare class API extends ParentAPI {
     protected pageOfListSSHKeys: (request?: Readonly<ListSSHKeysRequest>) => Promise<ListSSHKeysResponse>;
     /**
-     * List SSH keys. List SSH keys. By default, the SSH keys listed are ordered
-     * by creation date in ascending order. This can be modified via the
-     * `order_by` field. You can define additional parameters for your query such
-     * as `organization_id`, `name`, `project_id` and `disabled`.
+     * List SSH keys. List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`.
      *
      * @param request - The request {@link ListSSHKeysRequest}
      * @returns A Promise of ListSSHKeysResponse
@@ -22,45 +18,35 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<SSHKey[], void, void>;
     };
     /**
-     * Create an SSH key. Add a new SSH key to a Scaleway Project. You must
-     * specify the `name`, `public_key` and `project_id`.
+     * Create an SSH key. Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`.
      *
      * @param request - The request {@link CreateSSHKeyRequest}
      * @returns A Promise of SSHKey
      */
     createSSHKey: (request: Readonly<CreateSSHKeyRequest>) => Promise<SSHKey>;
     /**
-     * Get an SSH key. Retrieve information about a given SSH key, specified by
-     * the `ssh_key_id` parameter. The SSH key's full details, including `id`,
-     * `name`, `public_key`, and `project_id` are returned in the response.
+     * Get an SSH key. Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response.
      *
      * @param request - The request {@link GetSSHKeyRequest}
      * @returns A Promise of SSHKey
      */
     getSSHKey: (request: Readonly<GetSSHKeyRequest>) => Promise<SSHKey>;
     /**
-     * Update an SSH key. Update the parameters of an SSH key, including `name`
-     * and `disable`.
+     * Update an SSH key. Update the parameters of an SSH key, including `name` and `disable`.
      *
      * @param request - The request {@link UpdateSSHKeyRequest}
      * @returns A Promise of SSHKey
      */
     updateSSHKey: (request: Readonly<UpdateSSHKeyRequest>) => Promise<SSHKey>;
     /**
-     * Delete an SSH key. Delete a given SSH key, specified by the `ssh_key_id`.
-     * Deleting an SSH is permanent, and cannot be undone. Note that you might
-     * need to update any configurations that used the SSH key.
+     * Delete an SSH key. Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key.
      *
      * @param request - The request {@link DeleteSSHKeyRequest}
      */
     deleteSSHKey: (request: Readonly<DeleteSSHKeyRequest>) => Promise<void>;
     protected pageOfListUsers: (request?: Readonly<ListUsersRequest>) => Promise<ListUsersResponse>;
     /**
-     * List users of an Organization. List the users of an Organization. By
-     * default, the users listed are ordered by creation date in ascending order.
-     * This can be modified via the `order_by` field. You must define the
-     * `organization_id` in the query path of your request. You can also define
-     * additional parameters for your query such as `user_ids`.
+     * List users of an Organization. List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`.
      *
      * @param request - The request {@link ListUsersRequest}
      * @returns A Promise of ListUsersResponse
@@ -70,9 +56,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<User[], void, void>;
     };
     /**
-     * Get a given user. Retrieve information about a user, specified by the
-     * `user_id` parameter. The user's full details, including `id`, `email`,
-     * `organization_id`, `status` and `mfa` are returned in the response.
+     * Get a given user. Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `mfa` are returned in the response.
      *
      * @param request - The request {@link GetUserRequest}
      * @returns A Promise of User
@@ -86,18 +70,13 @@ export declare class API extends ParentAPI {
      */
     updateUser: (request: Readonly<UpdateUserRequest>) => Promise<User>;
     /**
-     * Delete a guest user from an Organization. Remove a user from an
-     * Organization in which they are a guest. You must define the `user_id` in
-     * your request. Note that removing a user from an Organization automatically
-     * deletes their API keys, and any policies directly attached to them become
-     * orphaned.
+     * Delete a guest user from an Organization. Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned.
      *
      * @param request - The request {@link DeleteUserRequest}
      */
     deleteUser: (request: Readonly<DeleteUserRequest>) => Promise<void>;
     /**
-     * Create a new user. Create a new user. You must define the `organization_id`
-     * and the `email` in your request.
+     * Create a new user. Create a new user. You must define the `organization_id` in your request. If you are adding a member, enter the member's details. If you are adding a guest, you must define the `email` and not add the member attribute.
      *
      * @param request - The request {@link CreateUserRequest}
      * @returns A Promise of User
@@ -138,8 +117,7 @@ export declare class API extends ParentAPI {
      */
     deleteUserMFAOTP: (request: Readonly<DeleteUserMFAOTPRequest>) => Promise<void>;
     /**
-     * Lock a member. Lock a member. A locked member cannot log in or use API keys
-     * until the locked status is removed.
+     * Lock a member. Lock a member. A locked member cannot log in or use API keys until the locked status is removed.
      *
      * @param request - The request {@link LockUserRequest}
      * @returns A Promise of User
@@ -162,12 +140,7 @@ export declare class API extends ParentAPI {
     getUserConnections: (request: Readonly<GetUserConnectionsRequest>) => Promise<GetUserConnectionsResponse>;
     protected pageOfListApplications: (request?: Readonly<ListApplicationsRequest>) => Promise<ListApplicationsResponse>;
     /**
-     * List applications of an Organization. List the applications of an
-     * Organization. By default, the applications listed are ordered by creation
-     * date in ascending order. This can be modified via the `order_by` field. You
-     * must define the `organization_id` in the query path of your request. You
-     * can also define additional parameters for your query such as
-     * `application_ids`.
+     * List applications of an Organization. List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`.
      *
      * @param request - The request {@link ListApplicationsRequest}
      * @returns A Promise of ListApplicationsResponse
@@ -177,47 +150,35 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Application[], void, void>;
     };
     /**
-     * Create a new application. Create a new application. You must define the
-     * `name` parameter in the request.
+     * Create a new application. Create a new application. You must define the `name` parameter in the request.
      *
      * @param request - The request {@link CreateApplicationRequest}
      * @returns A Promise of Application
      */
     createApplication: (request: Readonly<CreateApplicationRequest>) => Promise<Application>;
     /**
-     * Get a given application. Retrieve information about an application,
-     * specified by the `application_id` parameter. The application's full
-     * details, including `id`, `email`, `organization_id`, `status` and
-     * `two_factor_enabled` are returned in the response.
+     * Get a given application. Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response.
      *
      * @param request - The request {@link GetApplicationRequest}
      * @returns A Promise of Application
      */
     getApplication: (request: Readonly<GetApplicationRequest>) => Promise<Application>;
     /**
-     * Update an application. Update the parameters of an application, including
-     * `name` and `description`.
+     * Update an application. Update the parameters of an application, including `name` and `description`.
      *
      * @param request - The request {@link UpdateApplicationRequest}
      * @returns A Promise of Application
      */
     updateApplication: (request: Readonly<UpdateApplicationRequest>) => Promise<Application>;
     /**
-     * Delete an application. Delete an application. Note that this action is
-     * irreversible and will automatically delete the application's API keys.
-     * Policies attached to users and applications via this group will no longer
-     * apply.
+     * Delete an application. Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply.
      *
      * @param request - The request {@link DeleteApplicationRequest}
      */
     deleteApplication: (request: Readonly<DeleteApplicationRequest>) => Promise<void>;
     protected pageOfListGroups: (request?: Readonly<ListGroupsRequest>) => Promise<ListGroupsResponse>;
     /**
-     * List groups. List groups. By default, the groups listed are ordered by
-     * creation date in ascending order. This can be modified via the `order_by`
-     * field. You can define additional parameters to filter your query. Use
-     * `user_ids` or `application_ids` to list all groups certain users or
-     * applications belong to.
+     * List groups. List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to.
      *
      * @param request - The request {@link ListGroupsRequest}
      * @returns A Promise of ListGroupsResponse
@@ -227,89 +188,63 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Group[], void, void>;
     };
     /**
-     * Create a group. Create a new group. You must define the `name` and
-     * `organization_id` parameters in the request.
+     * Create a group. Create a new group. You must define the `name` and `organization_id` parameters in the request.
      *
      * @param request - The request {@link CreateGroupRequest}
      * @returns A Promise of Group
      */
     createGroup: (request: Readonly<CreateGroupRequest>) => Promise<Group>;
     /**
-     * Get a group. Retrive information about a given group, specified by the
-     * `group_id` parameter. The group's full details, including `user_ids` and
-     * `application_ids` are returned in the response.
+     * Get a group. Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response.
      *
      * @param request - The request {@link GetGroupRequest}
      * @returns A Promise of Group
      */
     getGroup: (request: Readonly<GetGroupRequest>) => Promise<Group>;
     /**
-     * Update a group. Update the parameters of group, including `name` and
-     * `description`.
+     * Update a group. Update the parameters of group, including `name` and `description`.
      *
      * @param request - The request {@link UpdateGroupRequest}
      * @returns A Promise of Group
      */
     updateGroup: (request: Readonly<UpdateGroupRequest>) => Promise<Group>;
     /**
-     * Overwrite users and applications of a group. Overwrite users and
-     * applications configuration in a group. Any information that you add using
-     * this command will overwrite the previous configuration.
+     * Overwrite users and applications of a group. Overwrite users and applications configuration in a group. Any information that you add using this command will overwrite the previous configuration.
      *
      * @param request - The request {@link SetGroupMembersRequest}
      * @returns A Promise of Group
      */
     setGroupMembers: (request: Readonly<SetGroupMembersRequest>) => Promise<Group>;
     /**
-     * Add a user or an application to a group. Add a user or an application to a
-     * group. You can specify a `user_id` and and `application_id` in the body of
-     * your request. Note that you can only add one of each per request.
+     * Add a user or an application to a group. Add a user or an application to a group. You can specify a `user_id` and `application_id` in the body of your request. Note that you can only add one of each per request.
      *
      * @param request - The request {@link AddGroupMemberRequest}
      * @returns A Promise of Group
      */
     addGroupMember: (request: Readonly<AddGroupMemberRequest>) => Promise<Group>;
     /**
-     * Add multiple users and applications to a group. Add multiple users and
-     * applications to a group in a single call. You can specify an array of
-     * `user_id`s and `application_id`s. Note that any existing users and
-     * applications in the group will remain. To add new users/applications and
-     * delete pre-existing ones, use the [Overwrite users and applications of a
-     * group](#path-groups-overwrite-users-and-applications-of-a-group) method.
+     * Add multiple users and applications to a group. Add multiple users and applications to a group in a single call. You can specify an array of `user_id`s and `application_id`s. Note that any existing users and applications in the group will remain. To add new users/applications and delete pre-existing ones, use the [Overwrite users and applications of a group](#path-groups-overwrite-users-and-applications-of-a-group) method.
      *
      * @param request - The request {@link AddGroupMembersRequest}
      * @returns A Promise of Group
      */
     addGroupMembers: (request: Readonly<AddGroupMembersRequest>) => Promise<Group>;
     /**
-     * Remove a user or an application from a group. Remove a user or an
-     * application from a group. You can specify a `user_id` and and
-     * `application_id` in the body of your request. Note that you can only remove
-     * one of each per request. Removing a user from a group means that any
-     * permissions given to them via the group (i.e. from an attached policy) will
-     * no longer apply. Be sure you want to remove these permissions from the user
-     * before proceeding.
+     * Remove a user or an application from a group. Remove a user or an application from a group. You can specify a `user_id` and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding.
      *
      * @param request - The request {@link RemoveGroupMemberRequest}
      * @returns A Promise of Group
      */
     removeGroupMember: (request: Readonly<RemoveGroupMemberRequest>) => Promise<Group>;
     /**
-     * Delete a group. Delete a group. Note that this action is irreversible and
-     * could delete permissions for group members. Policies attached to users and
-     * applications via this group will no longer apply.
+     * Delete a group. Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply.
      *
      * @param request - The request {@link DeleteGroupRequest}
      */
     deleteGroup: (request: Readonly<DeleteGroupRequest>) => Promise<void>;
     protected pageOfListPolicies: (request?: Readonly<ListPoliciesRequest>) => Promise<ListPoliciesResponse>;
     /**
-     * List policies of an Organization. List the policies of an Organization. By
-     * default, the policies listed are ordered by creation date in ascending
-     * order. This can be modified via the `order_by` field. You must define the
-     * `organization_id` in the query path of your request. You can also define
-     * additional parameters to filter your query, such as `user_ids`,
-     * `groups_ids`, `application_ids`, and `policy_name`.
+     * List policies of an Organization. List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`.
      *
      * @param request - The request {@link ListPoliciesRequest}
      * @returns A Promise of ListPoliciesResponse
@@ -319,58 +254,41 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Policy[], void, void>;
     };
     /**
-     * Create a new policy. Create a new application. You must define the `name`
-     * parameter in the request. You can specify parameters such as `user_id`,
-     * `groups_id`, `application_id`, `no_principal`, `rules` and its child
-     * attributes.
+     * Create a new policy. Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes.
      *
      * @param request - The request {@link CreatePolicyRequest}
      * @returns A Promise of Policy
      */
     createPolicy: (request: Readonly<CreatePolicyRequest>) => Promise<Policy>;
     /**
-     * Get an existing policy. Retrieve information about a policy, speficified by
-     * the `policy_id` parameter. The policy's full details, including `id`,
-     * `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets`
-     * are returned in the response.
+     * Get an existing policy. Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response.
      *
      * @param request - The request {@link GetPolicyRequest}
      * @returns A Promise of Policy
      */
     getPolicy: (request: Readonly<GetPolicyRequest>) => Promise<Policy>;
     /**
-     * Update an existing policy. Update the parameters of a policy, including
-     * `name`, `description`, `user_id`, `group_id`, `application_id` and
-     * `no_principal`.
+     * Update an existing policy. Update the parameters of a policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`.
      *
      * @param request - The request {@link UpdatePolicyRequest}
      * @returns A Promise of Policy
      */
     updatePolicy: (request: Readonly<UpdatePolicyRequest>) => Promise<Policy>;
     /**
-     * Delete a policy. Delete a policy. You must define specify the `policy_id`
-     * parameter in your request. Note that when deleting a policy, all
-     * permissions it gives to its principal (user, group or application) will be
-     * revoked.
+     * Delete a policy. Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked.
      *
      * @param request - The request {@link DeletePolicyRequest}
      */
     deletePolicy: (request: Readonly<DeletePolicyRequest>) => Promise<void>;
     /**
-     * Clone a policy. Clone a policy. You must define specify the `policy_id`
-     * parameter in your request.
+     * Clone a policy. Clone a policy. You must define specify the `policy_id` parameter in your request.
      *
      * @param request - The request {@link ClonePolicyRequest}
      * @returns A Promise of Policy
      */
     clonePolicy: (request: Readonly<ClonePolicyRequest>) => Promise<Policy>;
     /**
-     * Set rules of a given policy. Overwrite the rules of a given policy. Any
-     * information that you add using this command will overwrite the previous
-     * configuration. If you include some of the rules you already had in your
-     * previous configuration in your new one, but you change their order, the new
-     * order of display will apply. While policy rules are ordered, they have no
-     * impact on the access logic of IAM because rules are allow-only.
+     * Set rules of a given policy. Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only.
      *
      * @param request - The request {@link SetRulesRequest}
      * @returns A Promise of SetRulesResponse
@@ -378,10 +296,7 @@ export declare class API extends ParentAPI {
     setRules: (request: Readonly<SetRulesRequest>) => Promise<SetRulesResponse>;
     protected pageOfListRules: (request: Readonly<ListRulesRequest>) => Promise<ListRulesResponse>;
     /**
-     * List rules of a given policy. List the rules of a given policy. By default,
-     * the rules listed are ordered by creation date in ascending order. This can
-     * be modified via the `order_by` field. You must define the `policy_id` in
-     * the query path of your request.
+     * List rules of a given policy. List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request.
      *
      * @param request - The request {@link ListRulesRequest}
      * @returns A Promise of ListRulesResponse
@@ -392,9 +307,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListPermissionSets: (request?: Readonly<ListPermissionSetsRequest>) => Promise<ListPermissionSetsResponse>;
     /**
-     * List permission sets. List permission sets available for given
-     * Organization. You must define the `organization_id` in the query path of
-     * your request.
+     * List permission sets. List permission sets available for given Organization. You must define the `organization_id` in the query path of your request.
      *
      * @param request - The request {@link ListPermissionSetsRequest}
      * @returns A Promise of ListPermissionSetsResponse
@@ -405,10 +318,7 @@ export declare class API extends ParentAPI {
     };
     protected pageOfListAPIKeys: (request?: Readonly<ListAPIKeysRequest>) => Promise<ListAPIKeysResponse>;
     /**
-     * List API keys. List API keys. By default, the API keys listed are ordered
-     * by creation date in ascending order. This can be modified via the
-     * `order_by` field. You can define additional parameters for your query such
-     * as `editable`, `expired`, `access_key` and `bearer_id`.
+     * List API keys. List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`.
      *
      * @param request - The request {@link ListAPIKeysRequest}
      * @returns A Promise of ListAPIKeysResponse
@@ -418,52 +328,35 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<APIKey[], void, void>;
     };
     /**
-     * Create an API key. 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.
+     * Create an API key. 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.
      *
      * @param request - The request {@link CreateAPIKeyRequest}
      * @returns A Promise of APIKey
      */
     createAPIKey: (request: Readonly<CreateAPIKeyRequest>) => Promise<APIKey>;
     /**
-     * Get an API key. Retrive information about an API key, specified by the
-     * `access_key` parameter. The API key's details, including either the
-     * `user_id` or `application_id` of its bearer are returned in the response.
-     * Note that the string value for the `secret_key` is nullable, and therefore
-     * is not displayed in the response. The `secret_key` value is only displayed
-     * upon API key creation.
+     * Get an API key. Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
      *
      * @param request - The request {@link GetAPIKeyRequest}
      * @returns A Promise of APIKey
      */
     getAPIKey: (request: Readonly<GetAPIKeyRequest>) => Promise<APIKey>;
     /**
-     * Update an API key. Update the parameters of an API key, including
-     * `default_project_id` and `description`.
+     * Update an API key. Update the parameters of an API key, including `default_project_id` and `description`.
      *
      * @param request - The request {@link UpdateAPIKeyRequest}
      * @returns A Promise of APIKey
      */
     updateAPIKey: (request: Readonly<UpdateAPIKeyRequest>) => Promise<APIKey>;
     /**
-     * Delete an API key. Delete an API key. Note that this action is irreversible
-     * and cannot be undone. Make sure you update any configurations using the API
-     * keys you delete.
+     * Delete an API key. Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete.
      *
      * @param request - The request {@link DeleteAPIKeyRequest}
      */
     deleteAPIKey: (request: Readonly<DeleteAPIKeyRequest>) => Promise<void>;
     protected pageOfListQuota: (request?: Readonly<ListQuotaRequest>) => Promise<ListQuotaResponse>;
     /**
-     * List all quotas in the Organization. List all product and features quota
-     * for an Organization, with their associated limits. By default, the quota
-     * listed are ordered by creation date in ascending order. This can be
-     * modified via the `order_by` field. You must define the `organization_id` in
-     * the query path of your request.
+     * List all quotas in the Organization. List all product and features quota for an Organization, with their associated limits. By default, the quota listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request.
      *
      * @param request - The request {@link ListQuotaRequest}
      * @returns A Promise of ListQuotaResponse
@@ -473,9 +366,7 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Quotum[], void, void>;
     };
     /**
-     * Get a quota in the Organization. Retrieve information about a resource
-     * quota, specified by the `quotum_name` parameter. The quota's `limit`, or
-     * whether it is unlimited, is returned in the response.
+     * Get a quota in the Organization. Retrieve information about a resource quota, specified by the `quotum_name` parameter. The quota's `limit`, or whether it is unlimited, is returned in the response.
      *
      * @param request - The request {@link GetQuotumRequest}
      * @returns A Promise of Quotum
@@ -514,8 +405,7 @@ export declare class API extends ParentAPI {
     deleteJWT: (request: Readonly<DeleteJWTRequest>) => Promise<void>;
     protected pageOfListLogs: (request?: Readonly<ListLogsRequest>) => Promise<ListLogsResponse>;
     /**
-     * List logs. List logs available for given Organization. You must define the
-     * `organization_id` in the query path of your request.
+     * List logs. List logs available for given Organization. You must define the `organization_id` in the query path of your request.
      *
      * @param request - The request {@link ListLogsRequest}
      * @returns A Promise of ListLogsResponse
@@ -525,19 +415,14 @@ export declare class API extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<Log[], void, void>;
     };
     /**
-     * Get a log. Retrieve information about a log, specified by the `log_id`
-     * parameter. The log's full details, including `id`, `ip`, `user_agent`,
-     * `action`, `bearer_id`, `resource_type` and `resource_id` are returned in
-     * the response.
+     * Get a log. Retrieve information about a log, specified by the `log_id` parameter. The log's full details, including `id`, `ip`, `user_agent`, `action`, `bearer_id`, `resource_type` and `resource_id` are returned in the response.
      *
      * @param request - The request {@link GetLogRequest}
      * @returns A Promise of Log
      */
     getLog: (request: Readonly<GetLogRequest>) => Promise<Log>;
     /**
-     * Get security settings of an Organization. Retrieve information about the
-     * security settings of an Organization, specified by the `organization_id`
-     * parameter.
+     * Get security settings of an Organization. Retrieve information about the security settings of an Organization, specified by the `organization_id` parameter.
      *
      * @param request - The request {@link GetOrganizationSecuritySettingsRequest}
      * @returns A Promise of OrganizationSecuritySettings
@@ -546,8 +431,7 @@ export declare class API extends ParentAPI {
     /**
      * Update the security settings of an Organization.
      *
-     * @param request - The request
-     *   {@link UpdateOrganizationSecuritySettingsRequest}
+     * @param request - The request {@link UpdateOrganizationSecuritySettingsRequest}
      * @returns A Promise of OrganizationSecuritySettings
      */
     updateOrganizationSecuritySettings: (request?: Readonly<UpdateOrganizationSecuritySettingsRequest>) => Promise<OrganizationSecuritySettings>;