Crate rippling_api

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

API Details

Documentation for the Rippling Platform API.

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]
rippling-api = "0.1.4"

Basic example

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

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

• RIPPLING_API_TOKEN

And then you can create a client from the environment.

use rippling_api::Client;

let client = Client::new_from_env();

Modules

• companies
  Companies on Rippling.
• custom_fields
  Custom fields defined by the company.
• custom_object_fields
  Custom object fields defined by the company.
• custom_object_records
  Custom object datarows defined by the company.
• custom_objects
  Custom objects defined by the company.
• departments
  Departments used by the company.
• employment_types
  Employment types used by the company.
• entitlements
  Availability of API features to the company or Partners.
• me
  Provides the user’s SSO information.
• object_categories
  Object Categories defined by the company.
• teams
  Teams at the company.
• types
  This module contains the generated types for the library.
• users
  Users of the company.
• utils
• work_locations
  Work locations used by the company.
• workers
  Workers who work or have worked at the company.

Structs

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