Expand description
This module contains the generated types for the library.
Modules§
- base64
- Base64 data that encodes to url safe base64, but can decode from multiple base64 implementations to account for various clients and libraries. Compatible with serde and JsonSchema.
- error
- Error methods.
- multipart
- Multipart form data types.
- paginate
- Utility functions used for pagination.
- phone_
number - A library to implement phone numbers for our database and JSON serialization and deserialization.
Structs§
- Address
- An address object as stored within Rippling.
- AppHandle
Id - Attachments
- An array of json objects containing file names and public file URLs containing documents pertaining to the candidate.
- Authenticated
User Me - Information about the Rippling user whose token is being used to access Rippling’s API.
- Ca
- Candidate
- The Rippling candidate model.
- Company
- A company object as represented within Rippling.
- Company
Leave Type - Company leave request object
- Custom
Field - CustomField.
- Custom
Fields - A Custom Fields object within Rippling.
- Data
- Dates
- Department
- A company department object.
- Employee
- An employee model object.
- Entities
- This model represents the legal entities inside of a given company. Legal entities based in Canada (CA) are currently supported at this time.
- Entity
Info - Event
- The event model for company activity.
- Event
Reason - Reason for the event, tied to the type of eveent.
- GetApp
AppMatching Users Response - GetCompany
Activity Response - GetLeave
Balance Response - GetLeave
Balances Response - Group
- Group
Update Payload - This payload should be used when updating existing groups.
- Initiator
- The actor of the event.
- Leave
Balances - Leave balances object
- Leave
Request - Leave request object.
- Level
- Levels enable for self-defined,company-wide position levels, such as Manager, Engineering Manager, Executive, etc.
- Partial
Days - Patch
Leave Requests Leave Request IdRequest Body - Post
Groups Request Body - Post
Leave Requests Request Body - Post
Mark AppInstalled Response - PostMarkAppInstalledResponse.
- Request
Data - Geographic details from where the event was recorded.
- Results
- SteLocation
Code - Subjects
- Team
- A team is a self-defined group of employees within Rippling.
- Work
Location - A work location object.
Enums§
- Action
- Candidate
Employment Type - The ENUM type of employment the user will have within Rippling.
- Employment
Type - An ENUM of employment type
- Event
Type - An ENUM value for the type of the event.
- Gender
- The employee’s gender
- Identified
Gender - The employee’s identified gender
- Initiator
Type - ENUM value for the type of actor.
- Leave
Type Unique Id - Managed
By - This indicates the system that manages the Leave Request. PTO = managed by Rippling’s Time Off app. LEAVES = managed by Rippling’s Leave Management app. TILT = managed by third-party partner Tilt.
- Role
State - The employee’s role status - roleState meanings:
- Salary
Unit - An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.
- Status
- Subjects
Type - An ENUM value for the type of object.
- Type
- Denotes the type of the custom field.