Struct InviteBuilder

pub struct InviteBuilder { /* private fields */ }

Builder for InviteRequest.

Implementations

impl InviteBuilder

pub fn invite_id<VALUE: Into<String>>(self, value: VALUE) -> Self

Invite identifier

pub fn credentials<VALUE: Into<Credentials>>(self, value: VALUE) -> Self

Credentials for authentication (not serialized)

pub fn build(self) -> Result<InviteRequest, InviteBuilderError>

Builds a new InviteRequest.

Errors

If a required field has not been initialized.

impl InviteBuilder

pub async fn create(self) -> ApiResponseOrError<Invite>

Creates a new invite request and returns the response.

This is a convenience method that builds the request from the builder and sends it to the Invites API.

Example

let credentials = Credentials::from_env();

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

Trait Implementations

impl Clone for InviteBuilder

fn clone(&self) -> InviteBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InviteBuilder

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

Formats the value using the given formatter.

impl Default for InviteBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for InviteBuilder

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