@nutanix-scratch/iam-js-client 4.0.1-beta.1 → 4.0.1

package/dist/es/apis/user-endpoints.d.ts

@@ -1,190 +0,0 @@
-/**
- * User service.
- * @version 4.0.1-beta-1
- * @class UserApi
- */
-export class UserApi {
-    /**
-    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
-    * their own fetch methods into the SDK
-    */
-    static get ApiClient(): typeof ApiClient;
-    /**
-     * Constructs a new UserApi.
-     * @alias module:api/UserApi
-     * @class
-     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
-     * default to {@link module:ApiClient#instance} if unspecified.
-     */
-    constructor(apiClient?: any);
-    apiClient: any;
-    /**
-     * Change password of user
-     * Change Password for a user
-     * @param {PasswordChangeRequest} body specification
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ChangeUserPasswordApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ChangeUserPasswordApiResponse } and HTTP response
-     */
-    changeUserPassword(body: PasswordChangeRequest, ...args: any): Promise<ChangeUserPasswordApiResponse>;
-    /**
-     * Create user
-     * Create a user
-     * @param {User} body specification
-     * @param {Object} args Additional Arguments
-     * @return {Promise<CreateUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateUserApiResponse } and HTTP response
-     */
-    createUser(body: User, ...args: any): Promise<CreateUserApiResponse>;
-    /**
-     * Create bucket access key for user
-     * Create access key Id and secret access key to call Nutanix Buckets service.
-     * @param {BucketsAccessKey} body specification
-     * @param { String } extId External Identifier of the user
-     * @param {Object} args Additional Arguments
-     * @return {Promise<CreateUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateUserKeyApiResponse } and HTTP response
-     */
-    createUserBucketKey(extId: string, body: BucketsAccessKey, ...args: any): Promise<CreateUserKeyApiResponse>;
-    /**
-     * List bucket access keys of user
-     * List all Bucket Access Key(s) for the user
-     * @param { String } extId External Identifier of the user
-     * @param {Object} opts Optional parameters defined for the operation
-     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned.
-
-     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-
-     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter result on cluster name karbon-ntnx1.0, filter '$filter=startswith(name, 'C')' would filter on cluster name starting with C.<br>
-     * The filter can be applied on the following fields:<br>
-     * - accessKeyName<br>
-     * - userId
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in desc order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - accessKeyName<br>
-     * - createdTime
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ListUserKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserKeyApiResponse } and HTTP response
-     */
-    getUserBucketKeys(extId: string, opts: {
-        $page: number;
-        $limit: number;
-        $filter: string;
-        $orderby: string;
-    }, ...args: any): Promise<ListUserKeyApiResponse>;
-    /**
-     * Get user
-     * View a user
-     * @param { String } extId External Identifier of the user
-     * @param {Object} args Additional Arguments
-     * @return {Promise<GetUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUserApiResponse } and HTTP response
-     */
-    getUserById(extId: string, ...args: any): Promise<GetUserApiResponse>;
-    /**
-     * List user(s)
-     * List all user(s)
-     * @param {Object} opts Optional parameters defined for the operation
-     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned.
-
-     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-
-     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter result on cluster name karbon-ntnx1.0, filter '$filter=startswith(name, 'C')' would filter on cluster name starting with C.<br>
-     * The filter can be applied on the following fields:<br>
-     * - createdBy<br>
-     * - displayName<br>
-     * - emailId<br>
-     * - extId<br>
-     * - firstName<br>
-     * - idpId<br>
-     * - lastName<br>
-     * - status<br>
-     * - userType<br>
-     * - username
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in desc order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - createdTime<br>
-     * - displayName<br>
-     * - emailId<br>
-     * - firstName<br>
-     * - lastLoginTime<br>
-     * - lastName<br>
-     * - lastUpdatedTime<br>
-     * - userType<br>
-     * - username
-     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e. *), then all properties on the matching resource will be returned.
-- additionalAttributes
-- bucketsAccessKeys
-- createdBy
-- createdTime
-- displayName
-- emailId
-- extId
-- firstName
-- idpId
-- isForceResetPasswordEnabled
-- lastLoginTime
-- lastName
-- lastUpdatedTime
-- links
-- locale
-- middleInitial
-- password
-- region
-- status
-- tenantId
-- userType
-- username
-
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ListUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserApiResponse } and HTTP response
-     */
-    getUserList(opts: {
-        $page: number;
-        $limit: number;
-        $filter: string;
-        $orderby: string;
-        $select: string;
-    }, ...args: any): Promise<ListUserApiResponse>;
-    /**
-     * Reset password of user
-     * Reset Password for a user
-     * @param {PasswordResetRequest} body specification
-     * @param { String } extId External Identifier of the user
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ResetUserPasswordApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ResetUserPasswordApiResponse } and HTTP response
-     */
-    resetUserPassword(extId: string, body: PasswordResetRequest, ...args: any): Promise<ResetUserPasswordApiResponse>;
-    /**
-     * Update user
-     * Update a user
-     * @param {User} body specification
-     * @param { String } extId External Identifier of the user
-     * @param {Object} args Additional Arguments
-     * @return {Promise<UpdateUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateUserApiResponse } and HTTP response
-     */
-    updateUser(extId: string, body: User, ...args: any): Promise<UpdateUserApiResponse>;
-    /**
-     * Update active state of user
-     * Update active state of a user
-     * @param {UserStateUpdate} body specification
-     * @param { String } extId External Identifier of the user
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ActivateUserApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ActivateUserApiResponse } and HTTP response
-     */
-    updateUserState(extId: string, body: UserStateUpdate, ...args: any): Promise<ActivateUserApiResponse>;
-    #private;
-}
-import PasswordChangeRequest from "../models/iam/v4/authn/PasswordChangeRequest";
-import ChangeUserPasswordApiResponse from "../models/iam/v4/authn/ChangeUserPasswordApiResponse";
-import User from "../models/iam/v4/authn/User";
-import CreateUserApiResponse from "../models/iam/v4/authn/CreateUserApiResponse";
-import BucketsAccessKey from "../models/iam/v4/authn/BucketsAccessKey";
-import CreateUserKeyApiResponse from "../models/iam/v4/authn/CreateUserKeyApiResponse";
-import ListUserKeyApiResponse from "../models/iam/v4/authn/ListUserKeyApiResponse";
-import GetUserApiResponse from "../models/iam/v4/authn/GetUserApiResponse";
-import ListUserApiResponse from "../models/iam/v4/authn/ListUserApiResponse";
-import PasswordResetRequest from "../models/iam/v4/authn/PasswordResetRequest";
-import ResetUserPasswordApiResponse from "../models/iam/v4/authn/ResetUserPasswordApiResponse";
-import UpdateUserApiResponse from "../models/iam/v4/authn/UpdateUserApiResponse";
-import UserStateUpdate from "../models/iam/v4/authn/UserStateUpdate";
-import ActivateUserApiResponse from "../models/iam/v4/authn/ActivateUserApiResponse";
-import { ApiClient } from "../ApiClient";