Struct Invite

pub struct Invite {
    pub id: String,
    pub email: String,
    pub invited_at: String,
    pub expires_at: String,
    pub role: InviteRole,
    pub status: InviteStatus,
    pub invite_type: String,
}

An invite to the organization

Fields

id: String

Unique invite identifier

email: String

Email of the user being invited

invited_at: String

RFC 3339 datetime string indicating when the invite was created

expires_at: String

RFC 3339 datetime string indicating when the invite expires

role: InviteRole

Role assigned to the invited user

status: InviteStatus

Current status of the invite

invite_type: String

Object type (always “invite” for Invites)

Implementations

impl Invite

pub fn builder(invite_id: impl Into<String>) -> InviteBuilder

Creates a builder for getting a specific invite.

Example

let credentials = Credentials::from_env();

let invite = Invite::builder("invite_123456789")
    .credentials(credentials)
    .create()
    .await?;

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

Gets information about a specific invite.

Example

let credentials = Credentials::from_env();
let request = InviteRequest {
    invite_id: "invite_123456789".to_string(),
    credentials: Some(credentials),
};

let invite = Invite::create(request).await?;

pub fn create_builder() -> InviteCreateBuilder

Creates a builder for creating a new invite.

Example

let credentials = Credentials::from_env();

let new_invite = Invite::create_builder()
    .credentials(credentials)
    .email("user@example.com")
    .role(InviteRole::Developer)
    .create()
    .await?;

pub async fn create_new( request: InviteCreateRequest, ) -> ApiResponseOrError<Self>

Creates a new invite with the given request parameters.

Example

let credentials = Credentials::from_env();
let request = InviteCreateRequest {
    email: "user@example.com".to_string(),
    role: InviteRole::Developer,
    credentials: Some(credentials),
};

let new_invite = Invite::create_new(request).await?;

pub fn delete_builder(invite_id: impl Into<String>) -> InviteDeleteBuilder

Creates a builder for deleting an invite.

Example

let credentials = Credentials::from_env();

let deleted_invite = Invite::delete_builder("invite_123456789")
    .credentials(credentials)
    .create()
    .await?;

pub async fn delete( request: InviteDeleteRequest, ) -> ApiResponseOrError<InviteDeleted>

Deletes an invite from the organization.

Example

let credentials = Credentials::from_env();
let request = InviteDeleteRequest {
    invite_id: "invite_123456789".to_string(),
    credentials: Some(credentials),
};

let deleted_invite = Invite::delete(request).await?;

Trait Implementations

impl Clone for Invite

fn clone(&self) -> Invite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Invite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invite

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Invite

fn eq(&self, other: &Invite) -> 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 Invite

impl StructuralPartialEq for Invite