Crate remote_api

Source
Expand description

A fully generated & opinionated API client for the Remote API.

docs.rs

§API Details

§Authentication

§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]
remote-api = "0.1.2"

§Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use remote_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:

  • REMOTE_API_TOKEN

And then you can create a client from the environment.

use remote_api::Client;

let client = Client::new_from_env();

Modules§

company_managers
countries
employments
sandbox
time_off
types
This module contains the generated types for the library.
utils

Structs§

Client
Entrypoint for interacting with the API client.
RequestBuilder
A request builder.