Struct Teammates

pub struct Teammates {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Teammates

pub async fn list<'a>(&'a self) -> Result<ListTeammatesResponse, Error>

List teammates

List the teammates in the company.

async fn example_teammates_list() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListTeammatesResponse = client.teammates().list().await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get<'a>( &'a self, teammate_id: &'a str, ) -> Result<TeammateResponse, Error>

Get teammate

Fetch a teammate.

Parameters:

• teammate_id: &'astr: The teammate ID (required)

async fn example_teammates_get() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::TeammateResponse = client.teammates().get("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn update<'a>( &'a self, teammate_id: &'a str, body: &UpdateTeammate, ) -> Result<(), Error>

Update teammate

Update a teammate.

Parameters:

• teammate_id: &'astr: The teammate ID (required)

async fn example_teammates_update() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .teammates()
        .update(
            "some-string",
            &serde_json::Value::String("some-string".to_string()),
        )
        .await?;
    Ok(())
}

pub async fn list_assigned_conversations<'a>( &'a self, limit: Option<i64>, page_token: Option<String>, q: Option<String>, teammate_id: &'a str, ) -> Result<ListAssignedConversationsResponse, Error>

List assigned conversations

List the conversations assigned to a teammate in reverse chronological order (most recently updated first). For more advanced filtering, see the search endpoint.

⚠️ Deprecated field included

This endpoint returns a deprecated last_message field in the top-level conversation bodies listed. Please use the _links.related.last_message field instead.

Parameters:

• limit: Option<i64>: Max number of results per page
• page_token: Option<String>: Token to use to request the next page
• q: Option<String>: Search query object with a property statuses, whose value should be a list of conversation statuses (assigned, unassigned, archived, or deleted).
• teammate_id: &'astr: The teammate ID (required)

async fn example_teammates_list_assigned_conversations() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListAssignedConversationsResponse = client
        .teammates()
        .list_assigned_conversations(
            Some(4 as i64),
            Some("some-string".to_string()),
            Some("some-string".to_string()),
            "some-string",
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn list_inboxes<'a>( &'a self, teammate_id: &'a str, ) -> Result<ListTeammateInboxesResponse, Error>

List teammate inboxes

Returns list of inboxes the teammate has access to.

Parameters:

• teammate_id: &'astr: The teammate ID (required)

NOTE: This operation is marked as deprecated.

async fn example_teammates_list_inboxes() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListTeammateInboxesResponse =
        client.teammates().list_inboxes("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Teammates

fn clone(&self) -> Teammates

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Teammates

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

Formats the value using the given formatter.