pub struct Client { /* private fields */ }Expand description
Entrypoint for interacting with the API client.
Implementations§
Source§impl Client
impl Client
Sourcepub fn new_from_reqwest<T>(
token: T,
builder_http: ClientBuilder,
builder_websocket: ClientBuilder,
) -> Self
pub fn new_from_reqwest<T>( token: T, builder_http: ClientBuilder, builder_websocket: ClientBuilder, ) -> Self
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.
Sourcepub fn new<T>(token: T) -> Self
pub fn new<T>(token: T) -> Self
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.
Sourcepub fn set_base_url<H>(&mut self, base_url: H)
pub fn set_base_url<H>(&mut self, base_url: H)
Set the base URL for the client to something other than the default: https://rest.ripplingapis.com.
Sourcepub fn new_from_env() -> Self
pub fn new_from_env() -> Self
Create a new Client struct from the environment variable: ENV_VARIABLE_PREFIX_API_TOKEN.
Sourcepub async fn request_raw(
&self,
method: Method,
uri: &str,
body: Option<Body>,
) -> Result<RequestBuilder>
pub async fn request_raw( &self, method: Method, uri: &str, body: Option<Body>, ) -> Result<RequestBuilder>
Create a raw request to our API.
Sourcepub fn candidate_applications(&self) -> CandidateApplications
pub fn candidate_applications(&self) -> CandidateApplications
An application by a candidate to a specific job requisition.
Sourcepub fn candidates(&self) -> Candidates
pub fn candidates(&self) -> Candidates
Someone who applies to a job requisition opened by the company.
Sourcepub fn compensations(&self) -> Compensations
pub fn compensations(&self) -> Compensations
Compensation associated with workers.
Sourcepub fn custom_fields(&self) -> CustomFields
pub fn custom_fields(&self) -> CustomFields
Custom fields defined by the company.
Sourcepub fn custom_object_fields(&self) -> CustomObjectFields
pub fn custom_object_fields(&self) -> CustomObjectFields
Custom object fields defined by the company.
Sourcepub fn custom_object_records(&self) -> CustomObjectRecords
pub fn custom_object_records(&self) -> CustomObjectRecords
Custom object datarows defined by the company.
Sourcepub fn custom_objects(&self) -> CustomObjects
pub fn custom_objects(&self) -> CustomObjects
Custom objects defined by the company.
Sourcepub fn departments(&self) -> Departments
pub fn departments(&self) -> Departments
Departments used by the company.
Sourcepub fn employment_types(&self) -> EmploymentTypes
pub fn employment_types(&self) -> EmploymentTypes
Employment types used by the company.
Sourcepub fn entitlements(&self) -> Entitlements
pub fn entitlements(&self) -> Entitlements
Availability of API features to the company or Partners.
Sourcepub fn job_requisitions(&self) -> JobRequisitions
pub fn job_requisitions(&self) -> JobRequisitions
A request for a job to be filled by a candidate.
Sourcepub fn leave_balances(&self) -> LeaveBalances
pub fn leave_balances(&self) -> LeaveBalances
Leave balances for workers.
Sourcepub fn leave_requests(&self) -> LeaveRequests
pub fn leave_requests(&self) -> LeaveRequests
Leave requests submitted by workers.
Sourcepub fn leave_types(&self) -> LeaveTypes
pub fn leave_types(&self) -> LeaveTypes
Leave types used by the company.
Sourcepub fn legal_entities(&self) -> LegalEntities
pub fn legal_entities(&self) -> LegalEntities
Legal entities registered by the company.
Sourcepub fn object_categories(&self) -> ObjectCategories
pub fn object_categories(&self) -> ObjectCategories
Object Categories defined by the company.
Sourcepub fn shift_inputs(&self) -> ShiftInputs
pub fn shift_inputs(&self) -> ShiftInputs
Shift inputs used by the company.
Sourcepub fn time_entries(&self) -> TimeEntries
pub fn time_entries(&self) -> TimeEntries
Time entries submitted by workers.
Sourcepub fn tracks_and_levels(&self) -> TracksAndLevels
pub fn tracks_and_levels(&self) -> TracksAndLevels
Levels and tracks used by the company for workers.
Sourcepub fn work_locations(&self) -> WorkLocations
pub fn work_locations(&self) -> WorkLocations
Work locations used by the company.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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