beetlehr_sdk library

Classes

ApprovalRequestDetailDataModel

The ApprovalRequestDetailDataModel class represents the detailed data of an approval request.

ApprovalRequestDetailResponseModel

The ApprovalRequestDetailResponseModel class represents the response of an approval request detail.

ApprovalRequestModel

The ApprovalRequestModel class represents an approval request.

ApprovalRequestResponseModel

The ApprovalRequestResponseModel class represents the response model for approval requests.

ApproverRequestBodyModel

Represents the request body data for approving a request.

ApproverRequestResponseModel

ApproverResponseModel

ApproversModel

The ApproversModel class represents an approver of an approval request.

AttendanceCheckBranchRequestModel

Model class representing the request for checking the Branch of the office.

AttendanceCheckBranchResponseModel

Model class representing the response for checking the Branch of the office.

AttendanceDetailModel

The AttendanceDetailModel class represents a model for attendance details.

AttendanceDetailResponseModel

The AttendanceDetailResponseModel class represents a response model for attendance details.

AttendanceImageModel

Model class for attendance images.

AttendanceImageRequestModel

Model class for attendance image requests.

AttendanceImageResponseModel

Model class for attendance image responses.

AttendanceLogResponseModel

Model class representing the response of attendance logs.

AttendanceModel

Model class representing attendance data.

AttendanceOfficeBranchModel

Model class representing the attendance office Branch.

AttendanceOfflineEntity

The AttendanceOfflineEntity class represents an entity for offline attendance data.

AttendanceOverviewDataModel

Model class for attendance overview data.

AttendanceOverviewModel

Model class for attendance overview.

AttendanceResponseModel

Model representing the response data for attendance.

AuthHttpInterceptor

Error handling when error in interceptor about authentication

AuthResponseModel

The AuthResponseModel class represents a model for the authentication response.

BeetleHRClient

The BeetleHRClient class is responsible for handling HTTP requests to the Beetle HR API.

BreakTimeBodyModel

Represents a model for break time information.

BreakTimeModel

Represents a model for break time information.

BreakTimeResponseModel

Represents a response model for break time information.

CheckAcceptClockBodyModel

The CheckAcceptClockBodyModel class represents a model for the request body used to check and accept clock entries.

CheckServerModel

The CheckServerModel class represents a model for checking server information.

ClockAcceptModel

The ClockAcceptModel class represents a model for clock acceptance.

ClockAcceptResponseModel

The ClockAcceptResponseModel class represents a response model for clock acceptance.

ClockBodyModel

The ClockBodyModel class represents a model for clocking in/out data.

ClockButtonModel

The ClockButtonModel class represents a model for the clock button configuration.

EmployeeNameFilterModel

The EmployeeNameFilterModel class represents an employee filtered by name.

EmployeeNameFilterResponseModel

The EmployeeNameFilterResponseModel class represents a response model for employee name filtering.

ErrorMetaData

Base meta data error when receive data from a API

MetaData

Base meta when receive data from a API

MetaDataApprovalModel

The MetaDataApprovalModel class represents metadata associated with an approval request.

NetworkFileModel

Represents a model for network file information.

NoticeBoardResponseModel

The NoticeBoardResponseModel class represents a response model for the notice board data.

NoticeModel

The NoticeModel class represents a notice item.

NotificationDetailModel

The NotificationDetailModel class represents the details of a notification.

NotificationDetailResponseModel

The NotificationDetailResponseModel class represents a response model for notification details.

NotificationModel

The NotificationModel class represents a notification model.

NotificationResponseModel

The NotificationResponseModel class represents a response model for notifications.

Pagination

Base model pagination

PayrollComponentModel

The PayrollComponentModel class represents a model for a payroll component.

PayrollDetailModel

PayrollDetailResponse

PayrollModel

PayrollResponseModel

PayrollStatusConverter

A utility class for converting PayrollStatus values to and from strings.

ProfileBodyModel

The ProfileBodyModel class represents a model for the body of a user profile request.

ProfileModel

The ProfileModel class represents a model for a user profile.

