Module rippling_api::types

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
• AddressRequest
• Application
• ApplicationRequest
• Break
• BreakRequest
• BreakType
• BreakTypeRequest
• Candidate
• CandidateRequest
• Company
• CompanyEmploymentType
• CompanyEmploymentTypeRequest
• CompanyRequest
• Compensation
• CompensationRequest
• Country
• CountryRequest
• Currency
• CurrencyRequest
• CustomField
• CustomFieldRequest
• DayOff
• DayOffRequest
• Department
• DepartmentRequest
• Email
• EmailRequest
• EntitlementModel
• EntitlementModelRequest
• GetDepartmentsResponse
• GetEmploymentTypesResponse
• GetTeamsResponse
• GetUsersResponse
• GetWorkLocationsResponse
• GetWorkersResponse
• JobCode
• JobCodeRequest
• JobCodeSummary
• JobCodeSummaryRequest
• JobDimension
• JobDimensionRequest
• JobRequisition
• JobRequisitionRequest
• JobShift
• JobShiftRequest
• LeaveRequest
• LeaveRequestRequest
• LegalEntity
• LegalEntityRequest
• Level
• LevelRequest
• ListCompaniesResponse
• ListCustomFieldsResponse
• ListDepartmentsResponse
• ListEmploymentTypesResponse
• ListEntitlementsResponse
• ListTeamsResponse
• ListUsersResponse
• ListWorkLocationsResponse
• ListWorkersResponse
• Meta
• MetaResponse
  Meta information for the response.
• PayPeriod
• PayPeriodRequest
• RedactedField
  Info about the redacted fields.
• RedactedFields
  A list of redacted fields.
• RedactedFieldsRedactedFields
• ShiftInput
• ShiftInputRequest
• ShiftInputValue
• ShiftInputValueRequest
• Ssome
• SsomeRequest
• Team
• TeamRequest
• TerminationDetails
• TerminationDetailsRequest
• TimeCard
• TimeCardRequest
• TimeCardSummary
• TimeCardSummaryRequest
• TimeEntry
• TimeEntryComment
• TimeEntryCommentRequest
• TimeEntryRequest
• TimeEntrySummary
  DTO used to store the summary of a TimeEntry
• TimeEntrySummaryRequest
  DTO used to store the summary of a TimeEntry
• Track
• TrackRequest
• User
• UserAddress
• UserAddressRequest
• UserName
• UserNameRequest
• UserPhoneNumber
• UserPhoneNumberRequest
• UserPhoto
• UserPhotoRequest
• UserRequest
• WorkLocation
• WorkLocationRequest
• Worker
• WorkerLocation
• WorkerLocationRequest
• WorkerRequest

Enums

• AddressCountry
  The country component, pursuant to SCIM RFC 7643 4.1.2.
• AddressRequestCountry
  The country component, pursuant to SCIM RFC 7643 4.1.2.
• AddressRequestType
  The classification of the address.
• AddressType
  The classification of the address.
• AmountWorked
  The amount worked for the employment type. * FULL-TIME: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * PART-TIME: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * TEMPORARY: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.
• ApplicationRequestStatus
  Application status
• ApplicationStatus
  Application status
• Citizenship
  The countries that the worker has citizenship in.
• Code
  The code of the country.
• CompanyEmploymentTypeRequestType
  The classification of the worker by the company. * CONTRACTOR: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * EMPLOYEE: Employees are hired and managed by an employer, work under the employer’s direct supervision and control, and are protected by law for wages and employment rights.
• CompanyEmploymentTypeType
  The classification of the worker by the company. * CONTRACTOR: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * EMPLOYEE: Employees are hired and managed by an employer, work under the employer’s direct supervision and control, and are protected by law for wages and employment rights.
• CompensationTimePeriod
  The compensation period for the employment type. * SALARIED: Employees that are paid a fixed amount per year. * HOURLY: Employees that are paid a wage per hour worked.
• CustomFieldRequestType
  The data type of the custom field.
• CustomFieldType
  The data type of the custom field.
• EmailRequestType
  The classification of the email.
• EmailType
  The classification of the email.
• EntityLevel
  The legal entity’s level in a hierarchy. * PARENT: The legal entity is considered the ultimate holding entity. * SUBSIDIARY: The legal entity is considered a subsidiary, fully or partially held by another. * BRANCH: The legal entity is considered a branch, associated with a parent legal entity.
• Ethnicity
  The identified ethnicity of the worker, if specified.
• Gender
  The gender of the worker, if specified.
• GetEmploymentTypesResponseType
  The classification of the worker by the company. * CONTRACTOR: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * EMPLOYEE: Employees are hired and managed by an employer, work under the employer’s direct supervision and control, and are protected by law for wages and employment rights.
• GetWorkersResponseCountry
  The worker’s country.
• GetWorkersResponseStatus
  The worker’s status within the organization.
• JobRequisitionRequestStatus
  Job requisition status
• JobRequisitionStatus
  Job requisition status
• ManagementType
  The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * PEO: The legal entity is considered a Professional Employment Organization (PEO). * EOR: The legal entity is considered an Employer of Record (EOR).
• Race
  The identified race of the worker, if specified.
• Status
  The status of the leave request.
• TimeEntryRequestStatus
  The status of the time entry.
• TimeEntryStatus
  The status of the time entry.
• Type
  The termination type indicates whether the termination was voluntary or involuntary.
• UserAddressCountry
  The country component, pursuant to SCIM RFC 7643 4.1.2.
• UserAddressRequestCountry
  The country component, pursuant to SCIM RFC 7643 4.1.2.
• UserAddressRequestType
  The classification of the address.
• UserAddressType
  The classification of the address.
• UserPhoneNumberRequestType
  The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.
• UserPhoneNumberType
  The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.
• UserPhotoRequestType
  The classification of the photo.
• UserPhotoType
  The classification of the photo.
• WorkerCountry
  The worker’s country.
• WorkerLocationRequestType
  The type of location.
• WorkerLocationType
  The type of location.
• WorkerRequestCountry
  The worker’s country.
• WorkerRequestStatus
  The worker’s status within the organization.
• WorkerStatus
  The worker’s status within the organization.