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
- Address.
- Application
- Application.
- Break
- Break.
- Break
Request - BreakRequest.
- Bulk
Create Custom Objects Custom Object ApiName Records Request Body - Bulk
Create Custom Objects Custom Object ApiName Records Response - Bulk
Delete Custom Objects Custom Object ApiName Records Request Body - Bulk
Update Custom Objects Custom Object ApiName Records Request Body - Bulk
Update Custom Objects Custom Object ApiName Records Response - Candidate
- Candidate.
- Company
- Company.
- Company
Employment Type - CompanyEmploymentType.
- Compensation
- Compensation.
- Country
- Country.
- Create
Custom Objects Custom Object ApiName Fields Request Body - Create
Custom Objects Custom Object ApiName Records Request Body - Create
Custom Objects Custom Object ApiName Records Response - Create
Custom Objects Request Body - Create
Object Categories Request Body - Currency
- Currency.
- Custom
Field - CustomField.
- Custom
Object - CustomObject.
- Custom
Object Data Row - CustomObjectDataRow.
- Custom
Object Field - CustomObjectField.
- DayOff
- DayOff.
- Department
- Department.
- Email.
- Entitlement
Model - EntitlementModel.
- GetCompensations
Response - GetCustom
Objects Custom Object ApiName Records ByExternal IdResponse - GetCustom
Objects Custom Object ApiName Records Response - GetDepartments
Response - GetEmployment
Types Response - GetJob
Codes Response - GetJob
Dimensions Response - GetLeave
Balances Response - GetLeave
Requests Response - GetLeave
Types Response - GetLegal
Entities Response - GetLevels
Response - GetShift
Inputs Response - GetTeams
Response - GetTime
Cards Response - GetTime
Entries Response - GetTracks
Response - GetUsers
Response - GetWork
Locations Response - JobCode
- JobCode.
- JobCode
Request - JobCodeRequest.
- JobCode
Summary - JobCodeSummary.
- JobDimension
- JobDimension.
- JobDimension
Request - JobDimensionRequest.
- JobRequisition
- JobRequisition.
- JobShift
- JobShift.
- JobShift
Request - JobShiftRequest.
- Leave
Balance - LeaveBalance.
- Leave
Request - LeaveRequest.
- Leave
Request Request - LeaveRequestRequest.
- Leave
Type - LeaveType.
- Legal
Entity - LegalEntity.
- Level
- Level.
- List
ByQuery Custom Objects Custom Object ApiName Records Request Body - List
ByQuery Custom Objects Custom Object ApiName Records Response - List
Candidate Applications Response - List
Candidates Response - List
Companies Response - List
Compensations Response - List
Custom Fields Response - List
Custom Objects Custom Object ApiName Fields Response - List
Custom Objects Custom Object ApiName Records Response - List
Custom Objects Response - List
Departments Response - List
Employment Types Response - List
Entitlements Response - List
JobCodes Response - List
JobDimensions Response - List
JobRequisitions Response - List
Leave Balances Response - List
Leave Requests Response - List
Leave Types Response - List
Legal Entities Response - List
Levels Response - List
Object Categories Response - List
Shift Inputs Response - List
Teams Response - List
Time Cards Response - List
Time Entries Response - List
Tracks Response - List
Users Response - List
Work Locations Response - List
Workers Response - Meta
- Meta
Response - Meta information for the response.
- Object
Category - ObjectCategory.
- PayPeriod
- PayPeriod.
- PayPeriod
Request - PayPeriodRequest.
- Piece
Rate Premiums - PieceRatePremiums.
- Premiums
- Premiums.
- Prototype
- Prototype.
- Prototype
Job - PrototypeJob.
- Prototype
Work Location - PrototypeWorkLocation.
- Redacted
Field - Info about the redacted fields.
- Redacted
Fields - A list of redacted fields.
- Redacted
Fields Redacted Fields - Results
- Rows
ToUpdate - Rows
ToWrite - Segments
- Segments.
- Shift
Input - ShiftInput.
- Shift
Input Request - ShiftInputRequest.
- Shift
Input Value - ShiftInputValue.
- Shift
Input Value Request - ShiftInputValueRequest.
- Ssome
- Ssome.
- Team
- Team.
- Termination
Details - TerminationDetails.
- Time
Card - TimeCard.
- Time
Card Summary - TimeCardSummary.
- Time
Entry - TimeEntry.
- Time
Entry Comment - TimeEntryComment.
- Time
Entry Comment Request - TimeEntryCommentRequest.
- Time
Entry Request - TimeEntryRequest.
- Time
Entry Summary - DTO used to store the summary of a TimeEntry
- Track
- Track.
- Update
Custom Objects Custom Object ApiName Fields Request Body - Update
Custom Objects Custom Object ApiName Records Request Body - Update
Custom Objects Custom Object ApiName Records Response - Update
Custom Objects Request Body - Update
Object Categories Request Body - User
- User.
- User
Address - UserAddress.
- User
Name - UserName.
- User
Phone Number - UserPhoneNumber.
- User
Photo - UserPhoto.
- Work
Location - WorkLocation.
- Worker
- Worker.
- Worker
Location - WorkerLocation.
Enums§
- Address
Country - The country component, pursuant to SCIM RFC 7643 4.1.2.
- Amount
Worked - 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. - Citizenship
- The countries that the worker has citizenship in.
- Code
- The code of the country.
- Company
Employment Type Type - 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. - Compensation
Time Period - 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. - Custom
Field Type - The data type of the custom field.
- Email
Type - The classification of the email.
- Entity
Level - 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.
- GetEmployment
Types Response Type - 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. - GetLeave
Requests Response Status - The status of the leave request.
- GetTime
Entries Response Status - The status of the time entry.
- JobRequisition
Status - Job requisition status
- Leave
Request Request Status - The status of the leave request.
- Leave
Request Status - The status of the leave request.
- Management
Type - 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
- Application status
- Termination
Details Type - The termination type indicates whether the termination was voluntary or involuntary.
- Time
Entry Request Status - The status of the time entry.
- Time
Entry Status - The status of the time entry.
- Type
- The classification of the address.
- User
Address Country - The country component, pursuant to SCIM RFC 7643 4.1.2.
- User
Phone Number Type - The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.
- User
Photo Type - The classification of the photo.
- Worker
Country - The worker’s country.
- Worker
Location Type - The type of location.
- Worker
Status - The worker’s status within the organization.