Struct Inboxes

pub struct Inboxes {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Inboxes

pub async fn list_inbox_channels<'a>( &'a self, inbox_id: &'a str, ) -> Result<ListInboxChannelsResponse, Error>

List inbox channels

List the channels in an inbox.

Parameters:

• inbox_id: &'astr: The Inbox ID (required)

async fn example_inboxes_list_inbox_channels() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListInboxChannelsResponse =
        client.inboxes().list_inbox_channels("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

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

List inboxes

List the inboxes of the company.

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

pub async fn create_inbox<'a>(&'a self, body: &CreateInbox) -> Result<(), Error>

Create inbox

Create an inbox in the default team.

async fn example_inboxes_create_inbox() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .inboxes()
        .create_inbox(&front_api::types::CreateInbox {
            name: "some-string".to_string(),
            teammate_ids: Some(vec!["some-string".to_string()]),
        })
        .await?;
    Ok(())
}

pub async fn list_team<'a>( &'a self, team_id: &'a str, ) -> Result<ListTeamInboxesResponse, Error>

List team inboxes

List the inboxes belonging to a team.

Parameters:

• team_id: &'astr: The team ID (required)

async fn example_inboxes_list_team() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListTeamInboxesResponse =
        client.inboxes().list_team("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn create_team_inbox<'a>( &'a self, team_id: &'a str, body: &CreateInbox, ) -> Result<(), Error>

Create team inbox

Create an inbox for a team.

Parameters:

• team_id: &'astr: The tag ID (required)

async fn example_inboxes_create_team_inbox() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .inboxes()
        .create_team_inbox(
            "some-string",
            &front_api::types::CreateInbox {
                name: "some-string".to_string(),
                teammate_ids: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    Ok(())
}

pub async fn get_inbox<'a>( &'a self, inbox_id: &'a str, ) -> Result<InboxResponse, Error>

Get inbox

Fetch an inbox.

Parameters:

• inbox_id: &'astr: The Inbox ID (required)

async fn example_inboxes_get_inbox() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::InboxResponse = client.inboxes().get_inbox("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn list_inbox_conversations<'a>( &'a self, inbox_id: &'a str, limit: Option<i64>, page_token: Option<String>, q: Option<String>, ) -> Result<ListInboxConversationsResponse, Error>

List inbox conversations

List the conversations in an inbox. 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:

• inbox_id: &'astr: The Inbox ID (required)
• 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).

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

pub async fn list_inbox_teammates<'a>( &'a self, inbox_id: &'a str, ) -> Result<ListInboxTeammatesResponse, Error>

List inbox access

List the teammates with access to an inbox.

Parameters:

• inbox_id: &'astr: The Inbox ID (required)

async fn example_inboxes_list_inbox_teammates() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListInboxTeammatesResponse =
        client.inboxes().list_inbox_teammates("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn add_inbox_teammates<'a>( &'a self, inbox_id: &'a str, body: &TeammateIds, ) -> Result<(), Error>

Add inbox access

Give access to one or more teammates to an inbox.

Parameters:

• inbox_id: &'astr: The Inbox ID (required)

async fn example_inboxes_add_inbox_teammates() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .inboxes()
        .add_inbox_teammates(
            "some-string",
            &front_api::types::TeammateIds {
                teammate_ids: vec!["some-string".to_string()],
            },
        )
        .await?;
    Ok(())
}

pub async fn remove_inbox_teammates<'a>( &'a self, inbox_id: &'a str, body: &TeammateIds, ) -> Result<(), Error>

Removes inbox access

Remove access of one or more teammates from an inbox.

Parameters:

• inbox_id: &'astr: The Inbox ID (required)

async fn example_inboxes_remove_inbox_teammates() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .inboxes()
        .remove_inbox_teammates(
            "some-string",
            &front_api::types::TeammateIds {
                teammate_ids: vec!["some-string".to_string()],
            },
        )
        .await?;
    Ok(())
}

Trait Implementations

impl Clone for Inboxes

fn clone(&self) -> Inboxes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Inboxes

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

Formats the value using the given formatter.