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

package/dist/lib/models/iam/v4/authn/User.d.ts

@@ -1,244 +1,318 @@
 /**
  * The User model module.
  * @module Ntnx/User
- * @version 4.0.1-beta-1
+ * @version 4.0.1
  * @class User
+ * @extends ExternalizableAbstractModel
  */
 export default class User extends ExternalizableAbstractModel {
     /**
-     * Returns Identifier for the user in the form an email address
-     * @return {}
+     * Returns Identifier of the user.
+     * @return {string}
      */
-    getUsername(): any;
+    getUsername(): string;
     /**
-     * Sets Identifier for the user in the form an email address
-     * @param {} username Identifier for the user in the form an email address
+     * Sets Identifier of the user.
+     * @param {string} username Identifier of the user.
      */
-    setUsername(username: any): void;
-    username: any;
+    setUsername(username: string): void;
+    username: string;
     /**
-     * @return {}
+     * @return {UserType}
      */
-    getUserType(): any;
+    getUserType(): UserType;
     /**
-     * @param {} userType
+     * @param {UserType} userType
      */
-    setUserType(userType: any): void;
-    userType: any;
+    setUserType(userType: UserType): void;
+    userType: string;
     /**
-     * Returns Identifier of the IDP for the user
-     * @return {}
+     * Returns Identifier of the IDP for the user.
+     * @return {string}
      */
-    getIdpId(): any;
+    getIdpId(): string;
     /**
-     * Sets Identifier of the IDP for the user
-     * @param {} idpId Identifier of the IDP for the user
+     * Sets Identifier of the IDP for the user.
+     * @param {string} idpId Identifier of the IDP for the user.
      */
-    setIdpId(idpId: any): void;
-    idpId: any;
+    setIdpId(idpId: string): void;
+    idpId: string;
     /**
-     * Returns Display name for the user
-     * @return {}
+     * Returns Display name of the user. For LDAP and SAML users, this is set from AD config.
+     * @return {string}
      */
-    getDisplayName(): any;
+    getDisplayName(): string;
     /**
-     * Sets Display name for the user
-     * @param {} displayName Display name for the user
+     * Sets Display name of the user. For LDAP and SAML users, this is set from AD config.
+     * @param {string} displayName Display name of the user. For LDAP and SAML users, this is set from AD config.
      */
-    setDisplayName(displayName: any): void;
-    displayName: any;
+    setDisplayName(displayName: string): void;
+    displayName: string;
     /**
-     * Returns First name for the user
-     * @return {}
+     * Returns First name of the user.
+     * @return {string}
      */
-    getFirstName(): any;
+    getFirstName(): string;
     /**
-     * Sets First name for the user
-     * @param {} firstName First name for the user
+     * Sets First name of the user.
+     * @param {string} firstName First name of the user.
      */
-    setFirstName(firstName: any): void;
-    firstName: any;
+    setFirstName(firstName: string): void;
+    firstName: string;
     /**
-     * Returns Middle name for the user
-     * @return {}
+     * Returns Middle name of the user.
+     * @return {string}
      */
-    getMiddleInitial(): any;
+    getMiddleInitial(): string;
     /**
-     * Sets Middle name for the user
-     * @param {} middleInitial Middle name for the user
+     * Sets Middle name of the user.
+     * @param {string} middleInitial Middle name of the user.
      */
-    setMiddleInitial(middleInitial: any): void;
-    middleInitial: any;
+    setMiddleInitial(middleInitial: string): void;
+    middleInitial: string;
     /**
-     * Returns Last name for the user
-     * @return {}
+     * Returns Last name of the user.
+     * @return {string}
      */
-    getLastName(): any;
+    getLastName(): string;
     /**
-     * Sets Last name for the user
-     * @param {} lastName Last name for the user
+     * Sets Last name of the user.
+     * @param {string} lastName Last name of the user.
      */
-    setLastName(lastName: any): void;
-    lastName: any;
+    setLastName(lastName: string): void;
+    lastName: string;
     /**
-     * Returns Email Id for the user
-     * @return {}
+     * Returns Email ID of the user.
+     * @return {string}
      */
-    getEmailId(): any;
+    getEmailId(): string;
     /**
-     * Sets Email Id for the user
-     * @param {} emailId Email Id for the user
+     * Sets Email ID of the user.
+     * @param {string} emailId Email ID of the user.
      */
-    setEmailId(emailId: any): void;
-    emailId: any;
+    setEmailId(emailId: string): void;
+    emailId: string;
     /**
-     * Returns Default locale for the user
-     * @return {}
+     * Returns Default locale of the user.
+     * @return {string}
      */
-    getLocale(): any;
+    getLocale(): string;
     /**
-     * Sets Default locale for the user
-     * @param {} locale Default locale for the user
+     * Sets Default locale of the user.
+     * @param {string} locale Default locale of the user.
      */
-    setLocale(locale: any): void;
-    locale: any;
+    setLocale(locale: string): void;
+    locale: string;
     /**
-     * Returns Default Region for the user
-     * @return {}
+     * Returns Default region of the user.
+     * @return {string}
      */
-    getRegion(): any;
+    getRegion(): string;
     /**
-     * Sets Default Region for the user
-     * @param {} region Default Region for the user
+     * Sets Default region of the user.
+     * @param {string} region Default region of the user.
      */
-    setRegion(region: any): void;
-    region: any;
+    setRegion(region: string): void;
+    region: string;
     /**
-     * Returns Password for the user
-     * @return {}
+     * Returns Password of the user.
+     * @return {string}
      */
-    getPassword(): any;
+    getPassword(): string;
     /**
-     * Sets Password for the user
-     * @param {} password Password for the user
+     * Sets Password of the user.
+     * @param {string} password Password of the user.
      */
-    setPassword(password: any): void;
-    password: any;
+    setPassword(password: string): void;
+    password: string;
     /**
-     * Returns Flag to force the user to reset password
-     * @return {}
+     * Returns Flag to force the user to reset password.
+     * @return {boolean}
      */
-    getIsForceResetPasswordEnabled(): any;
+    getIsForceResetPasswordEnabled(): boolean;
     /**
-     * Sets Flag to force the user to reset password
-     * @param {} isForceResetPasswordEnabled Flag to force the user to reset password
+     * Sets Flag to force the user to reset password.
+     * @param {boolean} isForceResetPasswordEnabled Flag to force the user to reset password.
      */
-    setIsForceResetPasswordEnabled(isForceResetPasswordEnabled: any): void;
-    isForceResetPasswordEnabled: any;
+    setIsForceResetPasswordEnabled(isForceResetPasswordEnabled: boolean): void;
+    isForceResetPasswordEnabled: boolean;
     /**
-     * Returns Any additional attribute for the user
-     * @return {}
+     * Returns Indicates additional attributes of the user.
+     * @return {KVPair[]}
      */
-    getAdditionalAttributes(): any;
+    getAdditionalAttributes(): KVPair[];
     /**
-     * Sets Any additional attribute for the user
-     * @param {} additionalAttributes Any additional attribute for the user
+     * Sets Indicates additional attributes of the user.
+     * @param {KVPair[]} additionalAttributes Indicates additional attributes of the user.
      */
-    setAdditionalAttributes(additionalAttributes: any): void;
-    additionalAttributes: any;
+    setAdditionalAttributes(additionalAttributes: KVPair[]): void;
+    additionalAttributes: KVPair[];
     /**
-     * @return {}
+     * @return {UserStatusType}
      */
-    getStatus(): any;
+    getStatus(): UserStatusType;
     /**
-     * @param {} status
+     * @param {UserStatusType} status
      */
-    setStatus(status: any): void;
-    status: any;
+    setStatus(status: UserStatusType): void;
+    status: string;
     /**
-     * Returns Bucket access keys for the user
-     * @return {}
+     * Returns Bucket access keys for the user.
+     * @return {BucketsAccessKey[]}
      */
-    getBucketsAccessKeys(): any;
+    getBucketsAccessKeys(): BucketsAccessKey[];
     /**
-     * Sets Bucket access keys for the user
-     * @param {} bucketsAccessKeys Bucket access keys for the user
+     * Sets Bucket access keys for the user.
+     * @param {BucketsAccessKey[]} bucketsAccessKeys Bucket access keys for the user.
      */
-    setBucketsAccessKeys(bucketsAccessKeys: any): void;
-    bucketsAccessKeys: any;
+    setBucketsAccessKeys(bucketsAccessKeys: BucketsAccessKey[]): void;
+    bucketsAccessKeys: BucketsAccessKey[];
     /**
-     * Returns Last successful logged in time for the user
-     * @return {}
+     * Returns The last successful login time for the user.
+     * @return {Date}
      */
-    getLastLoginTime(): any;
+    getLastLoginTime(): Date;
     /**
-     * Sets Last successful logged in time for the user
-     * @param {} lastLoginTime Last successful logged in time for the user
+     * Sets The last successful login time for the user.
+     * @param {Date} lastLoginTime The last successful login time for the user.
      */
-    setLastLoginTime(lastLoginTime: any): void;
-    lastLoginTime: any;
+    setLastLoginTime(lastLoginTime: Date): void;
+    lastLoginTime: Date;
     /**
-     * Returns Creation time of the user
-     * @return {}
+     * Returns Creation time of the user.
+     * @return {Date}
      */
-    getCreatedTime(): any;
+    getCreatedTime(): Date;
     /**
-     * Sets Creation time of the user
-     * @param {} createdTime Creation time of the user
+     * Sets Creation time of the user.
+     * @param {Date} createdTime Creation time of the user.
      */
-    setCreatedTime(createdTime: any): void;
-    createdTime: any;
+    setCreatedTime(createdTime: Date): void;
+    createdTime: Date;
     /**
-     * Returns Last updated time of the user
-     * @return {}
+     * Returns The last updated time for the user.
+     * @return {Date}
      */
-    getLastUpdatedTime(): any;
+    getLastUpdatedTime(): Date;
     /**
-     * Sets Last updated time of the user
-     * @param {} lastUpdatedTime Last updated time of the user
+     * Sets The last updated time for the user.
+     * @param {Date} lastUpdatedTime The last updated time for the user.
      */
-    setLastUpdatedTime(lastUpdatedTime: any): void;
-    lastUpdatedTime: any;
+    setLastUpdatedTime(lastUpdatedTime: Date): void;
+    lastUpdatedTime: Date;
     /**
-     * Returns User or service who created the user
-     * @return {}
+     * Returns User or Service who created the user.
+     * @return {string}
      */
-    getCreatedBy(): any;
+    getCreatedBy(): string;
     /**
-     * Sets User or service who created the user
-     * @param {} createdBy User or service who created the user
+     * Sets User or Service who created the user.
+     * @param {string} createdBy User or Service who created the user.
      */
-    setCreatedBy(createdBy: any): void;
-    createdBy: any;
+    setCreatedBy(createdBy: string): void;
+    createdBy: string;
+    /**
+     * Returns Last updated by this user ID.
+     * @return {string}
+     */
+    getLastUpdatedBy(): string;
+    /**
+     * Sets Last updated by this user ID.
+     * @param {string} lastUpdatedBy Last updated by this user ID.
+     */
+    setLastUpdatedBy(lastUpdatedBy: string): void;
+    lastUpdatedBy: string;
+    /**
+     * Returns Description of the user.
+     * @return {string}
+     */
+    getDescription(): string;
+    /**
+     * Sets Description of the user.
+     * @param {string} description Description of the user.
+     */
+    setDescription(description: string): void;
+    description: string;
+    /**
+     * @return {CreationType}
+     */
+    getCreationType(): CreationType;
+    /**
+     * @param {CreationType} creationType
+     */
+    setCreationType(creationType: CreationType): void;
+    creationType: string;
     toJson(forMutation: any): {
-        $reserved: {
-            $fqObjectType: string;
-        };
+        $reserved: any;
         $objectType: string;
-        $unknownFields: {};
-        tenantId?: any;
-        links?: any;
-        extId?: any;
-        createdBy?: any;
+        $unknownFields: any;
+        tenantId?: string;
+        links?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            rel?: string;
+            href?: string;
+        }[];
+        extId?: string;
+        creationType?: string;
+        description?: string;
+        lastUpdatedBy?: string;
+        createdBy?: string;
         lastUpdatedTime?: any;
         createdTime?: any;
         lastLoginTime?: any;
-        bucketsAccessKeys?: any;
-        status?: any;
-        additionalAttributes?: any;
-        isForceResetPasswordEnabled?: any;
-        password?: any;
-        region?: any;
-        locale?: any;
-        emailId?: any;
-        lastName?: any;
-        middleInitial?: any;
-        firstName?: any;
-        displayName?: any;
-        idpId?: any;
-        userType?: any;
-        username?: any;
+        bucketsAccessKeys?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            tenantId?: string;
+            links?: {
+                $reserved: any;
+                $objectType: string;
+                $unknownFields: any;
+                rel?: string;
+                href?: string;
+            }[];
+            extId?: string;
+            lastUpdatedTime?: any;
+            createdBy?: string;
+            status?: string;
+            expiryTime?: any;
+            creationType?: string;
+            assignedTo?: string;
+            lastUpdatedBy?: string;
+            createdTime?: any;
+            userId?: string;
+            secretAccessKey?: string;
+            accessKeyName?: string;
+        }[];
+        status?: string;
+        additionalAttributes?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            value?: any;
+            name?: string;
+        }[];
+        isForceResetPasswordEnabled?: boolean;
+        password?: string;
+        region?: string;
+        locale?: string;
+        emailId?: string;
+        lastName?: string;
+        middleInitial?: string;
+        firstName?: string;
+        displayName?: string;
+        idpId?: string;
+        userType?: string;
+        username?: string;
     };
     #private;
 }
 import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import UserType from "./UserType";
+import KVPair from "../../../common/v1/config/KVPair";
+import UserStatusType from "./UserStatusType";
+import BucketsAccessKey from "./BucketsAccessKey";
+import CreationType from "./CreationType";