ProfileResponseModel

The ProfileResponseModel class represents a model for a response containing user profile data.

ScheduleModel

The ScheduleModel class represents a model for a schedule.

ScheduleResponseModel

The ScheduleResponseModel class represents a model for a schedule response.

TrackerConfigModel

The TrackerConfigModel class represents a model for tracker configuration.

UploadFilesResponseModel

Represents a response model for uploading files.

UserModel

The UserModel class represents a model for a user.

Enums

ApprovalRequestType

Enum representing the types of approval requests.

AttendanceClockType

Enum that represents the types of attendance clock.

AttendanceLogType

AttendanceType

BaseUrlSchema

The BaseUrlSchema enum represents the schema of a base URL.

BreakTimeType

BreakType

The break type for clock operations.

ClockButtonType

The button type for clock operations.

ClockMessageType

The message type for clock operations.

PayrollStatus

Enum representing the status of a payroll.

WorkingFromType

Enum that represents the types of working from.

Extensions

ApprovalRequestTypeX on ApprovalRequestType

Extension providing additional functionality for the ApprovalRequestType enum.

AttendanceClockTypeX on AttendanceClockType

Extension on AttendanceClockType to convert it to a string.

AttendanceLogTypeX on AttendanceLogType

AttendanceTypeX on AttendanceType

BaseUrlSchemaX on BaseUrlSchema

Extension methods for the BaseUrlSchema enum.

BreakTimeTypeX on BreakTimeType

BreakTypeX on BreakType

CheckServerModelX on ServerEntity

The CheckServerModelX extension provides JSON serialization capabilities for ServerEntity.

ClockButtonTypeX on ClockButtonType

ClockMessageTypeX on ClockMessageType

DioErrorExtension on DioError

The DioErrorExtension extension provides a convenient method to convert DioError instances to ServerException.

FilesExtensions on List<File>

UserModelX on UserEntity

The UserModelX extension provides JSON serialization capabilities for UserEntity.

WorkFromTypeX on WorkingFromType

Extension on WorkingFromType to convert it to a string.

Functions

approvalRequestTypefromString(String? type) → ApprovalRequestType?

Converts a string representation of an approval request type to the corresponding enum value.

attendanceClockTypeFromString(String? type) → AttendanceClockType?

Converts a string to an AttendanceClockType enum value.

attendanceLogTypeFromString(String type) → AttendanceLogType?

Converts a string type to the corresponding AttendanceLogType enum value.

attendanceTypeFromString(String? type) → AttendanceType?

Converts a string type to the corresponding AttendanceType enum value.

breakTimeTypefromString(String? type) → BreakTimeType?

Converts a string type to the corresponding BreakTimeType enum value. Returns BreakTimeType.start if type is 'start', BreakTimeType.end if type is 'end', and null otherwise.

breakTypeFromString(String type) → BreakType

Converts the provided type string to a BreakType.

clockButtonTypeFromString(String type) → ClockButtonType

Converts the provided type string to a ClockButtonType.

clockMessageTypeFromString(String type) → ClockMessageType

Converts the provided type string to a ClockMessageType.

durationTimeParse(String? time) → Duration?

Parses a time string and returns a Duration object.

workingFromTypeFromString(String? type) → WorkingFromType?

Converts a string to a WorkingFromType enum value.

Exceptions / Errors

DefaultApiException

Handling error base from basic error from response API, for example Bad request,

ErrorCodeException

The ErrorCodeException class represents an exception with an error code.

GeneralServerException

The GeneralServerException class represents a general server exception.

InternalServerException

The InternalServerException class represents a server internal error exception.

NotFoundServerException

The NotFoundServerException class represents a server not found exception.

ServerException

The ServerException class is an abstract class that represents a server-related exception.

TimeOutServerException

The TimeOutServerException class represents a server timeout exception.

UnAuthenticationServerException

The UnAuthenticationServerException class represents a server unauthenticated exception.

UnAuthorizeServerException

The UnAuthorizeServerException class represents a server unauthorized exception.