Expand description
A fully generated & opinionated API client for the Front API.
§API Details
§Contact
name | |
---|---|
Front Platform | api@frontapp.com |
§Client Details
The documentation for the crate is generated along with the code to make this library easy to use.
To install the library, add the following to your Cargo.toml
file.
[dependencies]
front-api = "0.0.2"
§Basic example
Typical use will require intializing a Client
. This requires
a user agent string and set of credentials.
use front_api::Client;
let client = Client::new(String::from("api-key"));
Alternatively, the library can search for most of the variables required for the client in the environment:
FRONT_API_TOKEN
And then you can create a client from the environment.
use front_api::Client;
let client = Client::new_from_env();
Modules§
- analytics
- attachments
- channels
- comments
- contact_
groups - contact_
handles - contact_
notes - contacts
- conversations
- custom_
fields - drafts
- events
- inboxes
- links
- message_
template_ folders - message_
templates - messages
- rules
- shifts
- signatures
- tags
- teammates
- teams
- token_
identity - types
- This module contains the generated types for the library.
Structs§
- Client
- Entrypoint for interacting with the API client.