aws-sdk-wickr 1.12.0

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Represents a user account in a Wickr network with detailed profile information, status, security settings, and authentication details.</p><note>
/// <p>codeValidation, inviteCode and inviteCodeTtl are restricted to networks under preview only.</p>
/// </note>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct User {
    /// <p>The unique identifier for the user within the network.</p>
    pub user_id: ::std::option::Option<::std::string::String>,
    /// <p>The first name of the user.</p>
    pub first_name: ::std::option::Option<::std::string::String>,
    /// <p>The last name of the user.</p>
    pub last_name: ::std::option::Option<::std::string::String>,
    /// <p>The email address or username of the user. For bots, this must end in 'bot'.</p>
    pub username: ::std::option::Option<::std::string::String>,
    /// <p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</p>
    pub security_groups: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>Indicates whether the user has administrator privileges in the network.</p>
    pub is_admin: ::std::option::Option<bool>,
    /// <p>Indicates whether the user is currently suspended and unable to access the network.</p>
    pub suspended: ::std::option::Option<bool>,
    /// <p>The current status of the user (1 for pending invitation, 2 for active).</p>
    pub status: ::std::option::Option<i32>,
    /// <p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>
    pub otp_enabled: ::std::option::Option<bool>,
    /// <p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>
    pub scim_id: ::std::option::Option<::std::string::String>,
    /// <p>The descriptive type of the user account (e.g., 'user').</p>
    pub r#type: ::std::option::Option<::std::string::String>,
    /// <p>The phone number minus country code, used for cloud deployments.</p>
    pub cell: ::std::option::Option<::std::string::String>,
    /// <p>The country code for the user's phone number, used for cloud deployments.</p>
    pub country_code: ::std::option::Option<::std::string::String>,
    /// <p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>
    pub challenge_failures: ::std::option::Option<i32>,
    /// <p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>
    pub is_invite_expired: ::std::option::Option<bool>,
    /// <p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>
    pub is_user: ::std::option::Option<bool>,
    /// <p>The invitation code for this user, used during registration to join the network.</p>
    pub invite_code: ::std::option::Option<::std::string::String>,
    /// <p>Indicates whether the user can be verified through a custom invite code.</p>
    pub code_validation: ::std::option::Option<bool>,
    /// <p>The unique identifier for the user.</p>
    pub uname: ::std::option::Option<::std::string::String>,
}
impl User {
    /// <p>The unique identifier for the user within the network.</p>
    pub fn user_id(&self) -> ::std::option::Option<&str> {
        self.user_id.as_deref()
    }
    /// <p>The first name of the user.</p>
    pub fn first_name(&self) -> ::std::option::Option<&str> {
        self.first_name.as_deref()
    }
    /// <p>The last name of the user.</p>
    pub fn last_name(&self) -> ::std::option::Option<&str> {
        self.last_name.as_deref()
    }
    /// <p>The email address or username of the user. For bots, this must end in 'bot'.</p>
    pub fn username(&self) -> ::std::option::Option<&str> {
        self.username.as_deref()
    }
    /// <p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.security_groups.is_none()`.
    pub fn security_groups(&self) -> &[::std::string::String] {
        self.security_groups.as_deref().unwrap_or_default()
    }
    /// <p>Indicates whether the user has administrator privileges in the network.</p>
    pub fn is_admin(&self) -> ::std::option::Option<bool> {
        self.is_admin
    }
    /// <p>Indicates whether the user is currently suspended and unable to access the network.</p>
    pub fn suspended(&self) -> ::std::option::Option<bool> {
        self.suspended
    }
    /// <p>The current status of the user (1 for pending invitation, 2 for active).</p>
    pub fn status(&self) -> ::std::option::Option<i32> {
        self.status
    }
    /// <p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>
    pub fn otp_enabled(&self) -> ::std::option::Option<bool> {
        self.otp_enabled
    }
    /// <p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>
    pub fn scim_id(&self) -> ::std::option::Option<&str> {
        self.scim_id.as_deref()
    }
    /// <p>The descriptive type of the user account (e.g., 'user').</p>
    pub fn r#type(&self) -> ::std::option::Option<&str> {
        self.r#type.as_deref()
    }
    /// <p>The phone number minus country code, used for cloud deployments.</p>
    pub fn cell(&self) -> ::std::option::Option<&str> {
        self.cell.as_deref()
    }
    /// <p>The country code for the user's phone number, used for cloud deployments.</p>
    pub fn country_code(&self) -> ::std::option::Option<&str> {
        self.country_code.as_deref()
    }
    /// <p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>
    pub fn challenge_failures(&self) -> ::std::option::Option<i32> {
        self.challenge_failures
    }
    /// <p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>
    pub fn is_invite_expired(&self) -> ::std::option::Option<bool> {
        self.is_invite_expired
    }
    /// <p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>
    pub fn is_user(&self) -> ::std::option::Option<bool> {
        self.is_user
    }
    /// <p>The invitation code for this user, used during registration to join the network.</p>
    pub fn invite_code(&self) -> ::std::option::Option<&str> {
        self.invite_code.as_deref()
    }
    /// <p>Indicates whether the user can be verified through a custom invite code.</p>
    pub fn code_validation(&self) -> ::std::option::Option<bool> {
        self.code_validation
    }
    /// <p>The unique identifier for the user.</p>
    pub fn uname(&self) -> ::std::option::Option<&str> {
        self.uname.as_deref()
    }
}
impl ::std::fmt::Debug for User {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("User");
        formatter.field("user_id", &self.user_id);
        formatter.field("first_name", &"*** Sensitive Data Redacted ***");
        formatter.field("last_name", &"*** Sensitive Data Redacted ***");
        formatter.field("username", &self.username);
        formatter.field("security_groups", &self.security_groups);
        formatter.field("is_admin", &self.is_admin);
        formatter.field("suspended", &self.suspended);
        formatter.field("status", &self.status);
        formatter.field("otp_enabled", &self.otp_enabled);
        formatter.field("scim_id", &self.scim_id);
        formatter.field("r#type", &self.r#type);
        formatter.field("cell", &self.cell);
        formatter.field("country_code", &self.country_code);
        formatter.field("challenge_failures", &self.challenge_failures);
        formatter.field("is_invite_expired", &self.is_invite_expired);
        formatter.field("is_user", &self.is_user);
        formatter.field("invite_code", &self.invite_code);
        formatter.field("code_validation", &self.code_validation);
        formatter.field("uname", &self.uname);
        formatter.finish()
    }
}
impl User {
    /// Creates a new builder-style object to manufacture [`User`](crate::types::User).
    pub fn builder() -> crate::types::builders::UserBuilder {
        crate::types::builders::UserBuilder::default()
    }
}

