Struct Signatures

pub struct Signatures {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Signatures

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

List teammate signatures

List the signatures belonging to the given teammate.

Parameters:

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

async fn example_signatures_list_teammate() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListTeammateSignaturesResponse =
        client.signatures().list_teammate("some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn create_teammate<'a>( &'a self, teammate_id: &'a str, body: &CreatePrivateSignature, ) -> Result<SignatureResponse, Error>

Create teammate signature

Create a new signature for the given teammate

Parameters:

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

async fn example_signatures_create_teammate() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::SignatureResponse = client
        .signatures()
        .create_teammate(
            "some-string",
            &front_api::types::CreatePrivateSignature {
                name: "some-string".to_string(),
                sender_info: Some("some-string".to_string()),
                body: "some-string".to_string(),
                is_default: Some(true),
                channel_ids: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

List team signatures

List the signatures belonging to the given team.

Parameters:

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

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

pub async fn create_team<'a>( &'a self, team_id: &'a str, body: &CreateSharedSignature, ) -> Result<SignatureResponse, Error>

Create team signature

Create a new signature for the given team

Parameters:

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

async fn example_signatures_create_team() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::SignatureResponse = client
        .signatures()
        .create_team(
            "some-string",
            &front_api::types::CreateSharedSignature {
                name: "some-string".to_string(),
                sender_info: Some("some-string".to_string()),
                body: "some-string".to_string(),
                is_visible_for_all_teammate_channels: Some(true),
                is_default: Some(true),
                channel_ids: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

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

Get signatures

Get the given signature.

Parameters:

• signature_id: &'astr: The signature ID (required)

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

pub async fn delete<'a>(&'a self, signature_id: &'a str) -> Result<(), Error>

Delete signature

Delete signature

Parameters:

• signature_id: &'astr: The signature ID (required)

async fn example_signatures_delete() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client.signatures().delete("some-string").await?;
    Ok(())
}

pub async fn update<'a>( &'a self, signature_id: &'a str, body: &UpdateSignature, ) -> Result<SignatureResponse, Error>

Update signature

Update signature

Parameters:

• signature_id: &'astr: The signature ID (required)

async fn example_signatures_update() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::SignatureResponse = client
        .signatures()
        .update(
            "some-string",
            &front_api::types::UpdateSignature {
                name: Some("some-string".to_string()),
                sender_info: Some("some-string".to_string()),
                body: Some("some-string".to_string()),
                is_visible_for_all_teammate_channels: Some(false),
                is_default: Some(true),
                channel_ids: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Signatures

fn clone(&self) -> Signatures

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signatures

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

Formats the value using the given formatter.