Search

Lib.rs

› Email
#bindings #documentation #developer

helpscout

Bindings for the HelpScout API

by Lance Carlson, Tristan Mortimer

  • Install
  • API reference
  • GitHub (lancecarlson)

4 releases

Uses old Rust 2015

0.0.4 Feb 2, 2018
0.0.3 Feb 1, 2018
0.0.2 Jan 31, 2018
0.0.1 Jan 23, 2018

#621 in Email

MIT license

86KB
1.5K SLoC

Helpscout API Bindings in Rust

Currently in active development.

Click here for documentation and example usage

See the tests directory for more examples.


lib.rs:

Help Scout API Bindings in Rust Documentation

Help Scout References:

  • Developer Docs
  • Help Desk API

Note: the api module implements the Help Desk API.

Usage

Add the dependency to your Cargo.toml:

[dependencies]
helpscout = "*"

Create a client and then use any of the endpoints.

use helpscout::Client;

fn main() {
    let api_key = env::var("HELPSCOUT_API_KEY").expect("to have HELPSCOUT_API_KEY set");
    let client = Client::new(&api_key);

    // Used the mailbox list endpoint for test. Use whatever you need here.
    let mailboxes = mailboxes::list(&client);

    assert!(mailboxes.items.len() > 0);
}

Additional client setup documentation can be found here: Client

Endpoints

Drill down into endpoint documentation by following the links below.

  • conversations
  • customers
  • mailboxes
  • reports
  • users

Dependencies

~26–38MB
~725K SLoC

  • chrono+serde
  • dotenv 0.10
  • log
  • reqwest 0.8
  • ring 0.11
  • serde
  • serde_derive 1.0
  • serde_json
  • serde_url_params 0.1
  • time 0.1
  • uuid 0.4+v4
  • dev env_logger 0.5
See also: ignoreit, sinbo, greentic-dev, rasa, imap, async-imap, axfetchum, anytype_rs, extendr-api, rpi-mailbox, conjure-codegen

Lib.rs is an unofficial list of Rust/Cargo crates, created by kornelski. It contains data from multiple sources, including heuristics, and manually curated data. Content of this page is not necessarily endorsed by the authors of the crate. This site is not affiliated with nor endorsed by the Rust Project. If something is missing or incorrect, please file a bug.