Skip to main content

ApiClient

Struct ApiClient 

Source
pub struct ApiClient { /* private fields */ }
Expand description

Thin HTTP client for Inline API endpoints.

Implementations§

Source§

impl ApiClient

Source

pub fn builder(base_url: impl Into<String>) -> ApiClientBuilder

Starts an ApiClient builder for an Inline API base URL.

Source

pub fn try_new(base_url: impl Into<String>) -> Result<Self, ApiError>

Creates an API client with the default SDK identity.

Source

pub fn try_new_with_identity( base_url: impl Into<String>, identity: ClientIdentity, ) -> Result<Self, ApiError>

Creates an API client with a custom client identity.

Source

pub fn base_url(&self) -> &str

Returns the normalized API base URL.

Source

pub fn http_client(&self) -> &Client

Returns the underlying reqwest client.

Source

pub fn request_timeout(&self) -> Option<Duration>

Returns the request timeout configured by the SDK builder.

This is None when the caller provided a custom reqwest client.

Source§

impl ApiClient

Source

pub fn try_with_http_client( base_url: impl Into<String>, http: Client, ) -> Result<Self, ApiError>

Creates an API client from a caller-provided reqwest client.

Source

pub async fn send_email_code( &self, email: &str, metadata: &AuthMetadata, ) -> Result<SendCodeResult, ApiError>

Sends an email login code.

Source

pub async fn verify_email_code( &self, email: &str, code: &str, challenge_token: Option<&str>, metadata: &AuthMetadata, ) -> Result<VerifyCodeResult, ApiError>

Verifies an email login code and returns an auth token on success.

Source

pub async fn send_sms_code( &self, phone_number: &str, metadata: &AuthMetadata, ) -> Result<SendCodeResult, ApiError>

Sends an SMS login code.

Source

pub async fn verify_sms_code( &self, phone_number: &str, code: &str, metadata: &AuthMetadata, ) -> Result<VerifyCodeResult, ApiError>

Verifies an SMS login code and returns an auth token on success.

Source

pub async fn upload_file( &self, token: &str, input: UploadFileInput, ) -> Result<UploadFileResult, ApiError>

Uploads a local file using the Inline upload endpoint.

Source

pub async fn read_messages( &self, token: &str, input: ReadMessagesInput, ) -> Result<ReadMessagesResult, ApiError>

Marks messages as read for a peer.

Source

pub async fn create_private_chat( &self, token: &str, user_id: i64, ) -> Result<CreatePrivateChatResult, ApiError>

Creates or opens a private chat with a user.

Source

pub async fn create_linear_issue( &self, token: &str, input: CreateLinearIssueInput, ) -> Result<CreateLinearIssueResult, ApiError>

Creates a Linear issue from an Inline message.

Source

pub async fn create_notion_task( &self, token: &str, input: CreateNotionTaskInput, ) -> Result<CreateNotionTaskResult, ApiError>

Creates a Notion task from an Inline message.

Trait Implementations§

Source§

impl Clone for ApiClient

Source§

fn clone(&self) -> ApiClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApiClient

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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