Struct User

pub struct User {
    pub id: String,
    pub email: String,
    pub name: String,
    pub added_at: String,
    pub role: UserRole,
    pub user_type: String,
}

A user in the organization

Fields

id: String

Unique user identifier

email: String

User’s email address

name: String

User’s name

added_at: String

RFC 3339 datetime string indicating when the user joined the organization

role: UserRole

User’s role in the organization

user_type: String

Object type (always “user” for Users)

Implementations

impl User

pub fn builder(user_id: impl Into<String>) -> UserBuilder

Creates a builder for getting a specific user.

Example

let credentials = Credentials::from_env();

let user = User::builder("user_123456789")
    .credentials(credentials)
    .create()
    .await?;

pub async fn create(request: UserRequest) -> ApiResponseOrError<Self>

Gets information about a specific user.

Example

let credentials = Credentials::from_env();
let request = UserRequest {
    user_id: "user_123456789".to_string(),
    credentials: Some(credentials),
};

let user = User::create(request).await?;

pub fn update_builder(user_id: impl Into<String>) -> UserUpdateBuilder

Creates a builder for updating a user.

Example

let credentials = Credentials::from_env();

let updated_user = User::update_builder("user_123456789")
    .credentials(credentials)
    .role(UserRole::Developer)
    .create()
    .await?;

pub async fn update(request: UserUpdateRequest) -> ApiResponseOrError<Self>

Updates a user with the given request parameters.

Example

let credentials = Credentials::from_env();
let request = UserUpdateRequest {
    user_id: "user_123456789".to_string(),
    role: UserRole::Developer,
    credentials: Some(credentials),
};

let updated_user = User::update(request).await?;

pub fn remove_builder(user_id: impl Into<String>) -> UserRemoveBuilder

Creates a builder for removing a user.

Example

let credentials = Credentials::from_env();

let removed_user = User::remove_builder("user_123456789")
    .credentials(credentials)
    .create()
    .await?;

pub async fn remove( request: UserRemoveRequest, ) -> ApiResponseOrError<UserDeleted>

Removes a user from the organization.

Example

let credentials = Credentials::from_env();
let request = UserRemoveRequest {
    user_id: "user_123456789".to_string(),
    credentials: Some(credentials),
};

let removed_user = User::remove(request).await?;

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for User

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for User

fn eq(&self, other: &User) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for User

impl StructuralPartialEq for User