Crate helpscout [] [src]

Help Scout API Bindings in Rust Documentation

Help Scout References:

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.

Modules

api
webhook

Structs

Client

The HelpScout API Rust client.

Collection
Item
Status

Status message returned by every API request.

Enums

HelpScoutError

The error type used by this library.