/// A builder for [`User`](crate::types::User).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct UserBuilder {
    pub(crate) user_id: ::std::option::Option<::std::string::String>,
    pub(crate) first_name: ::std::option::Option<::std::string::String>,
    pub(crate) last_name: ::std::option::Option<::std::string::String>,
    pub(crate) username: ::std::option::Option<::std::string::String>,
    pub(crate) security_groups: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) is_admin: ::std::option::Option<bool>,
    pub(crate) suspended: ::std::option::Option<bool>,
    pub(crate) status: ::std::option::Option<i32>,
    pub(crate) otp_enabled: ::std::option::Option<bool>,
    pub(crate) scim_id: ::std::option::Option<::std::string::String>,
    pub(crate) r#type: ::std::option::Option<::std::string::String>,
    pub(crate) cell: ::std::option::Option<::std::string::String>,
    pub(crate) country_code: ::std::option::Option<::std::string::String>,
    pub(crate) challenge_failures: ::std::option::Option<i32>,
    pub(crate) is_invite_expired: ::std::option::Option<bool>,
    pub(crate) is_user: ::std::option::Option<bool>,
    pub(crate) invite_code: ::std::option::Option<::std::string::String>,
    pub(crate) code_validation: ::std::option::Option<bool>,
    pub(crate) uname: ::std::option::Option<::std::string::String>,
}
impl UserBuilder {
    /// <p>The unique identifier for the user within the network.</p>
    pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.user_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier for the user within the network.</p>
    pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.user_id = input;
        self
    }
    /// <p>The unique identifier for the user within the network.</p>
    pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.user_id
    }
    /// <p>The first name of the user.</p>
    pub fn first_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.first_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The first name of the user.</p>
    pub fn set_first_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.first_name = input;
        self
    }
    /// <p>The first name of the user.</p>
    pub fn get_first_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.first_name
    }
    /// <p>The last name of the user.</p>
    pub fn last_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.last_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The last name of the user.</p>
    pub fn set_last_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.last_name = input;
        self
    }
    /// <p>The last name of the user.</p>
    pub fn get_last_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.last_name
    }
    /// <p>The email address or username of the user. For bots, this must end in 'bot'.</p>
    pub fn username(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.username = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The email address or username of the user. For bots, this must end in 'bot'.</p>
    pub fn set_username(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.username = input;
        self
    }
    /// <p>The email address or username of the user. For bots, this must end in 'bot'.</p>
    pub fn get_username(&self) -> &::std::option::Option<::std::string::String> {
        &self.username
    }
    /// Appends an item to `security_groups`.
    ///
    /// To override the contents of this collection use [`set_security_groups`](Self::set_security_groups).
    ///
    /// <p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</p>
    pub fn security_groups(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.security_groups.unwrap_or_default();
        v.push(input.into());
        self.security_groups = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</p>
    pub fn set_security_groups(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.security_groups = input;
        self
    }
    /// <p>A list of security group IDs to which the user is assigned, determining their permissions and feature access.</p>
    pub fn get_security_groups(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.security_groups
    }
    /// <p>Indicates whether the user has administrator privileges in the network.</p>
    pub fn is_admin(mut self, input: bool) -> Self {
        self.is_admin = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether the user has administrator privileges in the network.</p>
    pub fn set_is_admin(mut self, input: ::std::option::Option<bool>) -> Self {
        self.is_admin = input;
        self
    }
    /// <p>Indicates whether the user has administrator privileges in the network.</p>
    pub fn get_is_admin(&self) -> &::std::option::Option<bool> {
        &self.is_admin
    }
    /// <p>Indicates whether the user is currently suspended and unable to access the network.</p>
    pub fn suspended(mut self, input: bool) -> Self {
        self.suspended = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether the user is currently suspended and unable to access the network.</p>
    pub fn set_suspended(mut self, input: ::std::option::Option<bool>) -> Self {
        self.suspended = input;
        self
    }
    /// <p>Indicates whether the user is currently suspended and unable to access the network.</p>
    pub fn get_suspended(&self) -> &::std::option::Option<bool> {
        &self.suspended
    }
    /// <p>The current status of the user (1 for pending invitation, 2 for active).</p>
    pub fn status(mut self, input: i32) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the user (1 for pending invitation, 2 for active).</p>
    pub fn set_status(mut self, input: ::std::option::Option<i32>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the user (1 for pending invitation, 2 for active).</p>
    pub fn get_status(&self) -> &::std::option::Option<i32> {
        &self.status
    }
    /// <p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>
    pub fn otp_enabled(mut self, input: bool) -> Self {
        self.otp_enabled = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>
    pub fn set_otp_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
        self.otp_enabled = input;
        self
    }
    /// <p>Indicates whether one-time password (OTP) authentication is enabled for the user.</p>
    pub fn get_otp_enabled(&self) -> &::std::option::Option<bool> {
        &self.otp_enabled
    }
    /// <p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>
    pub fn scim_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scim_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>
    pub fn set_scim_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scim_id = input;
        self
    }
    /// <p>The SCIM (System for Cross-domain Identity Management) identifier for the user, used for identity synchronization. Currently not used.</p>
    pub fn get_scim_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.scim_id
    }
    /// <p>The descriptive type of the user account (e.g., 'user').</p>
    pub fn r#type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.r#type = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The descriptive type of the user account (e.g., 'user').</p>
    pub fn set_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>The descriptive type of the user account (e.g., 'user').</p>
    pub fn get_type(&self) -> &::std::option::Option<::std::string::String> {
        &self.r#type
    }
    /// <p>The phone number minus country code, used for cloud deployments.</p>
    pub fn cell(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cell = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The phone number minus country code, used for cloud deployments.</p>
    pub fn set_cell(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cell = input;
        self
    }
    /// <p>The phone number minus country code, used for cloud deployments.</p>
    pub fn get_cell(&self) -> &::std::option::Option<::std::string::String> {
        &self.cell
    }
    /// <p>The country code for the user's phone number, used for cloud deployments.</p>
    pub fn country_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.country_code = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The country code for the user's phone number, used for cloud deployments.</p>
    pub fn set_country_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.country_code = input;
        self
    }
    /// <p>The country code for the user's phone number, used for cloud deployments.</p>
    pub fn get_country_code(&self) -> &::std::option::Option<::std::string::String> {
        &self.country_code
    }
    /// <p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>
    pub fn challenge_failures(mut self, input: i32) -> Self {
        self.challenge_failures = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>
    pub fn set_challenge_failures(mut self, input: ::std::option::Option<i32>) -> Self {
        self.challenge_failures = input;
        self
    }
    /// <p>The number of failed password attempts for enterprise deployments, used for account lockout policies.</p>
    pub fn get_challenge_failures(&self) -> &::std::option::Option<i32> {
        &self.challenge_failures
    }
    /// <p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>
    pub fn is_invite_expired(mut self, input: bool) -> Self {
        self.is_invite_expired = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>
    pub fn set_is_invite_expired(mut self, input: ::std::option::Option<bool>) -> Self {
        self.is_invite_expired = input;
        self
    }
    /// <p>Indicates whether the user's email invitation code has expired, applicable to cloud deployments.</p>
    pub fn get_is_invite_expired(&self) -> &::std::option::Option<bool> {
        &self.is_invite_expired
    }
    /// <p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>
    pub fn is_user(mut self, input: bool) -> Self {
        self.is_user = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>
    pub fn set_is_user(mut self, input: ::std::option::Option<bool>) -> Self {
        self.is_user = input;
        self
    }
    /// <p>Indicates whether this account is a user (as opposed to a bot or other account type).</p>
    pub fn get_is_user(&self) -> &::std::option::Option<bool> {
        &self.is_user
    }
    /// <p>The invitation code for this user, used during registration to join the network.</p>
    pub fn invite_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.invite_code = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The invitation code for this user, used during registration to join the network.</p>
    pub fn set_invite_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.invite_code = input;
        self
    }
    /// <p>The invitation code for this user, used during registration to join the network.</p>
    pub fn get_invite_code(&self) -> &::std::option::Option<::std::string::String> {
        &self.invite_code
    }
    /// <p>Indicates whether the user can be verified through a custom invite code.</p>
    pub fn code_validation(mut self, input: bool) -> Self {
        self.code_validation = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether the user can be verified through a custom invite code.</p>
    pub fn set_code_validation(mut self, input: ::std::option::Option<bool>) -> Self {
        self.code_validation = input;
        self
    }
    /// <p>Indicates whether the user can be verified through a custom invite code.</p>
    pub fn get_code_validation(&self) -> &::std::option::Option<bool> {
        &self.code_validation
    }
    /// <p>The unique identifier for the user.</p>
    pub fn uname(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.uname = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier for the user.</p>
    pub fn set_uname(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.uname = input;
        self
    }
    /// <p>The unique identifier for the user.</p>
    pub fn get_uname(&self) -> &::std::option::Option<::std::string::String> {
        &self.uname
    }
    /// Consumes the builder and constructs a [`User`](crate::types::User).
    pub fn build(self) -> crate::types::User {
        crate::types::User {
            user_id: self.user_id,
            first_name: self.first_name,
            last_name: self.last_name,
            username: self.username,
            security_groups: self.security_groups,
            is_admin: self.is_admin,
            suspended: self.suspended,
            status: self.status,
            otp_enabled: self.otp_enabled,
            scim_id: self.scim_id,
            r#type: self.r#type,
            cell: self.cell,
            country_code: self.country_code,
            challenge_failures: self.challenge_failures,
            is_invite_expired: self.is_invite_expired,
            is_user: self.is_user,
            invite_code: self.invite_code,
            code_validation: self.code_validation,
            uname: self.uname,
        }
    }
}
impl ::std::fmt::Debug for UserBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("UserBuilder");
        formatter.field("user_id", &self.user_id);
        formatter.field("first_name", &"*** Sensitive Data Redacted ***");
        formatter.field("last_name", &"*** Sensitive Data Redacted ***");
        formatter.field("username", &self.username);
        formatter.field("security_groups", &self.security_groups);
        formatter.field("is_admin", &self.is_admin);
        formatter.field("suspended", &self.suspended);
        formatter.field("status", &self.status);
        formatter.field("otp_enabled", &self.otp_enabled);
        formatter.field("scim_id", &self.scim_id);
        formatter.field("r#type", &self.r#type);
        formatter.field("cell", &self.cell);
        formatter.field("country_code", &self.country_code);
        formatter.field("challenge_failures", &self.challenge_failures);
        formatter.field("is_invite_expired", &self.is_invite_expired);
        formatter.field("is_user", &self.is_user);
        formatter.field("invite_code", &self.invite_code);
        formatter.field("code_validation", &self.code_validation);
        formatter.field("uname", &self.uname);
        formatter.finish()
    }
}