Struct rippling_api::Client

source ·

pub struct Client { /* private fields */ }

Expand description

Entrypoint for interacting with the API client.

Implementations§

source §

impl Client

source

pub fn new_from_reqwest<T>( token: T, builder_http: ClientBuilder, builder_websocket: ClientBuilder, ) -> Self
where T: ToString + Debug,

Create a new Client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work. Also takes reqwest client builders, for customizing the client’s behaviour.

source

pub fn new<T>(token: T) -> Self
where T: ToString + Debug,

Create a new Client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work.

source

pub fn set_base_url<H>(&mut self, base_url: H)
where H: Into<String> + Display + Debug,

Set the base URL for the client to something other than the default: https://rest.ripplingapis.com.

source

pub fn new_from_env() -> Self

Create a new Client struct from the environment variable: RIPPLING_API_TOKEN.

source

pub async fn request_raw( &self, method: Method, uri: &str, body: Option<Body>, ) -> Result<RequestBuilder>

Create a raw request to our API.

source

pub fn companies(&self) -> Companies

Companies on Rippling.

source

pub fn custom_fields(&self) -> CustomFields

Custom fields defined by the company.

source

pub fn custom_object_fields(&self) -> CustomObjectFields

Custom object fields defined by the company.

source

pub fn custom_object_records(&self) -> CustomObjectRecords

Custom object datarows defined by the company.

source

pub fn custom_objects(&self) -> CustomObjects

Custom objects defined by the company.

source

pub fn departments(&self) -> Departments

Departments used by the company.

source

pub fn employment_types(&self) -> EmploymentTypes

Employment types used by the company.

source

pub fn entitlements(&self) -> Entitlements

Availability of API features to the company or Partners.

source

pub fn me(&self) -> Me

Provides the user’s SSO information.

source

pub fn object_categories(&self) -> ObjectCategories

Object Categories defined by the company.

source

pub fn teams(&self) -> Teams

Teams at the company.

source

pub fn users(&self) -> Users

Users of the company.

source

pub fn work_locations(&self) -> WorkLocations

Work locations used by the company.

source

pub fn workers(&self) -> Workers

Workers who work or have worked at the company.

Trait Implementations§

source §

impl Clone for Client

source §

fn clone(&self) -> Client

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source §

impl Debug for Client

source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for Client

Blanket Implementations§

source §

impl<T> Any for T
where T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Borrow<T> for T
where T: ?Sized,

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source §

impl<T> CloneToUninit for T
where T: Clone,

source §

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

source §

impl<T> DynClone for T
where T: Clone,

source §

fn __clone_box(&self, _: Private) -> *mut ()

source §

impl<T> From<T> for T

source §

fn from(t: T) -> T

Returns the argument unchanged.

source §

impl<T> FutureExt for T

source §

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

source §

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

source §

impl<T> Instrument for T

source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into for T
where U: From<T>,

source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source §

impl<T> IntoEither for T

source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

source §