Struct Links

Source
pub struct Links {
    pub client: Client,
}

Fields§

§client: Client

Implementations§

Source

pub async fn list_conversations<'a>( &'a self, limit: Option<i64>, link_id: &'a str, page_token: Option<String>, q: Option<String>, ) -> Result<ListLinkConversationsResponse, Error>

List link conversations

List the conversations linked to a specific link. 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
  • link_id: &'astr: The Link ID (required)
  • 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_links_list_conversations() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListLinkConversationsResponse = client
        .links()
        .list_conversations(
            Some(4 as i64),
            "some-string",
            Some("some-string".to_string()),
            Some("some-string".to_string()),
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn list<'a>( &'a self, limit: Option<i64>, page_token: Option<String>, q: Option<String>, ) -> Result<ListLinksResponse, Error>

List links

List the links of the company paginated by id. Allows filtering by link type via the q.types param.

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 types, whose value should be a list of link types (examples - web, jira, asana ).
async fn example_links_list() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListLinksResponse = client
        .links()
        .list(
            Some(4 as i64),
            Some("some-string".to_string()),
            Some("some-string".to_string()),
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn create<'a>( &'a self, body: &CreateLink, ) -> Result<LinkResponse, Error>

Create link

Create a link. If the link is resolved to an installed links integration, any name retrieved from the integration will override the provided name.

async fn example_links_create() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::LinkResponse = client
        .links()
        .create(&front_api::types::CreateLink {
            name: Some("some-string".to_string()),
            external_url: "some-string".to_string(),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}
Source

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

Get link

Fetch a link.

Parameters:

  • link_id: &'astr: The link ID (required)
async fn example_links_get() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::LinkResponse = client.links().get("some-string").await?;
    println!("{:?}", result);
    Ok(())
}
Source

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

Update a link

Update a link.

Parameters:

  • link_id: &'astr: The link ID (required)
async fn example_links_update() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .links()
        .update(
            "some-string",
            &serde_json::Value::String("some-string".to_string()),
        )
        .await?;
    Ok(())
}

Trait Implementations§

Source§

fn clone(&self) -> Links

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more